Package org.alfresco.repo.web.scripts.servlet

Class RemoteUserAuthenticatorFactory

java.lang.Object

org.alfresco.repo.web.scripts.servlet.BasicHttpAuthenticatorFactory

org.alfresco.repo.web.scripts.servlet.RemoteUserAuthenticatorFactory

All Implemented Interfaces:

org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory

Direct Known Subclasses:

PublicApiAuthenticatorFactory

public class RemoteUserAuthenticatorFactory
extends BasicHttpAuthenticatorFactory

Authenticator to provide Remote User based Header authentication dropping back to Basic Auth otherwise. Statelessly authenticating via a secure header now does not require a Session so can be used with request-level load balancers which was not previously possible.

Since:

5.1

Author:

Kevin Roast

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RemoteUserAuthenticatorFactory.RemoteUserAuthenticator	Remote User authenticator - adds header authentication onto Basic Auth.

Nested classes/interfaces inherited from class org.alfresco.repo.web.scripts.servlet.BasicHttpAuthenticatorFactory

BasicHttpAuthenticatorFactory.BasicHttpAuthenticator

Field Summary

Fields

Modifier and Type	Field	Description
protected ExternalUserAuthenticator	adminConsoleAuthenticator
protected AuthenticationComponent	authenticationComponent
static final long	GET_REMOTE_USER_TIMEOUT_MILLISECONDS_DEFAULT
protected RemoteUserMapper	remoteUserMapper
protected ExternalUserAuthenticator	webScriptsHomeAuthenticator

Fields inherited from class org.alfresco.repo.web.scripts.servlet.BasicHttpAuthenticatorFactory

authenticationService, authorityService, listener

Constructor Summary

Constructors

Constructor	Description
RemoteUserAuthenticatorFactory()

Method Summary

Modifier and Type	Method	Description
org.springframework.extensions.webscripts.Authenticator	create(org.springframework.extensions.webscripts.servlet.WebScriptServletRequest req, org.springframework.extensions.webscripts.servlet.WebScriptServletResponse res)
List<String>	getAdminConsoleScriptFamilies()
long	getGetRemoteUserTimeoutMilliseconds()
boolean	isAlwaysAllowBasicAuthForAdminConsole()
boolean	isAlwaysAllowBasicAuthForWebScriptsHome()
void	setAdminConsoleAuthenticator(ExternalUserAuthenticator adminConsoleAuthenticator)
void	setAdminConsoleScriptFamilies(List<String> adminConsoleScriptFamilies)
void	setAlwaysAllowBasicAuthForAdminConsole(boolean alwaysAllowBasicAuthForAdminConsole)
void	setAlwaysAllowBasicAuthForWebScriptsHome(boolean alwaysAllowBasicAuthForWebScriptsHome)
void	setAuthenticationComponent(AuthenticationComponent authenticationComponent)
void	setGetRemoteUserTimeoutMilliseconds(long getRemoteUserTimeoutMilliseconds)
void	setRemoteUserMapper(RemoteUserMapper remoteUserMapper)
void	setWebScriptsHomeAuthenticator(ExternalUserAuthenticator webScriptsHomeAuthenticator)

Methods inherited from class org.alfresco.repo.web.scripts.servlet.BasicHttpAuthenticatorFactory

getAuthorityService, setAuthenticationListener, setAuthenticationService, setAuthorityService

Methods inherited from class java.lang.Object

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

Field Details

GET_REMOTE_USER_TIMEOUT_MILLISECONDS_DEFAULT

public static final long GET_REMOTE_USER_TIMEOUT_MILLISECONDS_DEFAULT

See Also:

• Constant Field Values

remoteUserMapper

protected RemoteUserMapper remoteUserMapper

authenticationComponent

protected AuthenticationComponent authenticationComponent

adminConsoleAuthenticator

protected ExternalUserAuthenticator adminConsoleAuthenticator

webScriptsHomeAuthenticator

protected ExternalUserAuthenticator webScriptsHomeAuthenticator

Constructor Details

RemoteUserAuthenticatorFactory

public RemoteUserAuthenticatorFactory()

Method Details

setRemoteUserMapper

public void setRemoteUserMapper(RemoteUserMapper remoteUserMapper)

setAuthenticationComponent

public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)

isAlwaysAllowBasicAuthForAdminConsole

public boolean isAlwaysAllowBasicAuthForAdminConsole()

setAlwaysAllowBasicAuthForAdminConsole

public void setAlwaysAllowBasicAuthForAdminConsole(boolean alwaysAllowBasicAuthForAdminConsole)

isAlwaysAllowBasicAuthForWebScriptsHome

public boolean isAlwaysAllowBasicAuthForWebScriptsHome()

setAlwaysAllowBasicAuthForWebScriptsHome

public void setAlwaysAllowBasicAuthForWebScriptsHome(boolean alwaysAllowBasicAuthForWebScriptsHome)

getAdminConsoleScriptFamilies

public List<String> getAdminConsoleScriptFamilies()

setAdminConsoleScriptFamilies

public void setAdminConsoleScriptFamilies(List<String> adminConsoleScriptFamilies)

getGetRemoteUserTimeoutMilliseconds

public long getGetRemoteUserTimeoutMilliseconds()

setGetRemoteUserTimeoutMilliseconds

public void setGetRemoteUserTimeoutMilliseconds(long getRemoteUserTimeoutMilliseconds)

setAdminConsoleAuthenticator

public void setAdminConsoleAuthenticator(ExternalUserAuthenticator adminConsoleAuthenticator)

setWebScriptsHomeAuthenticator

public void setWebScriptsHomeAuthenticator(ExternalUserAuthenticator webScriptsHomeAuthenticator)

create

public org.springframework.extensions.webscripts.Authenticator create(org.springframework.extensions.webscripts.servlet.WebScriptServletRequest req,
 org.springframework.extensions.webscripts.servlet.WebScriptServletResponse res)

Specified by:

create in interface org.springframework.extensions.webscripts.servlet.ServletAuthenticatorFactory

Overrides:

create in class BasicHttpAuthenticatorFactory