net.officefloor.plugin.web.http.security

Interface HttpSecuritySourceMetaData<S,C,D extends Enum<D>,F extends Enum<F>>

public interface HttpSecuritySourceMetaData<S,C,D extends Enum<D>,F extends Enum<F>>

Meta-data of the HttpSecuritySource.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
Class<C>	getCredentialsClass() 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.
Class<S>	getSecurityClass() Obtains the Class of the security object.

Method Detail

getSecurityClass

Class<S> getSecurityClass()

Obtains the Class of the security object.

Returns:

Class of the security object.

getCredentialsClass

Class<C> getCredentialsClass()

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 Task 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.

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 JobSequence instances instigated by this HttpSecuritySource.