org.nuxeo.ecm.webengine.jaxrs.login
Interface AuthenticationHandler

All Known Implementing Classes:

Base64AuthenticationHandler, CompositeAuthenticationHandler

public interface AuthenticationHandler

Initiate an authentication for the given HTTP request. Implementations are responsible to detect whether the request contains any known authentication data and perform the authentication if needed.

Author:

Bogdan Stefanescu

Method Summary

LoginContext	handleAuthentication(HttpServletRequest request, HttpServletResponse response) Handle the authentication if the request contains any known authentication data.
void	init(Map<String,String> properties) Initialize this handler given a property map.

Method Detail

init

void init(Map<String,String> properties)

Initialize this handler given a property map.

Parameters:

properties -

handleAuthentication

LoginContext handleAuthentication(HttpServletRequest request,
                                  HttpServletResponse response)
                                  throws LoginException

Handle the authentication if the request contains any known authentication data. If authentication was done returns the resulting LoginContext otherwise returns null. If authentication failed throws LoginException and the implementation must finish the request by correctly responding to the client or redirecting to another page - through the given response object.

Parameters:

request - the http request

response - the http response

Returns:

the loginc context if successful, or null if login was not handled.

Throws:

LoginException - if authentication failed.