org.nuxeo.ecm.platform.ui.web.auth.proxy

Class ProxyAuthenticator

java.lang.Object

org.nuxeo.ecm.platform.ui.web.auth.proxy.ProxyAuthenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin

public class ProxyAuthenticator
extends Object
implements NuxeoAuthenticationPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_CREDENTIAL_DIRECTORY_FIELD_PROPERTY_NAME
protected boolean	noRedirect
protected String	regexp
protected String	userIdHeaderName
static String	USERNAME_REMOVE_EXPRESSION

Constructor Summary

Constructors

Constructor and Description
ProxyAuthenticator()

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 httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String baseURL) Handles the Login Prompt.
protected void	handleRedirectToValidStartPage(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Handle redirection so that context is rebuilt correctly see NXP-2060 + NXP-2064
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.
Boolean	needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest) Defines if the authentication plugin needs to do a login prompt.

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME_REMOVE_EXPRESSION

public static final String USERNAME_REMOVE_EXPRESSION

See Also:

Constant Field Values

userIdHeaderName

protected String userIdHeaderName

regexp

protected String regexp

noRedirect

protected boolean noRedirect

HTTP_CREDENTIAL_DIRECTORY_FIELD_PROPERTY_NAME

public static final String HTTP_CREDENTIAL_DIRECTORY_FIELD_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

ProxyAuthenticator

public ProxyAuthenticator()

Method Detail

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

handleLoginPrompt

public Boolean handleLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest,
                                 javax.servlet.http.HttpServletResponse httpResponse,
                                 String baseURL)

Description copied from interface: NuxeoAuthenticationPlugin

Handles the Login Prompt.

Specified by:

handleLoginPrompt in interface NuxeoAuthenticationPlugin

Parameters:

httpRequest - the request

httpResponse - the response

Returns:

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

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

handleRedirectToValidStartPage

protected void handleRedirectToValidStartPage(javax.servlet.http.HttpServletRequest httpRequest,
                                              javax.servlet.http.HttpServletResponse httpResponse)

Handle redirection so that context is rebuilt correctly see NXP-2060 + NXP-2064

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

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