Package net.officefloor.web.security.scheme

Class FormHttpSecuritySource

java.lang.Object

net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>

net.officefloor.web.security.scheme.FormHttpSecuritySource

All Implemented Interfaces:

HttpSecuritySource<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>

public class FormHttpSecuritySource
extends AbstractHttpSecuritySource<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>

Form based HttpSecuritySource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormHttpSecuritySource.Dependencies	Dependency keys.
static class	FormHttpSecuritySource.Flows	Flow keys.

Nested classes/interfaces inherited from class net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource

AbstractHttpSecuritySource.DependencyLabeller, AbstractHttpSecuritySource.Labeller, AbstractHttpSecuritySource.MetaDataContext<A,AC extends java.io.Serializable,C,O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>, AbstractHttpSecuritySource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_REALM	Name of Property to retrieve the realm being secured.

Fields inherited from class net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource

UTF_8

Constructor Summary

Constructors

Constructor	Description
FormHttpSecuritySource()

Method Summary

Modifier and Type	Method	Description
protected HttpAccessControl	authenticate(java.lang.String userId, java.lang.String realm, byte[] password, CredentialStore store)	Undertakes the authentication.
protected void	loadMetaData(AbstractHttpSecuritySource.MetaDataContext<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)	Overridden to load specifications.
HttpSecurity<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>	sourceHttpSecurity(HttpSecurityContext context)	Sources the HttpSecurity.

Methods inherited from class net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_REALM

public static final java.lang.String PROPERTY_REALM

Name of Property to retrieve the realm being secured.

See Also:

Constant Field Values

Constructor Detail

FormHttpSecuritySource

public FormHttpSecuritySource()

Method Detail

authenticate

protected HttpAccessControl authenticate(java.lang.String userId,
                                         java.lang.String realm,
                                         byte[] password,
                                         CredentialStore store)
                                  throws HttpException

Undertakes the authentication.

This is separated out so that may be overridden to provide differing means for authentication.

Parameters:

userId - Identifier for the user.

realm - Security realm.

password - Password.

store - CredentialStore.

Returns:

HttpAccessControl or null if not authenticated.

Throws:

HttpException - If fails communication with the CredentialStore.

loadSpecification

protected void loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)

Description copied from class: AbstractHttpSecuritySource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractHttpSecuritySource<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractHttpSecuritySource.MetaDataContext<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows> context)
                     throws java.lang.Exception

Description copied from class: AbstractHttpSecuritySource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractHttpSecuritySource<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows>

Parameters:

context - Meta-data.

Throws:

java.lang.Exception - If fails to load the meta-data.

sourceHttpSecurity

public HttpSecurity<HttpAuthentication<HttpCredentials>,HttpAccessControl,HttpCredentials,FormHttpSecuritySource.Dependencies,FormHttpSecuritySource.Flows> sourceHttpSecurity(HttpSecurityContext context)
                                                                                                                                                                                                throws HttpException

Description copied from interface: HttpSecuritySource

Sources the HttpSecurity.

Parameters:

context - HttpSecurity.

Returns:

HttpSecurity.

Throws:

HttpException - If fails to source the HttpSecurity.