io.micronaut.session

Class InMemorySession

java.lang.Object

io.micronaut.session.InMemorySession

All Implemented Interfaces:

ConvertibleValues<java.lang.Object>, MutableConvertibleValues<java.lang.Object>, ValueResolver<java.lang.CharSequence>, Session, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

public class InMemorySession
extends java.lang.Object
implements Session

A Session that is help in-memory.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.CharSequence,java.lang.Object>	attributeMap
protected MutableConvertibleValues<java.lang.Object>	attributes
protected java.time.Instant	lastAccessTime

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InMemorySession(java.lang.String id, java.time.Duration maxInactiveInterval) Constructor.
protected	InMemorySession(java.lang.String id, java.time.Instant creationTime, java.time.Duration maxInactiveInterval) Constructor.

Method Summary

Modifier and Type	Method and Description
MutableConvertibleValues<java.lang.Object>	clear() Clear all values.
<T> java.util.Optional<T>	get(java.lang.CharSequence name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name.
java.time.Instant	getCreationTime() Returns the time when this session was created.
java.lang.String	getId() A unique identifier for the session.
java.time.Instant	getLastAccessedTime() Returns the last time the client sent a request associated with this session as an Instant.
java.time.Duration	getMaxInactiveInterval() Returns the maximum time interval as a Duration that sessions will be kept open between client accesses.
boolean	isModified()
boolean	isNew()
java.util.Set<java.lang.String>	names()
MutableConvertibleValues<java.lang.Object>	put(java.lang.CharSequence key, java.lang.Object value) Insert a value for the given key and value.
MutableConvertibleValues<java.lang.Object>	remove(java.lang.CharSequence key) Remove a value for the given key.
Session	setLastAccessedTime(java.time.Instant instant) Sets the last accessed time on the session.
Session	setMaxInactiveInterval(java.time.Duration duration) Specifies the duration between client requests before session should be invalidated.
void	setNew(boolean aNew)
java.util.Collection<java.lang.Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.session.Session

get, isExpired

Methods inherited from interface io.micronaut.core.convert.value.MutableConvertibleValues

of, putAll, putAll

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, empty, forEach, getValue, getValueType, isEmpty, iterator, subMap, subMap, subMap

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

attributeMap

protected final java.util.Map<java.lang.CharSequence,java.lang.Object> attributeMap

attributes

protected final MutableConvertibleValues<java.lang.Object> attributes

lastAccessTime

protected java.time.Instant lastAccessTime

Constructor Detail

InMemorySession

protected InMemorySession(java.lang.String id,
                          java.time.Duration maxInactiveInterval)

Constructor.

Parameters:

id - The session id

maxInactiveInterval - The max inactive interval

InMemorySession

protected InMemorySession(java.lang.String id,
                          java.time.Instant creationTime,
                          java.time.Duration maxInactiveInterval)

Constructor.

Parameters:

id - The session id

creationTime - The creation time

maxInactiveInterval - The max inactive interval

Method Detail

getId

@NonNull
public java.lang.String getId()

Description copied from interface: Session

A unique identifier for the session.

Specified by:

getId in interface Session

Returns:

The id of the session

getLastAccessedTime

@NonNull
public java.time.Instant getLastAccessedTime()

Description copied from interface: Session

Returns the last time the client sent a request associated with this session as an Instant.

Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

Specified by:

getLastAccessedTime in interface Session

Returns:

An Instant representing the time the session was last accessed

setMaxInactiveInterval

public Session setMaxInactiveInterval(java.time.Duration duration)

Description copied from interface: Session

Specifies the duration between client requests before session should be invalidated.

Specified by:

setMaxInactiveInterval in interface Session

Parameters:

duration - A duration specifying the max inactive interval

Returns:

The session

setLastAccessedTime

public Session setLastAccessedTime(java.time.Instant instant)

Description copied from interface: Session

Sets the last accessed time on the session.

Specified by:

setLastAccessedTime in interface Session

Parameters:

instant - The instant that represents the last accessed time

Returns:

The session

getMaxInactiveInterval

public java.time.Duration getMaxInactiveInterval()

Description copied from interface: Session

Returns the maximum time interval as a Duration that sessions will be kept open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method.

Specified by:

getMaxInactiveInterval in interface Session

Returns:

A duration specifying the time should session should remain open between client requests

See Also:

Session.setMaxInactiveInterval(java.time.Duration)

isNew

public boolean isNew()

Specified by:

isNew in interface Session

Returns:

Is the session a newly created and unsaved session

isModified

public boolean isModified()

Specified by:

isModified in interface Session

Returns:

Has the session been modified

getCreationTime

@NonNull
public java.time.Instant getCreationTime()

Description copied from interface: Session

Returns the time when this session was created.

Specified by:

getCreationTime in interface Session

Returns:

An Instant instance

put

public MutableConvertibleValues<java.lang.Object> put(java.lang.CharSequence key,
                                                      java.lang.Object value)

Description copied from interface: MutableConvertibleValues

Insert a value for the given key and value.

Specified by:

put in interface MutableConvertibleValues<java.lang.Object>

Parameters:

key - The key

value - The value

Returns:

This values instance

remove

public MutableConvertibleValues<java.lang.Object> remove(java.lang.CharSequence key)

Description copied from interface: MutableConvertibleValues

Remove a value for the given key.

Specified by:

remove in interface MutableConvertibleValues<java.lang.Object>

Parameters:

key - The key

Returns:

This values instance

clear

public MutableConvertibleValues<java.lang.Object> clear()

Description copied from interface: MutableConvertibleValues

Clear all values.

Specified by:

clear in interface MutableConvertibleValues<java.lang.Object>

Returns:

This values instance

names

public java.util.Set<java.lang.String> names()

Specified by:

names in interface ConvertibleValues<java.lang.Object>

Returns:

The names of the values

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface ConvertibleValues<java.lang.Object>

Returns:

The values

get

public <T> java.util.Optional<T> get(java.lang.CharSequence name,
                                     ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<java.lang.CharSequence>

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted

setNew

public void setNew(boolean aNew)

Parameters:

aNew - Set is new