Package net.officefloor.web.spi.security.impl

Class AbstractHttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>

java.lang.Object

net.officefloor.web.spi.security.impl.AbstractHttpSecuritySource<A,AC,C,O,F>

All Implemented Interfaces:

HttpSecuritySource<A,AC,C,O,F>

Direct Known Subclasses:

AbstractMockHttpSecuritySource, AnonymousHttpSecuritySource, BasicHttpSecuritySource, DigestHttpSecuritySource, FormHttpSecuritySource, JwtHttpSecuritySource, MockChallengeHttpSecuritySource, MockFlowHttpSecuritySource

public abstract class AbstractHttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>
extends Object
implements HttpSecuritySource<A,AC,C,O,F>

Abstract HttpSecuritySource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractHttpSecuritySource.DependencyLabeller	Provide AbstractHttpSecuritySource.Labeller functionality along with qualifying type of dependency.
static interface	AbstractHttpSecuritySource.Labeller	Provides the ability to label the required dependency or Flow.
static interface	AbstractHttpSecuritySource.MetaDataContext<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>	Context for the HttpSecuritySource.init(HttpSecuritySourceContext).
static interface	AbstractHttpSecuritySource.SpecificationContext	Context for the HttpSecuritySource.getSpecification().

Field Summary

Fields

Modifier and Type	Field	Description
static final Charset	UTF_8	UTF-8 Charset.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpSecuritySource()

Method Summary

Modifier and Type	Method	Description
HttpSecuritySourceSpecification	getSpecification()	Obtains the specification for this.
HttpSecuritySourceMetaData<A,AC,C,O,F>	init(HttpSecuritySourceContext context)	Initialises the HttpSecuritySource.
protected abstract void	loadMetaData(AbstractHttpSecuritySource.MetaDataContext<A,AC,C,O,F> context)	Overridden to load meta-data.
protected abstract void	loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)	Overridden to load specifications.
void	start(HttpSecurityExecuteContext<F> context)	Called once after HttpSecuritySource.init(HttpSecuritySourceContext) to indicate this HttpSecuritySource should start execution.
void	stop()	Called to notify that the OfficeFloor is being closed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.web.spi.security.HttpSecuritySource

sourceHttpSecurity

Field Details

UTF_8

public static final Charset UTF_8

UTF-8 Charset.

Constructor Details

AbstractHttpSecuritySource

public AbstractHttpSecuritySource()

Method Details

getSpecification

public HttpSecuritySourceSpecification getSpecification()

Description copied from interface: HttpSecuritySource

Obtains the specification for this.

This will be called before any other methods, therefore this method must be able to return the specification immediately after a default constructor instantiation.

Specified by:

getSpecification in interface HttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>

Returns:

Specification of this.

loadSpecification

protected abstract void loadSpecification(AbstractHttpSecuritySource.SpecificationContext context)

Overridden to load specifications.

Parameters:

context - Specifications.

init

public HttpSecuritySourceMetaData<A,AC,C,O,F> init(HttpSecuritySourceContext context)
                                            throws Exception

Description copied from interface: HttpSecuritySource

Initialises the HttpSecuritySource.

Specified by:

init in interface HttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>

Parameters:

context - HttpSecuritySourceContext to use in initialising.

Returns:

Meta-data to describe this.

Throws:

Exception - Should the HttpSecuritySource fail to configure itself from the input properties.

loadMetaData

protected abstract void loadMetaData(AbstractHttpSecuritySource.MetaDataContext<A,AC,C,O,F> context)
                              throws Exception

Overridden to load meta-data.

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

start

public void start(HttpSecurityExecuteContext<F> context)
           throws Exception

Description copied from interface: HttpSecuritySource

Called once after HttpSecuritySource.init(HttpSecuritySourceContext) to indicate this HttpSecuritySource should start execution.

On invocation of this method, ProcessState instances may be invoked via the HttpSecurityExecuteContext.

Specified by:

start in interface HttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>

Parameters:

context - HttpSecurityExecuteContext to use in starting this HttpSecuritySource.

Throws:

Exception - Should the HttpSecuritySource fail to start execution.

stop

public void stop()

Description copied from interface: HttpSecuritySource

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.

Specified by:

stop in interface HttpSecuritySource<A,AC extends Serializable,C,O extends Enum<O>,F extends Enum<F>>