org.nuxeo.ecm.platform.oauth2.openid.auth

Class OpenIDConnectAuthenticator

java.lang.Object

org.nuxeo.ecm.platform.oauth2.openid.auth.OpenIDConnectAuthenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin

public class OpenIDConnectAuthenticator
extends Object
implements NuxeoAuthenticationPlugin

Authenticator using OpenID to retrieve user identity

Author:

Nelson Silva

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE_URL_PARAM_NAME
static String	ERROR_URL_PARAM_NAME
static String	PROVIDER_URL_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
OpenIDConnectAuthenticator()

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.
UserIdentificationInfo	retrieveIdentityFromOAuth(HttpServletRequest req, HttpServletResponse resp)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CODE_URL_PARAM_NAME

public static final String CODE_URL_PARAM_NAME

See Also:

Constant Field Values

ERROR_URL_PARAM_NAME

public static final String ERROR_URL_PARAM_NAME

See Also:

Constant Field Values

PROVIDER_URL_PARAM_NAME

public static final String PROVIDER_URL_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

OpenIDConnectAuthenticator

public OpenIDConnectAuthenticator()

Method Detail

retrieveIdentityFromOAuth

public UserIdentificationInfo retrieveIdentityFromOAuth(HttpServletRequest req,
                                               HttpServletResponse resp)

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

handleRetrieveIdentity

public UserIdentificationInfo handleRetrieveIdentity(HttpServletRequest httpRequest,
                                            HttpServletResponse httpResponse)

Description copied from interface: NuxeoAuthenticationPlugin

Retrieves user identification information from the request.

Specified by:

handleRetrieveIdentity in interface NuxeoAuthenticationPlugin

Parameters:

httpRequest - the request

httpResponse - the response

handleLoginPrompt

public Boolean handleLoginPrompt(HttpServletRequest httpRequest,
                        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

needLoginPrompt

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

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