com.xatkit.core.session

Class XatkitSession

java.lang.Object

com.xatkit.core.session.XatkitSession

Direct Known Subclasses:

DialogFlowSession

public class XatkitSession
extends Object

A session holding user-related information.

A XatkitSession is bound to a user, and holds all the volatile information related to the current conversation. A XatkitSession contains a RuntimeContexts, that represents the contextual variables of the current conversation.

See Also:

RuntimeContexts, XatkitCore.getOrCreateXatkitSession(String)

Constructor Summary

Constructors

Constructor and Description
XatkitSession(String sessionId) Constructs a new, empty XatkitSession with the provided sessionId.
XatkitSession(String sessionId, Configuration configuration) Constructs a new, empty XatkitSession with the provided sessionId and configuration.

Method Summary

Modifier and Type	Method and Description
Object	get(String key) Retrieves the session value associated to the provided key.
Configuration	getConfiguration() Returns the Configuration defining the session behavior.
RuntimeContexts	getRuntimeContexts() Returns the session's RuntimeContexts holding context-related variables.
String	getSessionId() Returns the unique identifier of the XatkitSession.
Map<String,Object>	getSessionVariables() Returns a Map containing the session variables.
void	merge(XatkitSession other) Merges this XatkitSession with the provided other.
void	store(String key, Object value) Store the provided value with the given key as a session variable.
void	storeList(String key, Object value) Store the provided value in the List associated to the provided key as a session variable.
String	toString() Returns a String representation of the session.

Methods inherited from class java.lang.Object

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

Constructor Detail

XatkitSession

public XatkitSession(String sessionId)

Constructs a new, empty XatkitSession with the provided sessionId. See XatkitSession(String, Configuration) to construct a XatkitSession with a given Configuration.

Parameters:

sessionId - the unique identifier of the XatkitSession

XatkitSession

public XatkitSession(String sessionId,
                     Configuration configuration)

Constructs a new, empty XatkitSession with the provided sessionId and configuration.

This constructor forwards the provided Configuration to the underlying RuntimeContexts and can be used to customize RuntimeContexts properties.

Parameters:

sessionId - the unique identifier of the XatkitSession

configuration - the Configuration parameterizing the XatkitSession

Throws:

NullPointerException - if the provided sessionId or configuration is null

Method Detail

getSessionId

public String getSessionId()

Returns the unique identifier of the XatkitSession.

Returns:

the unique identifier of the XatkitSession

getRuntimeContexts

public RuntimeContexts getRuntimeContexts()

Returns the session's RuntimeContexts holding context-related variables.

Returns:

the session's RuntimeContexts holding context-related variables

getConfiguration

public Configuration getConfiguration()

Returns the Configuration defining the session behavior.

Returns:

the Configuration defining the session behavior

store

public void store(String key,
                  Object value)

Store the provided value with the given key as a session variable.

Session-related variables are persistent across intent and events, and can contain any Object. They are used to store results of specific actions, or set global variables that can be accessed along the conversation.

Note: this method erases the previous value associated to the provided key with the new one.

Parameters:

key - the key to store and retrieve the provided value

value - the value to store

Throws:

NullPointerException - if the provided key is null

storeList

public void storeList(String key,
                      Object value)

Store the provided value in the List associated to the provided key as a session variable.

This method creates a new List with the provided value if the session variables do not contain any record associated to the provided key.

Note: if the XatkitSession contains a single-valued entry for the provided key this value will be erased and replaced by the created List.

Parameters:

key - the key of the List to store the provided value

value - the value to store in a List

getSessionVariables

public Map<String,Object> getSessionVariables()

Returns a Map containing the session variables.

Returns:

a Map containing the session variables

merge

public void merge(XatkitSession other)

Merges this XatkitSession with the provided other.

Parameters:

other - the XatkitSession to merge in the current one

get

public Object get(String key)

Retrieves the session value associated to the provided key.

Parameters:

key - the key to retrieve the value for

Returns:

the session value associated to the provided key if it exists, null otherwise

toString

public String toString()

Returns a String representation of the session.

Overrides:

toString in class Object

Returns:

a String representation of the session