Package org.nuxeo.ecm.platform.oauth2
Class NuxeoOAuth2Authenticator
java.lang.Object
org.nuxeo.ecm.platform.oauth2.NuxeoOAuth2Authenticator
- All Implemented Interfaces:
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
Modifier and TypeFieldDescriptionstatic final String
static final String
protected OAuth2TokenStore
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
getAccessToken
(javax.servlet.http.HttpServletRequest request) Returns the list of prefix for unauthenticated URLs, typically the URLs associated to login prompt.handleLoginPrompt
(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String baseURL) Handles the Login Prompt.handleRetrieveIdentity
(javax.servlet.http.HttpServletRequest request, javax.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.needLoginPrompt
(javax.servlet.http.HttpServletRequest httpRequest) Defines if the authentication plugin needs to do a login prompt.
-
Field Details
-
ACCESS_TOKEN
- See Also:
-
BEARER_SP
- See Also:
-
tokenStore
-
-
Constructor Details
-
NuxeoOAuth2Authenticator
public NuxeoOAuth2Authenticator()
-
-
Method Details
-
initPlugin
Description copied from interface:NuxeoAuthenticationPlugin
Initializes the Plugin from parameters set in the XML descriptor.- Specified by:
initPlugin
in interfaceNuxeoAuthenticationPlugin
-
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 interfaceNuxeoAuthenticationPlugin
-
needLoginPrompt
Description copied from interface:NuxeoAuthenticationPlugin
Defines if the authentication plugin needs to do a login prompt.- Specified by:
needLoginPrompt
in interfaceNuxeoAuthenticationPlugin
- Returns:
- true if LoginPrompt is used
-
handleLoginPrompt
public Boolean handleLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String baseURL) Description copied from interface:NuxeoAuthenticationPlugin
Handles the Login Prompt.- Specified by:
handleLoginPrompt
in interfaceNuxeoAuthenticationPlugin
- Parameters:
httpRequest
- the requesthttpResponse
- the response- Returns:
- true if AuthFilter must stop execution (ie: login prompt generated a redirect), false otherwise
-
handleRetrieveIdentity
public UserIdentificationInfo handleRetrieveIdentity(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Description copied from interface:NuxeoAuthenticationPlugin
Retrieves user identification information from the request.- Specified by:
handleRetrieveIdentity
in interfaceNuxeoAuthenticationPlugin
- Parameters:
request
- the requestresponse
- the response
-
getAccessToken
-