org.esigate.authentication

Class GenericAuthentificationHandler

java.lang.Object

org.esigate.authentication.GenericAuthentificationHandler

All Implemented Interfaces:

IEventListener, Extension

Direct Known Subclasses:

RemoteUserAuthenticationHandler, RequestAuthenticationHandler

public abstract class GenericAuthentificationHandler
extends Object
implements IEventListener, Extension

This class is an adapter from the old ESIgate 2.X/3.X API used for AuthentificationHandlers to the new extension systems.

The following events are mapped on init :

• EventManager.EVENT_PROXY_PRE is mapped to beforeProxy(HttpRequest)
• EventManager.EVENT_FRAGMENT_PRE is mapped to preRequest(OutgoingRequest, IncomingRequest)
• EventManager.EVENT_FRAGMENT_POST is mapped to needsNewRequest(HttpResponse, OutgoingRequest, IncomingRequest)

To update an old AuthentificationHandler :

• Remote "implements AuthentificationHandler" from class definition
• Add "extends GenericAuthentificationHandler" to class definition

Author:

Nicolas Richeton

Constructor Summary

Constructors

Constructor and Description
GenericAuthentificationHandler()

Method Summary

Modifier and Type	Method and Description
abstract 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.
boolean	event(EventDefinition id, Event event) Handle an event.
Driver	getDriver()
void	init(Driver d, Properties properties) Initialize the extension using the given properties.
abstract void	init(Properties properties)
abstract boolean	needsNewRequest(org.apache.http.HttpResponse response, OutgoingRequest outgoingRequest, IncomingRequest incomingRequest) Method called after the response has been obtained from the destination server.
abstract void	preRequest(OutgoingRequest outgoingRequest, IncomingRequest incomingRequest) Method called before sending a request to the destination server.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericAuthentificationHandler

public GenericAuthentificationHandler()

Method Detail

beforeProxy

public abstract 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. If so the method must return false in order to stop further processing.

Parameters:

httpRequest - the incoming request

Returns:

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

preRequest

public abstract void preRequest(OutgoingRequest outgoingRequest,
                                IncomingRequest incomingRequest)

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

Parameters:

outgoingRequest -

incomingRequest -

needsNewRequest

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

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.

Parameters:

response -

outgoingRequest -

incomingRequest -

Returns:

true if a new request is needed

init

public final void init(Driver d,
                       Properties properties)

Description copied from interface: Extension

Initialize the extension using the given properties.

Extensions may register to events during the init phase.

Specified by:

init in interface Extension

init

public abstract void init(Properties properties)

event

public boolean event(EventDefinition id,
                     Event event)

Description copied from interface: IEventListener

Handle an event.

Specified by:

event in interface IEventListener

Returns:

false to stop the processing of event listeners for this event

getDriver

public Driver getDriver()