com.rivescript.session

Interface SessionManager

All Known Implementing Classes:

ConcurrentHashMapSessionManager, NoOpSessionManager

public interface SessionManager

Interface for RiveScript user user variables.

The session manager keeps track of getting and setting user variables, for example when the <set> or <get>` tags are used in RiveScript or when API functions like RiveScript.setUservar(String, String, String) are called.

By default RiveScript stores user sessions in memory and provides methods to export and import them (e.g. to persist them when the bot shuts down so they can be reloaded). If you'd prefer a more 'active' session storage, for example one that puts user variables into a database or cache, you can create your own session manager that implements this interface.

Author:

Noah Petherbridge, Marcel Overdijk

Field Summary

Fields

Modifier and Type	Field and Description
static int	HISTORY_SIZE The number of entries stored in the history.

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.

Field Detail

HISTORY_SIZE

static final int HISTORY_SIZE

The number of entries stored in the history.

See Also:

Constant Field Values

Method Detail

init

UserData init(java.lang.String username)

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

Parameters:

username - the username

Returns:

the user data

set

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

Sets a user's variable.

Parameters:

username - the username

name - the variable name

value - the variable value

set

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

Sets a user's variables.

Parameters:

username - the username

vars - the user variables

addHistory

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

Adds input and reply to a user's history.

Parameters:

username - the username

input - the input

reply - the reply

setLastMatch

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

Sets a user's the last matched trigger.

Parameters:

username - the username

trigger - the trigger

get

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

Returns a user variable.

Parameters:

username - the username

name - the variable name

Returns:

the variable value

get

UserData get(java.lang.String username)

Returns all variables for a user.

Parameters:

username - the username

Returns:

the user data

getAll

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

Returns all variables about all users.

Returns:

the users and their user data

getLastMatch

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

Returns a user's last matched trigger.

Parameters:

username - the username

Returns:

the last matched trigger

getHistory

History getHistory(java.lang.String username)

Returns a user's history.

Parameters:

username - the username

Returns:

the history

clear

void clear(java.lang.String username)

Clears a user's variables.

Parameters:

username - the username

clearAll

void clearAll()

Clear all variables of all users.

freeze

void freeze(java.lang.String username)

Makes a snapshot of a user's variables.

Parameters:

username - the username

thaw

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

Unfreezes a user's variables.

Parameters:

username - the username

action - the thaw action

See Also:

ThawAction