Package net.officefloor.web.spi.security

Interface AuthenticationContext<AC extends Serializable,C>

public interface AuthenticationContext<AC extends Serializable,C>

Context for authentication.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	authenticate(C credentials, AuthenticateRequest authenticateRequest)	Undertakes authentication.
String	getQualifier()	Obtains the qualifier for the HttpSecurity backing this AuthenticationContext.
void	logout(LogoutRequest logoutRequest)	Undertakes logout.
void	register(AccessControlListener<? super AC> accessControlListener)	Registers an AccessControlListener.
<R, T extends Throwable> R	run(ProcessSafeOperation<R,T> operation)	Undertakes a ProcessSafeOperation.

Method Details

getQualifier

String getQualifier()

Obtains the qualifier for the HttpSecurity backing this AuthenticationContext.

Returns:

Qualifier for the HttpSecurity backing this AuthenticationContext.

register

void register(AccessControlListener<? super AC> accessControlListener)

Registers an AccessControlListener.

Parameters:

accessControlListener - AccessControlListener.

authenticate

void authenticate(C credentials,
 AuthenticateRequest authenticateRequest)

Undertakes authentication.

Parameters:

credentials - Credentials (if available). May be null.

authenticateRequest - Optional AuthenticateRequest. May be null.

logout

void logout(LogoutRequest logoutRequest)

Undertakes logout.

Parameters:

logoutRequest - Optional LogoutRequest. May be null.

run

<R,
T extends Throwable> R run(ProcessSafeOperation<R,T> operation)
                       throws T

Undertakes a ProcessSafeOperation.

Type Parameters:

R - Return type.

T - Possible Exception type.

Parameters:

operation - ProcessSafeOperation.

Returns:

Return value.

Throws:

T - Possible Throwable.