io.jooby

Interface Session

All Known Implementing Classes:

SessionImpl

public interface Session

HTTP session. Only basic data types can be saved into session.

Since:

2.0.0

Author:

edgar

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Attribute's name.

Method Summary

Modifier and Type	Method and Description
Session	clear() Remove all attributes.
static Session	create(Context ctx, String id) Creates a new session.
static Session	create(Context ctx, String id, Map<String,String> data) Creates a new session.
void	destroy() Destroy/invalidates this session.
Value	get(String name) Get a session attribute.
Instant	getCreationTime() Session creation time.
String	getId() Session ID or null for stateless (usually signed) sessions.
Instant	getLastAccessedTime() Session last accessed time.
boolean	isModify() True for modified/dirty sessions.
boolean	isNew() True for new sessions.
default Session	put(String name, boolean value) Put a session attribute.
default Session	put(String name, CharSequence value) Put a session attribute.
default Session	put(String name, double value) Put a session attribute.
default Session	put(String name, float value) Put a session attribute.
default Session	put(String name, int value) Put a session attribute.
default Session	put(String name, long value) Put a session attribute.
default Session	put(String name, Number value) Put a session attribute.
Session	put(String name, String value) Put a session attribute.
Value	remove(String name) Remove a session attribute.
Session	renewId() Assign a new ID to the existing session.
Session	setCreationTime(Instant creationTime) Set session creation time.
Session	setId(String id) Set Session ID.
Session	setLastAccessedTime(Instant lastAccessedTime) Set session last accessed time.
Session	setModify(boolean modify) Set modify flag.
Session	setNew(boolean isNew) Set new flag.
Map<String,String>	toMap() Read-only copy of session attributes.

Field Detail

NAME

static final String NAME

Attribute's name.

See Also:

Constant Field Values

Method Detail

getId

@Nullable
String getId()

Session ID or null for stateless (usually signed) sessions.

Returns:

Session ID or null for stateless (usually signed) sessions.

setId

@Nonnull
Session setId(@Nullable
                       String id)

Set Session ID.

Parameters:

id - Session ID or null

Returns:

Session.

get

@Nonnull
Value get(@Nonnull
                   String name)

Get a session attribute.

Parameters:

name - Attribute's name.

Returns:

An attribute value or missing value.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             int value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             long value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             @Nonnull
                             CharSequence value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
Session put(@Nonnull
                     String name,
                     @Nonnull
                     String value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             float value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             double value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             boolean value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

put

@Nonnull
default Session put(@Nonnull
                             String name,
                             @Nonnull
                             Number value)

Put a session attribute.

Parameters:

name - Attribute's name.

value - Attribute's value.

Returns:

This session.

remove

@Nonnull
Value remove(@Nonnull
                      String name)

Remove a session attribute.

Parameters:

name - Attribute's name.

Returns:

Session attribute or missing value.

toMap

@Nonnull
Map<String,String> toMap()

Read-only copy of session attributes.

Returns:

Read-only attributes.

getCreationTime

@Nonnull
Instant getCreationTime()

Session creation time.

Returns:

Session creation time.

setCreationTime

@Nonnull
Session setCreationTime(@Nonnull
                                 Instant creationTime)

Set session creation time.

Parameters:

creationTime - Session creation time.

Returns:

This session.

getLastAccessedTime

@Nonnull
Instant getLastAccessedTime()

Session last accessed time.

Returns:

Session creation time.

setLastAccessedTime

@Nonnull
Session setLastAccessedTime(@Nonnull
                                     Instant lastAccessedTime)

Set session last accessed time.

Parameters:

lastAccessedTime - Session creation time.

Returns:

This session.

isNew

boolean isNew()

True for new sessions.

Returns:

True for new sessions.

setNew

@Nonnull
Session setNew(boolean isNew)

Set new flag. This method is part of public API but shouldn't be use it.

Parameters:

isNew - New flag.

Returns:

This session.

isModify

boolean isModify()

True for modified/dirty sessions.

Returns:

True for modified/dirty sessions.

setModify

@Nonnull
Session setModify(boolean modify)

Set modify flag. This method is part of public API but shouldn't be use it.

Parameters:

modify - Modify flag.

Returns:

This session.

clear

Session clear()

Remove all attributes.

Returns:

This session.

destroy

void destroy()

Destroy/invalidates this session.

renewId

Session renewId()

Assign a new ID to the existing session.

Returns:

This session.

create

@Nonnull
static Session create(@Nonnull
                               Context ctx,
                               @Nullable
                               String id)

Creates a new session.

Parameters:

ctx - Web context.

id - Session ID or null.

Returns:

A new session.

create

@Nonnull
static Session create(@Nonnull
                               Context ctx,
                               @Nullable
                               String id,
                               @Nonnull
                               Map<String,String> data)

Creates a new session.

Parameters:

ctx - Web context.

id - Session ID or null.

data - Session attributes.

Returns:

A new session.