ej.hoka.auth.session

Class AuthenticatedRequestHandler

java.lang.Object

ej.hoka.http.requesthandler.RequestHandlerComposite

ej.hoka.auth.session.AuthenticatedRequestHandler

All Implemented Interfaces:

RequestHandler

Direct Known Subclasses:

RestAuthenticatedRequestHandler

public class AuthenticatedRequestHandler
extends RequestHandlerComposite

A request handler that requires the user to be authenticated using cookie-based sessions to access the sub-handlers.

See Also:

LoginEndpoint, LogoutEndpoint

Constructor Summary

Constructors

Constructor and Description
AuthenticatedRequestHandler(SessionAuthenticator authenticator, java.lang.String root) Constructs the request handler.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRoot() Gets the root of this handler.
protected java.lang.String	getSessionID(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Retrieves the session ID from the cookies of the request.
protected boolean	match(HTTPRequest request) Determines whether or not the request matches this handler.
protected HTTPResponse	onFailedAuthentication(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Constructs the response upon failed authentication.
protected HTTPResponse	onSuccessfulAuthentication(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.String username, java.lang.String sessionID) Constructs the response upon successful authentication.
HTTPResponse	process(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Processes the request and creates the appropriate response, or null if this request handler doesn't match the request.

Methods inherited from class ej.hoka.http.requesthandler.RequestHandlerComposite

addRequestHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedRequestHandler

public AuthenticatedRequestHandler(SessionAuthenticator authenticator,
                                   java.lang.String root)

Constructs the request handler.

Parameters:

authenticator - the SessionAuthenticator used to authenticate users.

root - the URI root used to match the request.

Method Detail

getRoot

public java.lang.String getRoot()

Gets the root of this handler.

Returns:

the root.

process

public HTTPResponse process(HTTPRequest request,
                            java.util.Map<java.lang.String,java.lang.String> attributes)

Description copied from interface: RequestHandler

Processes the request and creates the appropriate response, or null if this request handler doesn't match the request.

Specified by:

process in interface RequestHandler

Overrides:

process in class RequestHandlerComposite

Parameters:

request - the HTTPRequest to process.

attributes - the attributes of the request.

Returns:

the HTTPResponse to send, or null if not handled by this RequestHandler.

match

protected boolean match(HTTPRequest request)

Determines whether or not the request matches this handler.

The handler matches requests to URIs prefixed by the root path. Override this method to change the behavior.

Parameters:

request - the request to match.

Returns:

truetrue if the request matches this handler, false otherwise.

getSessionID

protected java.lang.String getSessionID(HTTPRequest request,
                                        java.util.Map<java.lang.String,java.lang.String> attributes)

Retrieves the session ID from the cookies of the request.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the session ID.

onSuccessfulAuthentication

protected HTTPResponse onSuccessfulAuthentication(HTTPRequest request,
                                                  java.util.Map<java.lang.String,java.lang.String> attributes,
                                                  java.lang.String username,
                                                  java.lang.String sessionID)

Constructs the response upon successful authentication.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

username - the username of the authenticated user.

sessionID - the ID of the session.

Returns:

the response to send.

onFailedAuthentication

protected HTTPResponse onFailedAuthentication(HTTPRequest request,
                                              java.util.Map<java.lang.String,java.lang.String> attributes)

Constructs the response upon failed authentication.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the response to send.