Package net.officefloor.web.spi.security

Interface HttpSecuritySource<A,AC extends java.io.Serializable,C,O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

All Known Implementing Classes:

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

public interface HttpSecuritySource<A,AC extends java.io.Serializable,C,O extends java.lang.Enum<O>,F extends java.lang.Enum<F>>

Source for obtaining HttpSecurity.

As security is specific to applications, both the security object and credentials are specified by the application.

Author:

Daniel Sagenschneider

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.
HttpSecurity<A,AC,C,O,F>	sourceHttpSecurity(HttpSecurityContext context)	Sources the HttpSecurity.
void	start(HttpSecurityExecuteContext<F> context)	Called once after init(HttpSecuritySourceContext) to indicate this HttpSecuritySource should start execution.
void	stop()	Called to notify that the OfficeFloor is being closed.

Method Detail

getSpecification

HttpSecuritySourceSpecification getSpecification()

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.

Returns:

Specification of this.

init

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

Initialises the HttpSecuritySource.

Parameters:

context - HttpSecuritySourceContext to use in initialising.

Returns:

Meta-data to describe this.

Throws:

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

start

void start(HttpSecurityExecuteContext<F> context)
    throws java.lang.Exception

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

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

Parameters:

context - HttpSecurityExecuteContext to use in starting this HttpSecuritySource.

Throws:

java.lang.Exception - Should the HttpSecuritySource fail to start execution.

sourceHttpSecurity

HttpSecurity<A,AC,C,O,F> sourceHttpSecurity(HttpSecurityContext context)
                                                             throws HttpException

Sources the HttpSecurity.

Parameters:

context - HttpSecurity.

Returns:

HttpSecurity.

Throws:

HttpException - If fails to source the HttpSecurity.

stop

void stop()

Called to notify that the OfficeFloor is being closed.

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