Package io.vertx.reactivex.ext.web.sstore.cookie

Class CookieSessionStore

java.lang.Object

io.vertx.reactivex.ext.web.sstore.SessionStore

io.vertx.reactivex.ext.web.sstore.cookie.CookieSessionStore

public class 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.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<CookieSessionStore>	__TYPE_ARG
static int	DEFAULT_SESSIONID_LENGTH	Default length for a session id.

Constructor Summary

Constructors

Constructor	Description
CookieSessionStore(io.vertx.ext.web.sstore.cookie.CookieSessionStore delegate)
CookieSessionStore(Object delegate)

Method Summary

Modifier and Type	Method	Description
static CookieSessionStore	create(Vertx vertx, String secret)	Creates a CookieSessionStore.
boolean	equals(Object o)
io.vertx.ext.web.sstore.cookie.CookieSessionStore	getDelegate()
int	hashCode()
static CookieSessionStore	newInstance(io.vertx.ext.web.sstore.cookie.CookieSessionStore arg)
String	toString()

Methods inherited from class io.vertx.reactivex.ext.web.sstore.SessionStore

clear, clear, close, create, create, createSession, createSession, delete, delete, get, get, init, newInstance, put, put, retryTimeout, rxClear, rxDelete, rxGet, rxPut, rxSize, size, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<CookieSessionStore> __TYPE_ARG

DEFAULT_SESSIONID_LENGTH

public static final int DEFAULT_SESSIONID_LENGTH

Default length for a session id. More info: https://www.owasp.org/index.php/Session_Management_Cheat_Sheet

See Also:

Constant Field Values

Constructor Detail

CookieSessionStore

public CookieSessionStore(io.vertx.ext.web.sstore.cookie.CookieSessionStore delegate)

CookieSessionStore

public CookieSessionStore(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class SessionStore

equals

public boolean equals(Object o)

Overrides:

equals in class SessionStore

hashCode

public int hashCode()

Overrides:

hashCode in class SessionStore

getDelegate

public io.vertx.ext.web.sstore.cookie.CookieSessionStore getDelegate()

Overrides:

getDelegate in class SessionStore

create

public 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

newInstance

public static CookieSessionStore newInstance(io.vertx.ext.web.sstore.cookie.CookieSessionStore arg)