Package net.officefloor.web.security.type

Interface HttpSecurityTypeBuilder

public interface HttpSecurityTypeBuilder

Builder for the HttpSecurityType to validate the loaded HttpSecurityType from the HttpSecuritySource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addDependency(Enum<?> key, Class<?> type, String typeQualifier)	Convenience method to add a HttpSecurityDependencyType based on the key.
void	addDependency(String name, Class<?> type, String typeQualifier, int index, Enum<?> key)	Adds a HttpSecurityDependencyType.
void	addFlow(Enum<?> key, Class<?> argumentType)	Convenience method to add a HttpSecurityFlowType based on the key.
void	addFlow(String name, Class<?> argumentType, int index, Enum<?> key)	Adds a HttpSecurityFlowType.
<A, AC extends Serializable, C, O extends Enum<O>, F extends Enum<F>> HttpSecurityType<A,AC,C,O,F>	build()	Builds the HttpSecurityType.
void	setAccessControlClass(Class<?> accessControlClass)	Specifies the access control class.
void	setAuthenticationClass(Class<?> authenticationClass)	Specifies the authentication class.
void	setCredentialsClass(Class<?> credentialsClass)	Specifies the credentials class.
void	setInput(boolean isInput)	Indicates if input.

Method Details

setAuthenticationClass

void setAuthenticationClass(Class<?> authenticationClass)

Specifies the authentication class.

Parameters:

authenticationClass - Class of the authentication.

setAccessControlClass

void setAccessControlClass(Class<?> accessControlClass)

Specifies the access control class.

Parameters:

accessControlClass - Class of the access control.

setCredentialsClass

void setCredentialsClass(Class<?> credentialsClass)

Specifies the credentials class.

May be not specified if no application behaviour required to provide credentials.

Parameters:

credentialsClass - Class of the credentials.

addDependency

void addDependency(String name,
 Class<?> type,
 String typeQualifier,
 int index,
 Enum<?> key)

Adds a HttpSecurityDependencyType.

Parameters:

name - Name of the HttpSecurityDependencyType.

type - Type of the HttpSecurityDependencyType.

typeQualifier - Qualifier for the type of HttpSecurityDependencyType.

index - Index of the HttpSecurityDependencyType.

key - Key identifying the HttpSecurityDependencyType.

setInput

void setInput(boolean isInput)

Indicates if input.

Parameters:

isInput - true if input.

addDependency

void addDependency(Enum<?> key,
 Class<?> type,
 String typeQualifier)

Convenience method to add a HttpSecurityDependencyType based on the key.

Both the name and index are extracted from the key.

Parameters:

key - Key identifying the HttpSecurityDependencyType.

type - Type of the HttpSecurityDependencyType.

typeQualifier - Qualifier for the type of HttpSecurityDependencyType.

addFlow

void addFlow(String name,
 Class<?> argumentType,
 int index,
 Enum<?> key)

Adds a HttpSecurityFlowType.

Parameters:

name - Name of the HttpSecurityFlowType.

argumentType - Type of argument passed to the HttpSecurityFlowType.

index - Index of the HttpSecurityFlowType.

key - Key identifying the HttpSecurityFlowType.

addFlow

void addFlow(Enum<?> key,
 Class<?> argumentType)

Convenience method to add a HttpSecurityFlowType based on the key.

Both the name and index are extracted from the key.

Parameters:

key - Key identifying the HttpSecurityFlowType.

argumentType - Type of argument passed to the HttpSecurityFlowType.

build

<A,
AC extends Serializable,
C,
O extends Enum<O>,
F extends Enum<F>>
HttpSecurityType<A,AC,C,O,F> build()

Builds the HttpSecurityType.

Type Parameters:

A - Authorization type.

AC - Access control type.

C - Credentials type.

O - Dependency keys.

F - Flow keys.

Returns:

HttpSecurityType.