NuxeoAuthenticationPlugin (Nuxeo 2021.70.4 API Documentation)

All Known Implementing Classes:

AnonymousAuthenticator, AnonymousAuthenticatorForCAS2, BasicAuthenticator, Cas2Authenticator, ClearTrustAuthenticator, DigestAuthenticator, DuoFactorsAuthenticator, FormAuthenticator, JWTAuthenticator, KeycloakAuthenticationPlugin, Krb5Authenticator, NTLMAuthenticator, NuxeoOAuth1Authenticator, NuxeoOAuth2Authenticator, OpenIDConnectAuthenticator, PortalAuthenticator, ProxyAuthenticator, SAMLAuthenticationProvider, ShibbolethAuthenticationPlugin, TokenAuthenticator, WebEngineFormAuthenticator
```
public interface NuxeoAuthenticationPlugin
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	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.
`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.

- Method Detail
  - handleLoginPrompt
```
Boolean handleLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest,
                          javax.servlet.http.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(javax.servlet.http.HttpServletRequest httpRequest,
                                              javax.servlet.http.HttpServletResponse httpResponse)
```
    Retrieves user identification information from the request.
    
    Parameters:
    
    httpRequest - the request
    
    httpResponse - the response
  - needLoginPrompt
```
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(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.