io.vertx.ext.web.sstore.cookie

Interface CookieSessionStore

All Superinterfaces:

SessionStore

public interface CookieSessionStore
extends SessionStore

A SessionStore that uses a Cookie to store the session data. All data is stored in plain sight and signed using a HMAC using the given secret. The signature ensures that the cookie payload is not tampered when returning from the user agent (browser) back to the server.

Author:

Paulo Lopes

Field Summary

Fields inherited from interface io.vertx.ext.web.sstore.SessionStore

DEFAULT_SESSIONID_LENGTH

Method Summary

Modifier and Type	Method and Description
static CookieSessionStore	create(Vertx vertx, String secret) Creates a CookieSessionStore.

Methods inherited from interface io.vertx.ext.web.sstore.SessionStore

clear, clear, close, create, create, createSession, createSession, delete, delete, get, get, init, put, put, retryTimeout, size, size

Method Detail

create

static CookieSessionStore create(Vertx vertx,
                                 String secret)

Creates a CookieSessionStore. Cookie data will be signed using the given secret. The secret as the name reflects, should never leave the server, otherwise user agents could tamper with the payload.

Parameters:

vertx - a vert.x instance

secret - a secret to feed the HMAC algorithm

Returns:

the store