net.officefloor.plugin.web.http.security.impl

Class AbstractHttpSecuritySource<S,C,D extends Enum<D>,F extends Enum<F>>

java.lang.Object

net.officefloor.plugin.web.http.security.impl.AbstractHttpSecuritySource<S,C,D,F>

All Implemented Interfaces:

HttpSecuritySource<S,C,D,F>

Direct Known Subclasses:

BasicHttpSecuritySource, DigestHttpSecuritySource, FormHttpSecuritySource, MockHttpSecuritySource

public abstract class AbstractHttpSecuritySource<S,C,D extends Enum<D>,F extends Enum<F>>
extends Object
implements HttpSecuritySource<S,C,D,F>

Abstract HttpSecuritySource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 JobSequence.
static interface	AbstractHttpSecuritySource.MetaDataContext<S,C,D extends Enum<D>,F extends Enum<F>> Context for the HttpSecuritySource.getMetaData().
static interface	AbstractHttpSecuritySource.SpecificationContext Context for the HttpSecuritySource.getSpecification().

Constructor Summary

Constructors

Constructor and Description
AbstractHttpSecuritySource()

Method Summary

Modifier and Type	Method and Description
HttpSecuritySourceMetaData<S,C,D,F>	getMetaData() Obtains the meta-data to describe this.
HttpSecuritySourceSpecification	getSpecification() Obtains the specification for this.
void	init(HttpSecuritySourceContext context) Called only once after the HttpSecuritySource is instantiated.
protected abstract void	loadMetaData(AbstractHttpSecuritySource.MetaDataContext<S,C,D,F> context) Overridden to load meta-data.
protected abstract void	loadSpecification(AbstractHttpSecuritySource.SpecificationContext context) Overridden to load specifications.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.plugin.web.http.security.HttpSecuritySource

authenticate, challenge, logout, ratify

Constructor Detail

AbstractHttpSecuritySource

public AbstractHttpSecuritySource()

Method Detail

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<S,C,D extends Enum<D>,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 void init(HttpSecuritySourceContext context)
          throws Exception

Description copied from interface: HttpSecuritySource

Called only once after the HttpSecuritySource is instantiated.

Specified by:

init in interface HttpSecuritySource<S,C,D extends Enum<D>,F extends Enum<F>>

Parameters:

context - HttpSecuritySourceContext to use in initialising.

Throws:

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

loadMetaData

protected abstract void loadMetaData(AbstractHttpSecuritySource.MetaDataContext<S,C,D,F> context)
                              throws Exception

Overridden to load meta-data.

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

getMetaData

public HttpSecuritySourceMetaData<S,C,D,F> getMetaData()

Description copied from interface: HttpSecuritySource

Obtains the meta-data to describe this.

This is called after the HttpSecuritySource.init(HttpSecuritySourceContext) method and therefore may use the configuration.

This should always return non-null. If there is a problem due to incorrect configuration, the HttpSecuritySource.init(HttpSecuritySourceContext) should indicate this via an exception.

Specified by:

getMetaData in interface HttpSecuritySource<S,C,D extends Enum<D>,F extends Enum<F>>

Returns:

Meta-data to describe this.