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

Interface NuxeoAuthenticationPlugin

All Known Implementing Classes:

AnonymousAuthenticator, AnonymousAuthenticatorForCAS2, ApplicationFormAuthenticator, BasicAuthenticator, Cas2Authenticator, ClearTrustAuthenticator, DigestAuthenticator, FormAuthenticator, Krb5Authenticator, NTLMAuthenticator, OpenIDConnectAuthenticator, PortalAuthenticator, ProxyAuthenticator, ShibbolethAuthenticationPlugin, TokenAuthenticator, WebEngineFormAuthenticator, WebServicesAuthenticator

public interface NuxeoAuthenticationPlugin

Method Summary

Methods

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(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String baseURL) Handles the Login Prompt.
UserIdentificationInfo	handleRetrieveIdentity(HttpServletRequest httpRequest, 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(HttpServletRequest httpRequest) Defines if the authentication plugin needs to do a login prompt.

Method Detail

handleLoginPrompt

Boolean handleLoginPrompt(HttpServletRequest httpRequest,
                        HttpServletResponse httpResponse,
                        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(HttpServletRequest httpRequest,
                                            HttpServletResponse httpResponse)

Retrieves user identification information from the request.

Parameters:

httpRequest - the request

httpResponse - the response

needLoginPrompt

Boolean needLoginPrompt(HttpServletRequest httpRequest)

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

Returns:

true if LoginPrompt is used

initPlugin

void initPlugin(Map<String,String> parameters)

Initializes the Plugin from parameters set in the XML descriptor.

getUnAuthenticatedURLPrefix

List<String> getUnAuthenticatedURLPrefix()

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