Package org.nuxeo.ecm.platform.oauth2

Class NuxeoOAuth2Authenticator

java.lang.Object

org.nuxeo.ecm.platform.oauth2.NuxeoOAuth2Authenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin

public class NuxeoOAuth2Authenticator
extends Object
implements NuxeoAuthenticationPlugin

OAuth2 Authentication Plugin.

This plugin chekcs the access_token request parameter or the Authorization: Bearer request header for a valid OAuth2 token (checked with the OAuth2ClientService).

Since:

10.3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_TOKEN
static final String	BEARER_SP
protected OAuth2TokenStore	tokenStore

Constructor Summary

Constructors

Constructor	Description
NuxeoOAuth2Authenticator()

Method Summary

Modifier and Type	Method	Description
protected String	getAccessToken(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 httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse, String baseURL)	Handles the Login Prompt.
UserIdentificationInfo	handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	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 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 Details

ACCESS_TOKEN

public static final String ACCESS_TOKEN

See Also:

• Constant Field Values

BEARER_SP

public static final String BEARER_SP

See Also:

• Constant Field Values

tokenStore

protected OAuth2TokenStore tokenStore

Constructor Details

NuxeoOAuth2Authenticator

public NuxeoOAuth2Authenticator()

Method Details

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

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

needLoginPrompt

public Boolean needLoginPrompt(jakarta.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

handleLoginPrompt

public Boolean handleLoginPrompt(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.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(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: NuxeoAuthenticationPlugin

Retrieves user identification information from the request.

Specified by:

handleRetrieveIdentity in interface NuxeoAuthenticationPlugin

Parameters:

request - the request

response - the response

getAccessToken

protected String getAccessToken(jakarta.servlet.http.HttpServletRequest request)