org.nuxeo.ecm.platform.ui.web.auth.interfaces
Interface NuxeoAuthenticationPlugin

All Known Implementing Classes:

AnonymousAuthenticator, BasicAuthenticator, FormAuthenticator, OAuthSessionFilter, WebEngineFormAuthenticator, WebServicesAuthenticator

public interface NuxeoAuthenticationPlugin

Method Summary

java.util.List<java.lang.String>	getUnAuthenticatedURLPrefix() Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.
java.lang.Boolean	handleLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, java.lang.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(java.util.Map<java.lang.String,java.lang.String> parameters) Initializes the Plugin from parameters set in the XML descriptor.
java.lang.Boolean	needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest) Defines if the authentication plugin needs to do a login prompt.

Method Detail

handleLoginPrompt

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

Handles the Login Prompt.

Parameters:

httpRequest - the request

httpResponse - the response

Returns:

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

handleRetrieveIdentity

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

Retrieves user identification information from the request.

Parameters:

httpRequest -

httpResponse -

Returns:

UserIdentificationInfo

needLoginPrompt

java.lang.Boolean needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest)

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

Returns:

true if LoginPrompt is used

initPlugin

void initPlugin(java.util.Map<java.lang.String,java.lang.String> parameters)

Initializes the Plugin from parameters set in the XML descriptor.

Parameters:

parameters -

getUnAuthenticatedURLPrefix

java.util.List<java.lang.String> getUnAuthenticatedURLPrefix()

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

Returns: