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

Class RemoteUserAuthenticatorFactory.RemoteUserAuthenticator

java.lang.Object

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

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

All Implemented Interfaces:

org.springframework.extensions.webscripts.Authenticator

Direct Known Subclasses:

PublicApiAuthenticatorFactory.PublicApiAuthenticator

Enclosing class:

RemoteUserAuthenticatorFactory

public class RemoteUserAuthenticatorFactory.RemoteUserAuthenticator
extends BasicHttpAuthenticatorFactory.BasicHttpAuthenticator

Remote User authenticator - adds header authentication onto Basic Auth. Stateless does not require Session.

Author:

Kevin Roast

Field Summary

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

authorization, listener, servletReq, servletRes, ticket

Constructor Summary

Constructors

Constructor	Description
RemoteUserAuthenticator(org.springframework.extensions.webscripts.servlet.WebScriptServletRequest req, org.springframework.extensions.webscripts.servlet.WebScriptServletResponse res, AuthenticationListener listener)

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(org.springframework.extensions.webscripts.Description.RequiredAuthentication required, boolean isGuest)
protected String	getAdminConsoleUser()
protected String	getRemoteUser()	Retrieve the remote user from servlet request header when using a secure connection.
protected String	getRemoteUserWithTimeout(boolean useTimeout)
protected String	getWebScriptsHomeUser()
protected boolean	isAdminConsole(org.springframework.extensions.webscripts.WebScript webScript)
protected boolean	isWebScriptsHome(org.springframework.extensions.webscripts.WebScript webScript)

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

emptyCredentials, isBasicAuthHeaderPresentForAdmin

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteUserAuthenticator

public RemoteUserAuthenticator(org.springframework.extensions.webscripts.servlet.WebScriptServletRequest req,
 org.springframework.extensions.webscripts.servlet.WebScriptServletResponse res,
 AuthenticationListener listener)

Method Details

authenticate

public boolean authenticate(org.springframework.extensions.webscripts.Description.RequiredAuthentication required,
 boolean isGuest)

Specified by:

authenticate in interface org.springframework.extensions.webscripts.Authenticator

Overrides:

authenticate in class BasicHttpAuthenticatorFactory.BasicHttpAuthenticator

isAdminConsole

protected boolean isAdminConsole(org.springframework.extensions.webscripts.WebScript webScript)

isWebScriptsHome

protected boolean isWebScriptsHome(org.springframework.extensions.webscripts.WebScript webScript)

getRemoteUserWithTimeout

protected String getRemoteUserWithTimeout(boolean useTimeout)
                                   throws org.alfresco.repo.web.scripts.servlet.AuthenticationTimeoutException

Throws:

org.alfresco.repo.web.scripts.servlet.AuthenticationTimeoutException

getRemoteUser

protected String getRemoteUser()

Retrieve the remote user from servlet request header when using a secure connection. The RemoteUserMapper bean must be active and configured.

Returns:

remote user ID or null if not active or found

getAdminConsoleUser

protected String getAdminConsoleUser()

getWebScriptsHomeUser

protected String getWebScriptsHomeUser()