ninja.session

Interface Session

All Known Implementing Classes:

SessionImpl

public interface Session

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICITY_KEY
static java.lang.String	EXPIRY_TIME_KEY
static java.lang.String	ID_KEY
static java.lang.String	TIMESTAMP_KEY

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all values from the session.
java.lang.String	get(java.lang.String key) Returns the value of the key or null.
java.lang.String	getAuthenticityToken()
java.util.Map<java.lang.String,java.lang.String>	getData()
java.lang.String	getId()
void	init(Context context) Has to be called initially.
boolean	isEmpty() Returns true if the session is empty, e.g.
void	put(java.lang.String key, java.lang.String value) Puts key / value into the session.
java.lang.String	remove(java.lang.String key) Removes the value of the key and returns the value or null.
void	save(Context context) To finally send this session to the user this method has to be called.
void	setExpiryTime(java.lang.Long expiryTimeMs) Use an alternative expiry time, this can be used to implement a longer expiry time for 'remember me' style functionality.

Field Detail

AUTHENTICITY_KEY

static final java.lang.String AUTHENTICITY_KEY

See Also:

Constant Field Values

ID_KEY

static final java.lang.String ID_KEY

See Also:

Constant Field Values

TIMESTAMP_KEY

static final java.lang.String TIMESTAMP_KEY

See Also:

Constant Field Values

EXPIRY_TIME_KEY

static final java.lang.String EXPIRY_TIME_KEY

See Also:

Constant Field Values

Method Detail

init

void init(Context context)

Has to be called initially. => maybe in the future as assisted inject.

Parameters:

context - The context of this session.

getId

java.lang.String getId()

Returns:

id of a session.

getData

java.util.Map<java.lang.String,java.lang.String> getData()

Returns:

complete content of session as immutable copy.

getAuthenticityToken

java.lang.String getAuthenticityToken()

Returns:

a authenticity token (may generate a new one if the session currently does not contain the token).

save

void save(Context context)

To finally send this session to the user this method has to be called. It basically serializes the session into the header of the response.

Parameters:

context - The context from where to deduct a potentially existing session.

put

void put(java.lang.String key,
         java.lang.String value)

Puts key / value into the session. PLEASE NOTICE: If value == null the key will be removed!

Parameters:

key - Name of the key to store in the session.

value - The value to store in the session

get

java.lang.String get(java.lang.String key)

Returns the value of the key or null.

Parameters:

key - Name of the key to retrieve.

Returns:

The value of the key or null.

remove

java.lang.String remove(java.lang.String key)

Removes the value of the key and returns the value or null.

Parameters:

key - name of the key to remove

Returns:

original value of the key we just removed

clear

void clear()

Removes all values from the session.

isEmpty

boolean isEmpty()

Returns true if the session is empty, e.g. does not contain anything else than the timestamp key.

Returns:

true if session does not contain any values / false if it contains values.

setExpiryTime

void setExpiryTime(java.lang.Long expiryTimeMs)

Use an alternative expiry time, this can be used to implement a longer expiry time for 'remember me' style functionality. The expiry time is persisted in the session.

Parameters:

expiryTimeMs - the expiry time in milliseconds, set to null to remove the expiry time from the session and use the application default.