Package org.nuxeo.ecm.platform.ui.web.auth.plugins

Class BasicAuthenticator

java.lang.Object

org.nuxeo.ecm.platform.ui.web.auth.plugins.BasicAuthenticator

All Implemented Interfaces:

NuxeoAuthenticationPlugin

public class BasicAuthenticator
extends Object
implements NuxeoAuthenticationPlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTO_PROMPT_KEY
protected Boolean	autoPrompt
protected static final String	BA_HEADER_NAME
protected static final String	DEFAULT_REALMNAME
protected static final String	EXCLUDE_URL_KEY
protected static final String	FORCE_PROMPT_KEY
protected List<String>	forcePromptURLs
protected static final String	PROMPT_URL_KEY
protected static final String	REALM_NAME_KEY
protected String	realName

Constructor Summary

Constructors

Constructor	Description
BasicAuthenticator()

Method Summary

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(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse, String baseURL)	Handles the Login Prompt.
UserIdentificationInfo	handleRetrieveIdentity(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.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(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

REALM_NAME_KEY

protected static final String REALM_NAME_KEY

See Also:

• Constant Field Values

FORCE_PROMPT_KEY

protected static final String FORCE_PROMPT_KEY

See Also:

• Constant Field Values

AUTO_PROMPT_KEY

protected static final String AUTO_PROMPT_KEY

See Also:

• Constant Field Values

PROMPT_URL_KEY

protected static final String PROMPT_URL_KEY

See Also:

• Constant Field Values

DEFAULT_REALMNAME

protected static final String DEFAULT_REALMNAME

See Also:

• Constant Field Values

BA_HEADER_NAME

protected static final String BA_HEADER_NAME

See Also:

• Constant Field Values

EXCLUDE_URL_KEY

protected static final String EXCLUDE_URL_KEY

See Also:

• Constant Field Values

realName

protected String realName

autoPrompt

protected Boolean autoPrompt

forcePromptURLs

protected List<String> forcePromptURLs

Constructor Details

BasicAuthenticator

public BasicAuthenticator()

Method Details

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 httpRequest,
 jakarta.servlet.http.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

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

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