org.nuxeo.ecm.webengine.login

Class WebEngineFormAuthenticator

java.lang.Object

org.nuxeo.ecm.webengine.login.WebEngineFormAuthenticator

All Implemented Interfaces:

LoginResponseHandler, NuxeoAuthenticationPlugin

public class WebEngineFormAuthenticator
extends Object
implements NuxeoAuthenticationPlugin, LoginResponseHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOGIN_KEY

Constructor Summary

Constructors

Constructor and Description
WebEngineFormAuthenticator()

Method Summary

Modifier and Type	Method and Description
List<String>	getUnAuthenticatedURLPrefix() Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.
Boolean	handleLoginPrompt(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String baseURL) Handles the Login Prompt.
UserIdentificationInfo	handleRetrieveIdentity(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Retrieves user identification information from the request.
void	initPlugin(Map<String,String> parameters) Initializes the Plugin from parameters set in the XML descriptor.
static boolean	isLoginRequest(javax.servlet.http.HttpServletRequest request)
Boolean	needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest) Defines if the authentication plugin needs to do a login prompt.
boolean	onError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the login error response.
boolean	onSuccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles login success response.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGIN_KEY

public static final String LOGIN_KEY

See Also:

Constant Field Values

Constructor Detail

WebEngineFormAuthenticator

public WebEngineFormAuthenticator()

Method Detail

handleLoginPrompt

public Boolean handleLoginPrompt(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String baseURL)

Description copied from interface: NuxeoAuthenticationPlugin

Handles the Login Prompt.

Specified by:

handleLoginPrompt in interface NuxeoAuthenticationPlugin

Parameters:

request - the request

response - the response

Returns:

true if AuthFilter must stop execution (ie: login prompt generated a redirect), false otherwise

isLoginRequest

public static boolean isLoginRequest(javax.servlet.http.HttpServletRequest request)

handleRetrieveIdentity

public UserIdentificationInfo handleRetrieveIdentity(javax.servlet.http.HttpServletRequest httpRequest,
                                                     javax.servlet.http.HttpServletResponse httpResponse)

Description copied from interface: NuxeoAuthenticationPlugin

Retrieves user identification information from the request.

Specified by:

handleRetrieveIdentity in interface NuxeoAuthenticationPlugin

Parameters:

httpRequest - the request

httpResponse - the response

needLoginPrompt

public Boolean needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest)

Description copied from interface: NuxeoAuthenticationPlugin

Defines if the authentication plugin needs to do a login prompt.

Specified by:

needLoginPrompt in interface NuxeoAuthenticationPlugin

Returns:

true if LoginPrompt is used

initPlugin

public void initPlugin(Map<String,String> parameters)

Description copied from interface: NuxeoAuthenticationPlugin

Initializes the Plugin from parameters set in the XML descriptor.

Specified by:

initPlugin in interface NuxeoAuthenticationPlugin

getUnAuthenticatedURLPrefix

public List<String> getUnAuthenticatedURLPrefix()

Description copied from interface: NuxeoAuthenticationPlugin

Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.

Specified by:

getUnAuthenticatedURLPrefix in interface NuxeoAuthenticationPlugin

onError

public boolean onError(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

Description copied from interface: LoginResponseHandler

Handles the login error response.

Specified by:

onError in interface LoginResponseHandler

Parameters:

request - the HTTP request

response - the HTTP response

Returns:

true if error was handled, false otherwise

onSuccess

public boolean onSuccess(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)

Description copied from interface: LoginResponseHandler

Handles login success response.

Specified by:

onSuccess in interface LoginResponseHandler

Parameters:

request - the HTTP request

response - the HTTP response

Returns:

true if response was handled, false otherwise