org.pac4j.vertx.handlers

Class SessionAwareHandler

java.lang.Object

org.pac4j.vertx.handlers.SessionAwareHandler

All Implemented Interfaces:

org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest>

Direct Known Subclasses:

LogoutHandler, RequiresAuthenticationHandler

public abstract class SessionAwareHandler
extends Object
implements org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest>

Wrapper handler providing all session attributes for the next handler in the chain.

This handler uses the sessionHelper from campudus for session creation, attributes saving and retrieval. It is the next handler responsibility to save the updated session attributes by calling the saveSessionAttributes method.

The stateless field indicates wether we should really relies on a session management system:

• stateless = false requires a valid sessionHelper and a deployed session manager module
• stateless = true does not require any sessionHelper neither a session manager module

Since:

1.0.0

Author:

Michael Remond

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionHelper	sessionHelper

Constructor Summary

Constructors

Constructor and Description
SessionAwareHandler(boolean stateless)
SessionAwareHandler(SessionHelper sessionHelper)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doHandle(org.vertx.java.core.http.HttpServerRequest req, String sessionId, org.vertx.java.core.json.JsonObject sessionAttributes)
void	handle(org.vertx.java.core.http.HttpServerRequest req)
protected boolean	isStateless()
protected void	saveSessionAttributes(String sessionId, org.vertx.java.core.json.JsonObject sessionAttributes, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Methods inherited from class java.lang.Object

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

Field Detail

sessionHelper

protected SessionHelper sessionHelper

Constructor Detail

SessionAwareHandler

public SessionAwareHandler(boolean stateless)

SessionAwareHandler

public SessionAwareHandler(SessionHelper sessionHelper)

Method Detail

handle

public void handle(org.vertx.java.core.http.HttpServerRequest req)

Specified by:

handle in interface org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest>

saveSessionAttributes

protected void saveSessionAttributes(String sessionId,
                                     org.vertx.java.core.json.JsonObject sessionAttributes,
                                     org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

isStateless

protected boolean isStateless()

doHandle

protected abstract void doHandle(org.vertx.java.core.http.HttpServerRequest req,
                                 String sessionId,
                                 org.vertx.java.core.json.JsonObject sessionAttributes)