com.rivescript.session

Class ConcurrentHashMapSessionManager

java.lang.Object

com.rivescript.session.ConcurrentHashMapSessionManager

All Implemented Interfaces:

SessionManager

public class ConcurrentHashMapSessionManager
extends java.lang.Object
implements SessionManager

Implements the default in-memory SessionManager for RiveScript, based on a ConcurrentHashMap.

Author:

Noah Petherbridge, Marcel Overdijk

Field Summary

Fields inherited from interface com.rivescript.session.SessionManager

HISTORY_SIZE

Constructor Summary

Constructors

Constructor and Description
ConcurrentHashMapSessionManager()

Method Summary

Modifier and Type	Method and Description
void	addHistory(java.lang.String username, java.lang.String input, java.lang.String reply) Adds input and reply to a user's history.
void	clear(java.lang.String username) Clears a user's variables.
void	clearAll() Clear all variables of all users.
void	freeze(java.lang.String username) Makes a snapshot of a user's variables.
UserData	get(java.lang.String username) Returns all variables for a user.
java.lang.String	get(java.lang.String username, java.lang.String name) Returns a user variable.
java.util.Map<java.lang.String,UserData>	getAll() Returns all variables about all users.
History	getHistory(java.lang.String username) Returns a user's history.
java.lang.String	getLastMatch(java.lang.String username) Returns a user's last matched trigger.
UserData	init(java.lang.String username) Makes sure a username has a session (creates one if not).
void	set(java.lang.String username, java.util.Map<java.lang.String,java.lang.String> vars) Sets a user's variables.
void	set(java.lang.String username, java.lang.String name, java.lang.String value) Sets a user's variable.
void	setLastMatch(java.lang.String username, java.lang.String trigger) Sets a user's the last matched trigger.
void	thaw(java.lang.String username, ThawAction action) Unfreezes a user's variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentHashMapSessionManager

public ConcurrentHashMapSessionManager()

Method Detail

init

public UserData init(java.lang.String username)

Description copied from interface: SessionManager

Makes sure a username has a session (creates one if not).

Specified by:

init in interface SessionManager

Parameters:

username - the username

Returns:

the user data

set

public void set(java.lang.String username,
                java.lang.String name,
                java.lang.String value)

Description copied from interface: SessionManager

Sets a user's variable.

Specified by:

set in interface SessionManager

Parameters:

username - the username

name - the variable name

value - the variable value

set

public void set(java.lang.String username,
                java.util.Map<java.lang.String,java.lang.String> vars)

Description copied from interface: SessionManager

Sets a user's variables.

Specified by:

set in interface SessionManager

Parameters:

username - the username

vars - the user variables

addHistory

public void addHistory(java.lang.String username,
                       java.lang.String input,
                       java.lang.String reply)

Description copied from interface: SessionManager

Adds input and reply to a user's history.

Specified by:

addHistory in interface SessionManager

Parameters:

username - the username

input - the input

reply - the reply

setLastMatch

public void setLastMatch(java.lang.String username,
                         java.lang.String trigger)

Description copied from interface: SessionManager

Sets a user's the last matched trigger.

Specified by:

setLastMatch in interface SessionManager

Parameters:

username - the username

trigger - the trigger

get

public java.lang.String get(java.lang.String username,
                            java.lang.String name)

Description copied from interface: SessionManager

Returns a user variable.

Specified by:

get in interface SessionManager

Parameters:

username - the username

name - the variable name

Returns:

the variable value

get

public UserData get(java.lang.String username)

Description copied from interface: SessionManager

Returns all variables for a user.

Specified by:

get in interface SessionManager

Parameters:

username - the username

Returns:

the user data

getAll

public java.util.Map<java.lang.String,UserData> getAll()

Description copied from interface: SessionManager

Returns all variables about all users.

Specified by:

getAll in interface SessionManager

Returns:

the users and their user data

getLastMatch

public java.lang.String getLastMatch(java.lang.String username)

Description copied from interface: SessionManager

Returns a user's last matched trigger.

Specified by:

getLastMatch in interface SessionManager

Parameters:

username - the username

Returns:

the last matched trigger

getHistory

public History getHistory(java.lang.String username)

Description copied from interface: SessionManager

Returns a user's history.

Specified by:

getHistory in interface SessionManager

Parameters:

username - the username

Returns:

the history

clear

public void clear(java.lang.String username)

Description copied from interface: SessionManager

Clears a user's variables.

Specified by:

clear in interface SessionManager

Parameters:

username - the username

clearAll

public void clearAll()

Description copied from interface: SessionManager

Clear all variables of all users.

Specified by:

clearAll in interface SessionManager

freeze

public void freeze(java.lang.String username)

Description copied from interface: SessionManager

Makes a snapshot of a user's variables.

Specified by:

freeze in interface SessionManager

Parameters:

username - the username

thaw

public void thaw(java.lang.String username,
                 ThawAction action)

Description copied from interface: SessionManager

Unfreezes a user's variables.

Specified by:

thaw in interface SessionManager

Parameters:

username - the username

action - the thaw action

See Also:

ThawAction