org.openksavi.sponge.engine

Interface Session

All Superinterfaces:

Serializable

public interface Session
extends Serializable

A session.

Method Summary

Modifier and Type	Method and Description
boolean	existsVariable(String name) Returns true if a session variable named name exists.
<T> T	getVariable(Class<T> cls, String name) Returns the value of the session variable.
<T> T	getVariable(Class<T> cls, String name, T defaultValue) Returns the value of the session variable or defaultValue if not found.
<T> T	getVariable(String name) Returns the value of the session variable.
<T> T	getVariable(String name, T defaultValue) Returns the value of the session variable or defaultValue if not found.
void	removeVariable(String name) Removes a session variable.
void	setVariable(String name, Object value) Sets session variable value.
<T> void	setVariableIfNone(String name, Supplier<T> supplier) Sets the session variable if not set already.
void	updateVariable(String name) Updates the session variable.

Method Detail

setVariable

void setVariable(String name,
                 Object value)

Sets session variable value.

Parameters:

name - variable name.

value - variable value.

getVariable

<T> T getVariable(String name)

Returns the value of the session variable. Throws exception if not found.

Type Parameters:

T - variable.

Parameters:

name - variable name.

Returns:

variable value.

getVariable

<T> T getVariable(Class<T> cls,
                  String name)

Returns the value of the session variable. Throws exception if not found.

Type Parameters:

T - variable.

Parameters:

cls - variable class.

name - variable name.

Returns:

variable value.

getVariable

<T> T getVariable(String name,
                  T defaultValue)

Returns the value of the session variable or defaultValue if not found.

Type Parameters:

T - variable.

Parameters:

name - variable name.

defaultValue - default value.

Returns:

variable value.

getVariable

<T> T getVariable(Class<T> cls,
                  String name,
                  T defaultValue)

Returns the value of the session variable or defaultValue if not found.

Type Parameters:

T - variable.

Parameters:

cls - variable class.

name - variable name.

defaultValue - default value.

Returns:

variable value.

removeVariable

void removeVariable(String name)

Removes a session variable.

Parameters:

name - variable name.

existsVariable

boolean existsVariable(String name)

Returns true if a session variable named name exists.

Parameters:

name - variable name.

Returns:

true if a session variable named name exists.

setVariableIfNone

<T> void setVariableIfNone(String name,
                           Supplier<T> supplier)

Sets the session variable if not set already.

Type Parameters:

T - variable.

Parameters:

name - variable name.

supplier - variable value supplier.

updateVariable

void updateVariable(String name)

Updates the session variable.

Parameters:

name - variable name.