net.officefloor.plugin.web.http.security

Interface HttpAuthentication<S,C>

All Known Implementing Classes:

AnonymousHttpAuthenticationManagedObjectSource, HttpAuthenticationManagedObject

public interface HttpAuthentication<S,C>

Dependency interface allowing the application to check if the HTTP client is authenticated.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	authenticate(HttpAuthenticateRequest<C> authenticationRequest) Undertakes authentication.
S	getHttpSecurity() Obtains the HTTP security.
void	logout(HttpLogoutRequest logoutRequest) Undertakes logging out.

Method Detail

authenticate

void authenticate(HttpAuthenticateRequest<C> authenticationRequest)

Undertakes authentication.

Parameters:

authenticationRequest - HttpAuthenticateRequest.

getHttpSecurity

S getHttpSecurity()
           throws IOException

Obtains the HTTP security.

Returns:

HTTP security or null if not authenticated.

Throws:

IOException - If authentication has been attempted but there were failures communicating to necessary security services.

logout

void logout(HttpLogoutRequest logoutRequest)

Undertakes logging out.

Parameters:

logoutRequest - HttpLogoutRequest.