com.campudus.vertx.sessionmanager.java

Class SessionHelper

java.lang.Object

com.campudus.vertx.sessionmanager.java.SessionHelper

public class SessionHelper
extends Object

This Java wrapper class helps using the session manager from Java. It provides useful functions to handle storing and retrieving session data more easily.

Author:

Joern Bernhardt This class was modified for Vertx 2.1 and some methods were added.

Constructor Summary

Constructors

Constructor and Description
SessionHelper(org.vertx.java.core.Vertx vertx) Creates a session helper for this Vertx instance.
SessionHelper(org.vertx.java.core.Vertx vertx, String sessionManagerAddress) Creates a session helper for this Vertx instance.
SessionHelper(org.vertx.java.core.Vertx vertx, String sessionManagerAddress, String cookieField, String cookiePath) Creates a session helper for this Vertx instance with a custom cookie field name.

Method Summary

Modifier and Type	Method and Description
void	checkAllSessionsForMatch(org.vertx.java.core.json.JsonObject json, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Checks all sessions for a potential match of the specified JsonObject and returns the reply of the session manager ({ matches : true/false, sessions: [...all matching sessions or empty JsonArray...] }).
void	destroySession(String sessionId, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Destroys a session and gives the result to a handler.
String	getSessionId(org.vertx.java.core.http.HttpServerRequest req)
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonObject obj) Puts multiple data fields into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonObject obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts multiple data fields into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, boolean obj) Puts a boolean into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, boolean obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a boolean into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, byte[] obj) Puts a byte array into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, byte[] obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a byte array into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, org.vertx.java.core.json.JsonArray obj) Puts a JsonArray into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, org.vertx.java.core.json.JsonArray obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a JsonArray into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, org.vertx.java.core.json.JsonObject obj) Puts a JsonObject into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, org.vertx.java.core.json.JsonObject obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a JsonObject into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, Number obj) Puts a number into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, Number obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a number into the session storage and retrieves the result of the storage operation.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, String obj) Puts a String into the session storage without need of the result.
void	putSessionData(org.vertx.java.core.http.HttpServerRequest req, String key, String obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a String into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, org.vertx.java.core.json.JsonObject obj) Puts multiple data fields into the session storage without need of the result.
void	putSessionData(String sessionId, org.vertx.java.core.json.JsonObject obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts multiple data fields into the session storage without need of the result.
void	putSessionData(String sessionId, String key, boolean obj) Puts a boolean into the session storage without need of the result.
void	putSessionData(String sessionId, String key, boolean obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a boolean into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, String key, byte[] obj) Puts a byte array into the session storage without need of the result.
void	putSessionData(String sessionId, String key, byte[] obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a byte array into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, String key, org.vertx.java.core.json.JsonArray obj) Puts a JsonArray into the session storage without need of the result.
void	putSessionData(String sessionId, String key, org.vertx.java.core.json.JsonArray obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a JsonArray into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, String key, org.vertx.java.core.json.JsonObject obj) Puts a JsonObject into the session storage without need of the result.
void	putSessionData(String sessionId, String key, org.vertx.java.core.json.JsonObject obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a JsonObject into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, String key, Number obj) Puts a number into the session storage without need of the result.
void	putSessionData(String sessionId, String key, Number obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a number into the session storage and retrieves the result of the storage operation.
void	putSessionData(String sessionId, String key, String obj) Puts a String into the session storage without need of the result.
void	putSessionData(String sessionId, String key, String obj, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler) Puts a String into the session storage and retrieves the result of the storage operation.
void	startSession(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.Handler<String> handlerWithSessionId) Creates a new session for the specified request.
void	withConnectionStats(org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) Gets informations about open sessions and delivers this info to the specified handler.
void	withSessionData(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.json.JsonArray requiredFields, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) Gets multiple data fields from the session storage by using an HttpServerRequest.
void	withSessionData(org.vertx.java.core.http.HttpServerRequest req, String requiredField, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) Gets a single data field from the session storage by using an HttpServerRequest.
void	withSessionData(String sessionId, org.vertx.java.core.json.JsonArray requiredFields, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) Gets multiple data fields from the session storage by using a session id.
void	withSessionData(String sessionId, String requiredField, org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler) Gets a single data field from the session storage by using a session id.
void	withSessionId(org.vertx.java.core.http.HttpServerRequest req, org.vertx.java.core.Handler<String> handler) Does something with a session id.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionHelper

public SessionHelper(org.vertx.java.core.Vertx vertx)

Creates a session helper for this Vertx instance.

Parameters:

vertx - The Vertx instance to use this session helper. The Vertx is used for the communication over the event bus.

SessionHelper

public SessionHelper(org.vertx.java.core.Vertx vertx,
                     String sessionManagerAddress)

Creates a session helper for this Vertx instance.

Parameters:

vertx - The Vertx instance to use this session helper. The Vertx is used for the communication over the event bus.

sessionManagerAddress - The address on which the session manager is listening on.

SessionHelper

public SessionHelper(org.vertx.java.core.Vertx vertx,
                     String sessionManagerAddress,
                     String cookieField,
                     String cookiePath)

Creates a session helper for this Vertx instance with a custom cookie field name.

Parameters:

vertx - The Vertx instance to use this session helper. The Vertx is used for the communication over the event bus.

sessionManagerAddress - The address on which the session manager is listening on.

cookieField - The name of the generated field in the cookie for the client.

cookiePath - the path of the cookie

Method Detail

withSessionData

public void withSessionData(org.vertx.java.core.http.HttpServerRequest req,
                            String requiredField,
                            org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Gets a single data field from the session storage by using an HttpServerRequest.

Parameters:

req - The http server request.

requiredField - The wanted field from the session storage.

handler - A handler for the received data.

withSessionData

public void withSessionData(org.vertx.java.core.http.HttpServerRequest req,
                            org.vertx.java.core.json.JsonArray requiredFields,
                            org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Gets multiple data fields from the session storage by using an HttpServerRequest.

Parameters:

req - The http server request.

requiredFields - The wanted fields from the session storage.

handler - A handler A handler for the received data.

withSessionData

public void withSessionData(String sessionId,
                            String requiredField,
                            org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Gets a single data field from the session storage by using a session id.

Parameters:

sessionId - The id of the session.

requiredField - The wanted field from the session storage.

handler - A handler for the received data.

withSessionData

public void withSessionData(String sessionId,
                            org.vertx.java.core.json.JsonArray requiredFields,
                            org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Gets multiple data fields from the session storage by using a session id.

Parameters:

sessionId - The id of the session.

requiredFields - The wanted fields from the session storage.

handler - A handler for the received data.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           org.vertx.java.core.json.JsonObject obj)

Puts multiple data fields into the session storage without need of the result.

Parameters:

req - The http server request.

obj - A JsonObject which provides key-value pairs.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           org.vertx.java.core.json.JsonArray obj)

Puts a JsonArray into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The JsonArray to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           byte[] obj)

Puts a byte array into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The byte array to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           boolean obj)

Puts a boolean into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The boolean to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           Number obj)

Puts a number into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The number to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           org.vertx.java.core.json.JsonObject obj)

Puts a JsonObject into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The JsonObject to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           String obj)

Puts a String into the session storage without need of the result.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The String to store.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           org.vertx.java.core.json.JsonObject obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts multiple data fields into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

obj - A JsonObject which includes key-value pairs to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           org.vertx.java.core.json.JsonArray obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a JsonArray into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The JsonArray to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           byte[] obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a byte array into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The byte array to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           boolean obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a boolean into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The boolean to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           Number obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a number into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The number to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           org.vertx.java.core.json.JsonObject obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a JsonObject into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The JsonObject to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(org.vertx.java.core.http.HttpServerRequest req,
                           String key,
                           String obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a String into the session storage and retrieves the result of the storage operation.

Parameters:

req - The http server request.

key - The name of the field to put data into.

obj - The String to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           org.vertx.java.core.json.JsonObject obj)

Puts multiple data fields into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

obj - A JsonObject which provides key-value pairs.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           org.vertx.java.core.json.JsonArray obj)

Puts a JsonArray into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonArray to store.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           byte[] obj)

Puts a byte array into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The byte array to store.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           boolean obj)

Puts a boolean into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonArray to store.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           Number obj)

Puts a number into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The number to store.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           org.vertx.java.core.json.JsonObject obj)

Puts a JsonObject into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonObject to store.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           String obj)

Puts a String into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The String to store.

putSessionData

public void putSessionData(String sessionId,
                           org.vertx.java.core.json.JsonObject obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts multiple data fields into the session storage without need of the result.

Parameters:

sessionId - The id of the session.

obj - A JsonObject which provides key-value pairs.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           org.vertx.java.core.json.JsonArray obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a JsonArray into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonArray to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           byte[] obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a byte array into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The byte array to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           boolean obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a boolean into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonArray to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           Number obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a number into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The number to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           org.vertx.java.core.json.JsonObject obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a JsonObject into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The JsonObject to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

putSessionData

public void putSessionData(String sessionId,
                           String key,
                           String obj,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Puts a String into the session storage and retrieves the result of the storage operation.

Parameters:

sessionId - The id of the session.

key - The name of the field to put data into.

obj - The String to store.

doneHandler - The handler to call after storing finished. It will receive the message sent by the session manager.

withSessionId

public void withSessionId(org.vertx.java.core.http.HttpServerRequest req,
                          org.vertx.java.core.Handler<String> handler)

Does something with a session id. It will use the session id provided by the client inside the http server request. If it cannot find it, it will create a new session.

Parameters:

req - The http server request.

handler - The handler to call with the created or found session id.

getSessionId

public String getSessionId(org.vertx.java.core.http.HttpServerRequest req)

startSession

public void startSession(org.vertx.java.core.http.HttpServerRequest req,
                         org.vertx.java.core.Handler<String> handlerWithSessionId)

Creates a new session for the specified request. It will provide the newly created session id as a cookie.

Parameters:

req - The http server request, i.e. client, to create a session for.

handlerWithSessionId - A handler to use the created session id with.

destroySession

public void destroySession(String sessionId,
                           org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Destroys a session and gives the result to a handler.

Parameters:

sessionId - The id of the session to destroy.

doneHandler - The handler to call with the result of the session manager.

checkAllSessionsForMatch

public void checkAllSessionsForMatch(org.vertx.java.core.json.JsonObject json,
                                     org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> doneHandler)

Checks all sessions for a potential match of the specified JsonObject and returns the reply of the session manager ({ matches : true/false, sessions: [...all matching sessions or empty JsonArray...] }).

Parameters:

json - The JsonObject to check against all sessions.

doneHandler - Handles the result of the session manager.

withConnectionStats

public void withConnectionStats(org.vertx.java.core.Handler<org.vertx.java.core.json.JsonObject> handler)

Gets informations about open sessions and delivers this info to the specified handler.

Parameters:

handler - The handler to call after getting the results of the connections report.