Package net.officefloor.web.security.build

Interface HttpSecurityArchitect

All Known Implementing Classes:

HttpSecurityArchitectEmployer

public interface HttpSecurityArchitect

Builds the HttpSecurityBuilder instances for the WebArchitect.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
Map<String,HttpSecurityBuilder>	addHttpSecurities(String securityDirectory, PropertyList properties)	Adds multiple HttpSecurity instances loaded from via ComposeArchitect wiring the Flow instances of the HttpSecurity.
<A, AC extends Serializable, C, O extends Enum<O>, F extends Enum<F>> HttpSecurityBuilder	addHttpSecurity(String securityName, String httpSecuritySourceClassName)	Adds a HttpSecurity.
HttpSecurityBuilder	addHttpSecurity(String securityName, String securityLocation, PropertyList properties)	Adds a HttpSecurity loaded from via ComposeArchitect wiring the Flow instances of the HttpSecurity.
<A, AC extends Serializable, C, O extends Enum<O>, F extends Enum<F>> HttpSecurityBuilder	addHttpSecurity(String securityName, HttpSecuritySource<A,AC,C,O,F> httpSecuritySource)	Adds a HttpSecurity.
void	addHttpSecurityExplorer(HttpSecurityExplorer explorer)	Adds a HttpSecurityExplorer.
HttpSecurer	createHttpSecurer(HttpSecurable securable)	Creates a HttpSecurer.
void	informWebArchitect()	Informs the WebArchitect of the necessary security.

Method Details

addHttpSecurity

<A,
AC extends Serializable,
C,
O extends Enum<O>,
F extends Enum<F>>
HttpSecurityBuilder addHttpSecurity(String securityName,
 String httpSecuritySourceClassName)

Adds a HttpSecurity.

Type Parameters:

A - Authentication type.

AC - Access control type.

C - Credentials type.

O - Dependency key type.

F - Flow key type.

Parameters:

securityName - Name of the HttpSecurityBuilder. This name is use to qualify dependency injection, should this particular HttpSecurityBuilder be required.

httpSecuritySourceClassName - Name of the HttpSecuritySource Class.

Returns:

HttpSecurityBuilder.

addHttpSecurity

<A,
AC extends Serializable,
C,
O extends Enum<O>,
F extends Enum<F>>
HttpSecurityBuilder addHttpSecurity(String securityName,
 HttpSecuritySource<A,AC,C,O,F> httpSecuritySource)

Adds a HttpSecurity.

Type Parameters:

A - Authentication type.

AC - Access control type.

C - Credentials type.

O - Dependency key type.

F - Flow key type.

Parameters:

securityName - Name of the HttpSecurityBuilder. This name is use to qualify dependency injection, should this particular HttpSecurityBuilder be required.

httpSecuritySource - HttpSecuritySource.

Returns:

HttpSecurityBuilder.

addHttpSecurity

HttpSecurityBuilder addHttpSecurity(String securityName,
 String securityLocation,
 PropertyList properties)
                             throws Exception

Adds a HttpSecurity loaded from via ComposeArchitect wiring the Flow instances of the HttpSecurity.

Parameters:

securityName - Name of the HttpSecurityBuilder.

securityLocation - Location of the yml configuration.

properties - PropertyList for configuration.

Returns:

HttpSecurityBuilder.

Throws:

Exception - If fails to load the HttpSecurity.

addHttpSecurities

Map<String,HttpSecurityBuilder> addHttpSecurities(String securityDirectory,
 PropertyList properties)
                                           throws Exception

Adds multiple HttpSecurity instances loaded from via ComposeArchitect wiring the Flow instances of the HttpSecurity.

Parameters:

securityDirectory - Directory containing yml configurations.

properties - PropertyList for configuration.

Returns:

Map of HttpSecurityBuilder by security name.

Throws:

Exception - If fails to load the HttpSecurity instances.

createHttpSecurer

HttpSecurer createHttpSecurer(HttpSecurable securable)

Creates a HttpSecurer.

Parameters:

securable - HttpSecurable to provide the access configuration. May be null to just require authentication.

Returns:

HttpSecurer.

addHttpSecurityExplorer

void addHttpSecurityExplorer(HttpSecurityExplorer explorer)

Adds a HttpSecurityExplorer.

Parameters:

explorer - HttpSecurityExplorer.

informWebArchitect

void informWebArchitect()

Informs the WebArchitect of the necessary security. This is to be invoked once all security is configured.