Package net.officefloor.web.spi.security

Interface HttpSecuritySourceMetaData<A,AC extends Serializable,C,D extends Enum<D>,F extends Enum<F>>

public interface HttpSecuritySourceMetaData<A,AC extends Serializable,C,D extends Enum<D>,F extends Enum<F>>

Meta-data of the HttpSecuritySource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
Class<AC>	getAccessControlType()	Obtains the Class of the access control object.
Class<A>	getAuthenticationType()	Obtains the Class of the authentication object.
Class<C>	getCredentialsType()	Obtains the Class of the credentials object to be provided by the application.
HttpSecurityDependencyMetaData<D>[]	getDependencyMetaData()	Obtains the list of HttpSecurityDependencyMetaData instances required by this HttpSecuritySource.
HttpSecurityFlowMetaData<F>[]	getFlowMetaData()	Obtains the list of HttpSecurityFlowMetaData instances should this HttpSecuritySource require application specific behaviour.
HttpAccessControlFactory<AC>	getHttpAccessControlFactory()	Obtains the HttpAccessControlFactory to adapt the custom access control into a HttpAccessControl.
HttpAuthenticationFactory<A,C>	getHttpAuthenticationFactory()	Obtains the HttpAuthenticationFactory to adapt the custom authentication into a HttpAuthentication.

Method Details

getAuthenticationType

Class<A> getAuthenticationType()

Obtains the Class of the authentication object.

Returns:

Class of the authentication object.

getHttpAuthenticationFactory

HttpAuthenticationFactory<A,C> getHttpAuthenticationFactory()

Obtains the HttpAuthenticationFactory to adapt the custom authentication into a HttpAuthentication.

Returns:

HttpAuthenticationFactory to adapt the custom authentication into a HttpAuthentication.

getCredentialsType

Class<C> getCredentialsType()

Obtains the Class of the credentials object to be provided by the application.

An instance of this Class is to be provided as a parameter to the ManagedFunction that attempts authentication. This allows application specific behaviour to obtain the credentials (such as a login page).

Should the security protocol be application agnostic (such as client security keys) this should be null.

Returns:

Class of the credentials object or null if no application specific behaviour.

getAccessControlType

Class<AC> getAccessControlType()

Obtains the Class of the access control object.

Returns:

Class of the access control object.

getHttpAccessControlFactory

HttpAccessControlFactory<AC> getHttpAccessControlFactory()

Obtains the HttpAccessControlFactory to adapt the custom access control into a HttpAccessControl.

Returns:

HttpAccessControlFactory to adapt the custom access control into a HttpAccessControl.

getDependencyMetaData

HttpSecurityDependencyMetaData<D>[] getDependencyMetaData()

Obtains the list of HttpSecurityDependencyMetaData instances required by this HttpSecuritySource.

Returns:

Meta-data of the required dependencies for this HttpSecuritySource.

getFlowMetaData

HttpSecurityFlowMetaData<F>[] getFlowMetaData()

Obtains the list of HttpSecurityFlowMetaData instances should this HttpSecuritySource require application specific behaviour.

Returns:

Meta-data of application Flow instances instigated by this HttpSecuritySource.