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 theAuthorization: Bearer
request header for a valid OAuth2 token (checked with theOAuth2ClientService
).- Since:
- 10.3
-
-
Field Summary
Fields Modifier and Type Field Description static String
ACCESS_TOKEN
static String
BEARER_SP
protected OAuth2TokenStore
tokenStore
-
Constructor Summary
Constructors Constructor Description NuxeoOAuth2Authenticator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
getAccessToken(javax.servlet.http.HttpServletRequest request)
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 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.Boolean
needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest)
Defines if the authentication plugin needs to do a login prompt.
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 interfaceNuxeoAuthenticationPlugin
-
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 interfaceNuxeoAuthenticationPlugin
-
needLoginPrompt
public Boolean needLoginPrompt(javax.servlet.http.HttpServletRequest httpRequest)
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
protected String getAccessToken(javax.servlet.http.HttpServletRequest request)
-
-