C D E G H I J L M O P R S T

C

clear() - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.clear().

clear() - Method in interface ratpack.session.SessionData

Remove all entries from the session data.

ClientSideSessionConfig - Class in ratpack.session.clientside

Client side session configuration.

ClientSideSessionConfig() - Constructor for class ratpack.session.clientside.ClientSideSessionConfig

ClientSideSessionModule - Class in ratpack.session.clientside

An extension module that provides a client side session store - cookie based.

ClientSideSessionModule() - Constructor for class ratpack.session.clientside.ClientSideSessionModule

configure() - Method in class ratpack.session.clientside.ClientSideSessionModule

configure() - Method in class ratpack.session.SessionModule

Crypto - Interface in ratpack.session.clientside

D

decrypt(ByteBuf, ByteBufAllocator) - Method in interface ratpack.session.clientside.Crypto

deserialize(Class<T>, InputStream) - Method in interface ratpack.session.SessionSerializer

Reads the bytes of the given input stream, creating a new object.

domain(String) - Method in class ratpack.session.SessionCookieConfig

Set the domain for session cookie.

E

encrypt(ByteBuf, ByteBufAllocator) - Method in interface ratpack.session.clientside.Crypto

expires(Duration) - Method in class ratpack.session.SessionCookieConfig

Set max age of the cookies related to session management.

G

generateSessionId() - Method in interface ratpack.session.SessionIdGenerator

Generates a new identifier to be used as a session id.

get(SessionKey<T>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(SessionKey).

get(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(SessionKey, SessionSerializer).

get(String) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(String).

get(String, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(String, SessionSerializer).

get(Class<T>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(Class).

get(Class<T>, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.get(Class, SessionSerializer).

get(SessionKey<T>) - Method in interface ratpack.session.SessionData

Fetch the object with the given key, using the default serializer.

get(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.SessionData

Read the object with the given key.

get(String) - Method in interface ratpack.session.SessionData

Read the object with the given name, using the default serializer.

get(String, SessionSerializer) - Method in interface ratpack.session.SessionData

Read the object with the given name.

get(Class<T>) - Method in interface ratpack.session.SessionData

Read the object with the given type, and no name, using the default serializer.

get(Class<T>, SessionSerializer) - Method in interface ratpack.session.SessionData

Read the object with the given type, and no name.

getCipherAlgorithm() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The Cipher algorithm used to encrypt/decrypt the serialized session

getData() - Method in interface ratpack.session.Session

The session data.

getDefaultSerializer() - Method in interface ratpack.session.Session

The serializer that is used when a serializer is not explicitly given.

getDefaultSerializer() - Method in interface ratpack.session.SessionData

See Session.getDefaultSerializer().

getDomain() - Method in class ratpack.session.SessionCookieConfig

Use the session cookie only when requesting from the domain.

getExpires() - Method in class ratpack.session.SessionCookieConfig

Cookie's max age.

getId() - Method in interface ratpack.session.Session

The unique ID for this session.

getIdName() - Method in class ratpack.session.SessionCookieConfig

The name of the cookie for session id.

getJavaSerializer() - Method in interface ratpack.session.Session

The value serializer that is guaranteed to be able to serialize/deserialize any Java object that implements Serializable.

getJavaSerializer() - Method in interface ratpack.session.SessionData

See Session.getJavaSerializer().

getKeys() - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.getKeys().

getKeys() - Method in interface ratpack.session.SessionData

The keys of all objects currently in the session.

getLastAccessTimeCookieName() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The name of the cookie used to store session's last access time.

getMacAlgorithm() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The Mac algorithm used to sign the serialized session with the secretToken.

getMaxInactivityInterval() - Method in class ratpack.session.clientside.ClientSideSessionConfig

Maximum inactivity time (in units defined by TimeUnit) after which session will be invalidated.

getMaxSessionCookieSize() - Method in class ratpack.session.clientside.ClientSideSessionConfig

Maximum size of the session cookie.

getName() - Method in interface ratpack.session.SessionKey

The name.

getPath() - Method in class ratpack.session.SessionCookieConfig

Use the session cookie only when requesting from the path.

getSecretKey() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The secret key used in the symmetric-key encyrption/decryption of the serialized session.

getSecretToken() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The token used to sign the serialized session to prevent tampering.

getSession() - Method in interface ratpack.session.SessionData

The corresponding Session object.

getSessionCookieName() - Method in class ratpack.session.clientside.ClientSideSessionConfig

The name of the cookie used to store serialized and encrypted session data.

getType() - Method in interface ratpack.session.SessionKey

The type.

getValue() - Method in interface ratpack.session.SessionId

Get the session ID value, generating a new one if necessary.

H

httpOnly(boolean) - Method in class ratpack.session.SessionCookieConfig

Set session cookies attribute HttpOnly.

I

idName(String) - Method in class ratpack.session.SessionCookieConfig

Set the name of the cookie for session id.

isDirty() - Method in interface ratpack.session.Session

Whether or not any changes have been made to the session data since it was accessed.

isDirty() - Method in interface ratpack.session.SessionData

See Session.isDirty().

isHttpOnly() - Method in class ratpack.session.SessionCookieConfig

HttpOnly cookies can only be used when transmitted via HTTP/HTTPS.

isSecure() - Method in class ratpack.session.SessionCookieConfig

Secure cookies can only be transmitted over encrypted connection like HTTPS.

J

JavaSessionSerializer - Interface in ratpack.session

Marker interface for serializers that can serialize anything that is Serializable.

L

load(AsciiString) - Method in interface ratpack.session.SessionStore

Reads the session data for the given id.

LOCAL_MEMORY_SESSION_CACHE_BINDING_KEY - Static variable in class ratpack.session.SessionModule

The key of the binding for the Cache implementation that backs the in memory session store.

LOCAL_MEMORY_SESSION_CACHE_BINDING_NAME - Static variable in class ratpack.session.SessionModule

The name of the binding for the Cache implementation that backs the in memory session store.

M

memoryStore(Consumer<? super CacheBuilder<AsciiString, ByteBuf>>) - Static method in class ratpack.session.SessionModule

A builder for an alternative cache for the default in memory store.

memoryStore(Binder, Consumer<? super CacheBuilder<AsciiString, ByteBuf>>) - Static method in class ratpack.session.SessionModule

A builder for an alternative cache for the default in memory store.

O

of(Class<T>) - Static method in interface ratpack.session.SessionKey

Creates a key of the given type with no name.

of(String, Class<T>) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name and type.

of(String) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name with no type.

ofType(String, T) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name, and the type of the given object (as provided by Object.getClass()).

ofType(T) - Static method in interface ratpack.session.SessionKey

Creates a key of type of the given object (as provided by Object.getClass()), and no name.

P

path(String) - Method in class ratpack.session.SessionCookieConfig

Set the path for session cookie.

R

ratpack.session - package ratpack.session

Objects for providing Session support.

ratpack.session.clientside - package ratpack.session.clientside

Support for Client Side Session.

remove(SessionKey<?>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.remove(SessionKey).

remove(Class<?>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.remove(Class).

remove(String) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.remove(String).

remove(SessionKey<?>) - Method in interface ratpack.session.SessionData

Removes the object with the given key, if it exists.

remove(Class<?>) - Method in interface ratpack.session.SessionData

Removes the object with the given type and no name, if it exists.

remove(String) - Method in interface ratpack.session.SessionData

Removes the object with the name, if it exists.

remove(AsciiString) - Method in interface ratpack.session.SessionStore

Removes the session data for the given id.

require(SessionKey<T>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(SessionKey).

require(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(SessionKey, SessionSerializer).

require(Class<T>) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(Class).

require(Class<T>, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(Class, SessionSerializer).

require(String) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(String).

require(String, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.require(String, SessionSerializer).

require(SessionKey<T>) - Method in interface ratpack.session.SessionData

Like SessionData.get(SessionKey), but throws NoSuchElementException on the absence of a value.

require(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.SessionData

Like SessionData.get(SessionKey, SessionSerializer), but throws NoSuchElementException on the absence of a value.

require(Class<T>) - Method in interface ratpack.session.SessionData

Like SessionData.get(Class), but throws NoSuchElementException on the absence of a value.

require(Class<T>, SessionSerializer) - Method in interface ratpack.session.SessionData

Like SessionData.get(Class, SessionSerializer), but throws NoSuchElementException on the absence of a value.

require(String) - Method in interface ratpack.session.SessionData

Like SessionData.get(String), but throws NoSuchElementException on the absence of a value.

require(String, SessionSerializer) - Method in interface ratpack.session.SessionData

Like SessionData.get(String, SessionSerializer), but throws NoSuchElementException on the absence of a value.

S

save() - Method in interface ratpack.session.Session

Persists the session data.

save() - Method in interface ratpack.session.SessionData

See Session.save().

secure(boolean) - Method in class ratpack.session.SessionCookieConfig

Set session cookies attribute Secure.

serialize(Class<T>, T, OutputStream) - Method in interface ratpack.session.SessionSerializer

Writes the given value to the output stream as bytes.

Session - Interface in ratpack.session

A mechanism for associating semi persistent data with an individual user/client.

SessionCookieConfig - Class in ratpack.session

Basic configuration for cookies related to session management.

SessionCookieConfig() - Constructor for class ratpack.session.SessionCookieConfig

SessionData - Interface in ratpack.session

The data associated with the user session.

SessionId - Interface in ratpack.session

A handle to the session ID.

SessionIdGenerator - Interface in ratpack.session

Strategy interface for generating unique session ids.

SessionKey<T> - Interface in ratpack.session

A key for an object in the session.

SessionModule - Class in ratpack.session

Provides support for HTTP sessions.

SessionModule() - Constructor for class ratpack.session.SessionModule

SessionSerializer - Interface in ratpack.session

A serializer converts objects to bytes and vice versa.

SessionStore - Interface in ratpack.session

A persistent store of session data.

set(SessionKey<T>, T) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(SessionKey, Object).

set(SessionKey<T>, T, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(SessionKey, Object, SessionSerializer).

set(Class<T>, T) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(Class, Object).

set(Class<T>, T, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(Class, Object, SessionSerializer).

set(String, T) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(String, Object).

set(String, T, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(String, Object, SessionSerializer).

set(T) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(Object).

set(T, SessionSerializer) - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.set(Object, SessionSerializer).

set(SessionKey<T>, T) - Method in interface ratpack.session.SessionData

Sets the value for the given key, using the default serializer.

set(SessionKey<T>, T, SessionSerializer) - Method in interface ratpack.session.SessionData

Sets the value for the given key.

set(Class<T>, T) - Method in interface ratpack.session.SessionData

Sets the value for the given type, using the default serializer.

set(Class<T>, T, SessionSerializer) - Method in interface ratpack.session.SessionData

Sets the value for the given type.

set(String, T) - Method in interface ratpack.session.SessionData

Sets the value for the given name and type, using the runtime type of the value and the default serializer.

set(String, T, SessionSerializer) - Method in interface ratpack.session.SessionData

Sets the value for the given name and type, using the runtime type of the value.

set(T) - Method in interface ratpack.session.SessionData

Sets the value for the type, using the runtime type of the value and the default serializer.

set(T, SessionSerializer) - Method in interface ratpack.session.SessionData

Sets the value for the type, using the runtime type of the value.

setCipherAlgorithm(String) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set the cipher algorithm used to encrypt/decrypt the serialized session data.

setDomain(String) - Method in class ratpack.session.SessionCookieConfig

Set the domain for session cookie.

setExpires(Duration) - Method in class ratpack.session.SessionCookieConfig

Set cookie's max age.

setHttpOnly(boolean) - Method in class ratpack.session.SessionCookieConfig

Set session cookies attribute HttpOnly.

setIdName(String) - Method in class ratpack.session.SessionCookieConfig

Set the name of the cookie for session id.

setMacAlgorithm(String) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set mac algorithm used to sign the serialized and encrypted session data.

setMaxInactivityInterval(Duration) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set maximum inactivity time (in seconds) of the cookie session.

setMaxSessionCookieSize(int) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set maximum size of the session cookie.

setPath(String) - Method in class ratpack.session.SessionCookieConfig

Set the path for session cookie.

setSecretKey(String) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set the secret key used in the symmetric-key encryption/decryption of the serialized session data.

setSecretToken(String) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set the {code secretToken} used to sign the serialized and encrypted session data.

setSecure(boolean) - Method in class ratpack.session.SessionCookieConfig

Set session cookies attribute Secure.

setSessionCookieName(String) - Method in class ratpack.session.clientside.ClientSideSessionConfig

Set the cookie name used to store session data.

sign(ByteBuf, ByteBufAllocator) - Method in interface ratpack.session.clientside.Signer

Signer - Interface in ratpack.session.clientside

size() - Method in interface ratpack.session.SessionStore

The current number of sessions.

store(AsciiString, ByteBuf) - Method in interface ratpack.session.SessionStore

Writes the session data for the given id.

T

terminate() - Method in interface ratpack.session.Session

Terminates the session and session id.

terminate() - Method in interface ratpack.session.SessionData

See Session.terminate().

terminate() - Method in interface ratpack.session.SessionId

Terminate the current session id, disassociating it from the current user.

C D E G H I J L M O P R S T