Package net.officefloor.web.security.scheme

Class BasicHttpSecuritySource

java.lang.Object

net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>

net.officefloor.web.security.scheme.BasicHttpSecuritySource

All Implemented Interfaces:

HttpSecuritySource<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>

public class BasicHttpSecuritySource
extends AbstractHttpSecuritySource<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>

HttpSecuritySource for Basic HTTP security.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicHttpSecuritySource.BasicCredentials	Decoded credentials.
static enum	BasicHttpSecuritySource.Dependencies	Dependency keys.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHENTICATION_SCHEME_BASIC	Authentication scheme Basic.
static final 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
BasicHttpSecuritySource()

Method Summary

Modifier and Type	Method	Description
static String	createAuthorizationHttpHeaderValue(String username, String password)	Creates the Authorization HttpHeader value.
static BasicHttpSecuritySource.BasicCredentials	getBasicCredentials(String basicParameters)	Obtains the BasicHttpSecuritySource.BasicCredentials from the basic parameters.
static BasicHttpSecuritySource.BasicCredentials	getBasicCredentials(HttpRequest request)	Obtains the BasicHttpSecuritySource.BasicCredentials from the HttpRequest.
protected void	loadMetaData(AbstractHttpSecuritySource.MetaDataContext<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)	Overridden to load specifications.
HttpSecurity<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>	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 Details

AUTHENTICATION_SCHEME_BASIC

public static final String AUTHENTICATION_SCHEME_BASIC

Authentication scheme Basic.

See Also:

• Constant Field Values

PROPERTY_REALM

public static final String PROPERTY_REALM

Name of property to retrieve the realm being secured.

See Also:

• Constant Field Values

Constructor Details

BasicHttpSecuritySource

public BasicHttpSecuritySource()

Method Details

createAuthorizationHttpHeaderValue

public static String createAuthorizationHttpHeaderValue(String username,
 String password)

Creates the Authorization HttpHeader value.

Parameters:

username - Username.

password - Password.

Returns:

Authorization HttpHeader value.

getBasicCredentials

public static BasicHttpSecuritySource.BasicCredentials getBasicCredentials(HttpRequest request)

Obtains the BasicHttpSecuritySource.BasicCredentials from the HttpRequest.

Parameters:

request - HttpRequest.

Returns:

BasicHttpSecuritySource.BasicCredentials or null if not available.

getBasicCredentials

public static BasicHttpSecuritySource.BasicCredentials getBasicCredentials(String basicParameters)

Obtains the BasicHttpSecuritySource.BasicCredentials from the basic parameters.

Parameters:

basicParameters - basic parameters.

Returns:

BasicHttpSecuritySource.BasicCredentials.

loadSpecification

protected void loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)

Description copied from class: AbstractHttpSecuritySource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractHttpSecuritySource<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractHttpSecuritySource.MetaDataContext<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None> context)
                     throws Exception

Description copied from class: AbstractHttpSecuritySource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractHttpSecuritySource<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

sourceHttpSecurity

public HttpSecurity<HttpAuthentication<Void>,HttpAccessControl,Void,BasicHttpSecuritySource.Dependencies,None> 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.