Package org.nuxeo.ecm.platform.ui.web.auth.cleartrust

Class ClearTrustAuthenticator

java.lang.Object

org.nuxeo.ecm.platform.ui.web.auth.cleartrust.ClearTrustAuthenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin, NuxeoAuthenticationPluginLogoutExtension

public class ClearTrustAuthenticator
extends Object
implements NuxeoAuthenticationPlugin, NuxeoAuthenticationPluginLogoutExtension

Author:

M.-A. Darche

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CLEARTRUST_COOKIE_SESSION
protected static final String	CLEARTRUST_COOKIE_SESSION_A
protected static final String	CLEARTRUST_HEADER_UID
protected String	cleartrustLoginUrl
protected String	cleartrustLogoutUrl
protected String	cookieDomain

Constructor Summary

Constructors

Constructor	Description
ClearTrustAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected void	displayCookieInformation(jakarta.servlet.http.Cookie[] cookies)
protected void	displayRequestInformation(jakarta.servlet.http.HttpServletRequest request)
protected jakarta.servlet.http.Cookie[]	getCookies(jakarta.servlet.http.HttpServletRequest request)
List<String>	getUnAuthenticatedURLPrefix()	Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.
Boolean	handleLoginPrompt(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String baseURL)	Redirects to the ClearTrust login page if the request doesn't contain cookies indicating that a positive authentication occurred.
Boolean	handleLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handles logout operation.
UserIdentificationInfo	handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest request, jakarta.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(jakarta.servlet.http.HttpServletRequest request)	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 Details

CLEARTRUST_HEADER_UID

protected static final String CLEARTRUST_HEADER_UID

See Also:

• Constant Field Values

CLEARTRUST_COOKIE_SESSION_A

protected static final String CLEARTRUST_COOKIE_SESSION_A

See Also:

• Constant Field Values

CLEARTRUST_COOKIE_SESSION

protected static final String CLEARTRUST_COOKIE_SESSION

See Also:

• Constant Field Values

cookieDomain

protected String cookieDomain

cleartrustLoginUrl

protected String cleartrustLoginUrl

cleartrustLogoutUrl

protected String cleartrustLogoutUrl

Constructor Details

ClearTrustAuthenticator

public ClearTrustAuthenticator()

Method Details

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(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 String baseURL)

Redirects to the ClearTrust login page if the request doesn't contain cookies indicating that a positive authentication occurred.

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

handleRetrieveIdentity

public UserIdentificationInfo handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse httpResponse)

Description copied from interface: NuxeoAuthenticationPlugin

Retrieves user identification information from the request.

Specified by:

handleRetrieveIdentity in interface NuxeoAuthenticationPlugin

Parameters:

request - the request

httpResponse - the response

needLoginPrompt

public Boolean needLoginPrompt(jakarta.servlet.http.HttpServletRequest request)

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

handleLogout

public Boolean handleLogout(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: NuxeoAuthenticationPluginLogoutExtension

Handles logout operation.

Generic logout (killing session and Seam objects) is done by LogoutActionBean This interface must be implemented by auth plugin when the target auth system needs a specific logout procedure.

Specified by:

handleLogout in interface NuxeoAuthenticationPluginLogoutExtension

Returns:

true if there is a redirection

getCookies

protected jakarta.servlet.http.Cookie[] getCookies(jakarta.servlet.http.HttpServletRequest request)

displayCookieInformation

protected void displayCookieInformation(jakarta.servlet.http.Cookie[] cookies)

displayRequestInformation

protected void displayRequestInformation(jakarta.servlet.http.HttpServletRequest request)

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