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

Class PluggableAuthenticationService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService

public class PluggableAuthenticationService
extends DefaultComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	authChain
protected Map<String,NuxeoAuthenticationPlugin>	authenticators
static final String	EP_AUTHENTICATOR
static final String	EP_CHAIN
static final String	EP_LOGINSCREEN
static final String	EP_OPENURL
static final String	EP_SESSIONMANAGER
static final String	EP_SPECIFIC_CHAINS
static final String	EP_STARTURL
static final String	NAME
protected List<OpenUrlDescriptor>	openUrls
protected Map<String,NuxeoAuthenticationSessionManager>	sessionManagers
protected Map<String,SpecificAuthChainDescriptor>	specificAuthChains
protected List<String>	startupURLs

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
PluggableAuthenticationService()

Method Summary

Modifier and Type	Method	Description
boolean	canBypassRequest(jakarta.servlet.ServletRequest request)
boolean	doHandlePrompt(jakarta.servlet.http.HttpServletRequest request)
List<String>	getAuthChain()
List<String>	getAuthChain(jakarta.servlet.http.HttpServletRequest request)
Collection<NuxeoAuthenticationPlugin>	getAuthenticatorPlugins()
String	getBaseURL(jakarta.servlet.ServletRequest request)
AuthenticationPluginDescriptor	getDescriptor(String pluginName)
LoginScreenConfig	getLoginScreenConfig()
List<OpenUrlDescriptor>	getOpenUrls()
NuxeoAuthenticationPlugin	getPlugin(String pluginName)
List<NuxeoAuthenticationPlugin>	getPluginChain()
String	getSpecificAuthChainName(jakarta.servlet.http.HttpServletRequest request)
List<String>	getStartURLPatterns()
void	invalidateSession(jakarta.servlet.ServletRequest request)
boolean	needResetLogin(jakarta.servlet.ServletRequest request)
void	onAuthenticatedSessionCreated(jakarta.servlet.ServletRequest request, jakarta.servlet.http.HttpSession session, CachableUserIdentificationInfo cachebleUserInfo)
void	registerLoginScreenConfig(LoginScreenConfig config)
jakarta.servlet.http.HttpSession	reinitSession(jakarta.servlet.http.HttpServletRequest httpRequest)
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	unregisterLoginScreenConfig(LoginScreenConfig config)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

EP_AUTHENTICATOR

public static final String EP_AUTHENTICATOR

See Also:

• Constant Field Values

EP_SESSIONMANAGER

public static final String EP_SESSIONMANAGER

See Also:

• Constant Field Values

EP_CHAIN

public static final String EP_CHAIN

See Also:

• Constant Field Values

EP_SPECIFIC_CHAINS

public static final String EP_SPECIFIC_CHAINS

See Also:

• Constant Field Values

EP_STARTURL

public static final String EP_STARTURL

See Also:

• Constant Field Values

EP_OPENURL

public static final String EP_OPENURL

See Also:

• Constant Field Values

EP_LOGINSCREEN

public static final String EP_LOGINSCREEN

See Also:

• Constant Field Values

authenticators

protected Map<String,NuxeoAuthenticationPlugin> authenticators

sessionManagers

protected Map<String,NuxeoAuthenticationSessionManager> sessionManagers

authChain

protected List<String> authChain

specificAuthChains

protected Map<String,SpecificAuthChainDescriptor> specificAuthChains

openUrls

protected List<OpenUrlDescriptor> openUrls

startupURLs

protected List<String> startupURLs

Constructor Details

PluggableAuthenticationService

public PluggableAuthenticationService()

Method Details

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)
          throws InterruptedException

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

Throws:

InterruptedException

getStartURLPatterns

public List<String> getStartURLPatterns()

getAuthChain

public List<String> getAuthChain()

getAuthChain

public List<String> getAuthChain(jakarta.servlet.http.HttpServletRequest request)

doHandlePrompt

public boolean doHandlePrompt(jakarta.servlet.http.HttpServletRequest request)

getSpecificAuthChainName

public String getSpecificAuthChainName(jakarta.servlet.http.HttpServletRequest request)

getAuthenticatorPlugins

public Collection<NuxeoAuthenticationPlugin> getAuthenticatorPlugins()

Returns:

all plugins contributed to the authenticators extension point

Since:

2025.7

getPluginChain

public List<NuxeoAuthenticationPlugin> getPluginChain()

getPlugin

public NuxeoAuthenticationPlugin getPlugin(String pluginName)

getDescriptor

public AuthenticationPluginDescriptor getDescriptor(String pluginName)

invalidateSession

public void invalidateSession(jakarta.servlet.ServletRequest request)

reinitSession

public jakarta.servlet.http.HttpSession reinitSession(jakarta.servlet.http.HttpServletRequest httpRequest)

canBypassRequest

public boolean canBypassRequest(jakarta.servlet.ServletRequest request)

needResetLogin

public boolean needResetLogin(jakarta.servlet.ServletRequest request)

getBaseURL

public String getBaseURL(jakarta.servlet.ServletRequest request)

onAuthenticatedSessionCreated

public void onAuthenticatedSessionCreated(jakarta.servlet.ServletRequest request,
 jakarta.servlet.http.HttpSession session,
 CachableUserIdentificationInfo cachebleUserInfo)

getOpenUrls

public List<OpenUrlDescriptor> getOpenUrls()

getLoginScreenConfig

public LoginScreenConfig getLoginScreenConfig()

registerLoginScreenConfig

public void registerLoginScreenConfig(LoginScreenConfig config)

Since:

10.10

unregisterLoginScreenConfig

public void unregisterLoginScreenConfig(LoginScreenConfig config)

Since:

10.10