org.esigate.authentication

Class RemoteUserAuthenticationHandler

java.lang.Object

org.esigate.authentication.GenericAuthentificationHandler

org.esigate.authentication.RemoteUserAuthenticationHandler

All Implemented Interfaces:

IEventListener, Extension

public class RemoteUserAuthenticationHandler
extends GenericAuthentificationHandler

AuthenticationHandler implementation that retrieves the user passed by the servlet container or set manually into the RequestContext and transmits it as a HTTP header X_REMOTE_USER in all requests.

Author:

Francois-Xavier Bonnet

Constructor Summary

Constructors

Constructor and Description
RemoteUserAuthenticationHandler()

Method Summary

Modifier and Type	Method and Description
boolean	beforeProxy(org.apache.http.HttpRequest httpRequest) Method called before proxying a request This method can ask the users credentials by sending an authentication page or a 401 code or redirect to a login page.
void	init(Properties properties)
boolean	needsNewRequest(org.apache.http.HttpResponse response, OutgoingRequest outgoingRequest, IncomingRequest incomingRequest) Method called after the response has been obtained from the destination server.
void	preRequest(OutgoingRequest outgoingRequest, IncomingRequest incomingRequest) Method called before sending a request to the destination server.

Methods inherited from class org.esigate.authentication.GenericAuthentificationHandler

event, getDriver, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteUserAuthenticationHandler

public RemoteUserAuthenticationHandler()

Method Detail

needsNewRequest

public boolean needsNewRequest(org.apache.http.HttpResponse response,
                               OutgoingRequest outgoingRequest,
                               IncomingRequest incomingRequest)

Description copied from class: GenericAuthentificationHandler

Method called after the response has been obtained from the destination server. This method can be used to ask for a new request if the destination server uses a challenge-based authentication mechanism with an arbitrary number of steps.

Specified by:

needsNewRequest in class GenericAuthentificationHandler

Returns:

true if a new request is needed

preRequest

public void preRequest(OutgoingRequest outgoingRequest,
                       IncomingRequest incomingRequest)

Description copied from class: GenericAuthentificationHandler

Method called before sending a request to the destination server. This method can be used to add user credentials to the request

Specified by:

preRequest in class GenericAuthentificationHandler

init

public void init(Properties properties)

Specified by:

init in class GenericAuthentificationHandler

beforeProxy

public boolean beforeProxy(org.apache.http.HttpRequest httpRequest)

Description copied from class: GenericAuthentificationHandler

Method called before proxying a request This method can ask the users credentials by sending an authentication page or a 401 code or redirect to a login page. If so the method must return false in order to stop further processing.

Specified by:

beforeProxy in class GenericAuthentificationHandler

Parameters:

httpRequest - the incoming request

Returns:

true if the processing must continue, false if the response has already been sent to the client.