com.aldebaran.qi.helper.proxies

Class ALUserSession

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALUserSession

public class ALUserSession
extends ALProxy

Manages the state of active users, and the bindings to their data.

See Also:

NAOqi APIs for ALUserSession

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALUserSession(Session session)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	areUserSessionsOpen(java.util.List<java.lang.Integer> user_list) Check if users have an open session.
void	clearStats()
java.lang.Boolean	doesBindingSourceExist(java.lang.String binding_name) Query if a particular has been applied to UserSession
java.lang.Boolean	doesUserDataSourceExist(java.lang.String source_name) Check if a data source has been registered.
java.lang.Boolean	doUsersExist(java.util.List<java.lang.Integer> user_list) Check if users exist in db.
void	exit() Exits and unregisters the module.
java.util.List<java.lang.Integer>	findUsersWithBinding(java.lang.String binding_name, java.lang.String binding_value) Get the sources a user is bound to.
java.util.List<java.lang.String>	getBindingSources() The list of binding sources that have been applied to UserSession
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.Integer	getFocusedUser() Get which user has the robot's focus.
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.Integer	getNumUsers() Get the count of users in db.
java.util.List<java.lang.Integer>	getOpenUserSessions() Get which users have an open session.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.String	getUserBinding(java.lang.Integer uid, java.lang.String binding_name) Get the a specific source a user is bound to.
java.util.Map<java.lang.String,java.lang.String>	getUserBindings(java.lang.Integer uid) Get the sources a user is bound to.
java.util.Map<java.lang.String,java.lang.Object>	getUserData(java.lang.Integer uid, java.lang.String data_name) Get some data about a user.
java.lang.Object	getUserData(java.lang.Integer uid, java.lang.String data_name, java.lang.String source_name) Get some data about a user.
java.util.List<java.lang.String>	getUserDataSources() Check what data sources have been registered.
java.util.List<java.lang.Integer>	getUserList() Get a full list of the users.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Boolean	ping() Just a ping.
void	setUserData(java.lang.Integer uid, java.lang.String data_name, java.lang.String source_name, java.lang.Object data) Set some data about a user.
void	stop(java.lang.Integer id) returns true if the method is currently running
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

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

Constructor Detail

ALUserSession

public ALUserSession(Session session)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getUserData

public java.util.Map<java.lang.String,java.lang.Object> getUserData(java.lang.Integer uid,
                                                                    java.lang.String data_name)
                                                             throws CallError,
                                                                    java.lang.InterruptedException

Get some data about a user. Will throw if it does not exist

Parameters:

uid - The int ID of the user whose data to get.

data_name - The key of the data to get.

Returns:

A map keyed by source_name of ALValues of the data.

Throws:

CallError

java.lang.InterruptedException

getUserBinding

public java.lang.String getUserBinding(java.lang.Integer uid,
                                       java.lang.String binding_name)
                                throws CallError,
                                       java.lang.InterruptedException

Get the a specific source a user is bound to.

Parameters:

uid - The int ID of the user.

binding_name - The string name of the binding source.

Returns:

The string value of the binding ID for the user.

Throws:

CallError

java.lang.InterruptedException

findUsersWithBinding

public java.util.List<java.lang.Integer> findUsersWithBinding(java.lang.String binding_name,
                                                              java.lang.String binding_value)
                                                       throws CallError,
                                                              java.lang.InterruptedException

Get the sources a user is bound to.

Parameters:

binding_name - The string name of the binding source.

binding_value - The string ID of the user at the binding source.

Returns:

The int IDs of the users with the passed binding_value.

Throws:

CallError

java.lang.InterruptedException

doesUserDataSourceExist

public java.lang.Boolean doesUserDataSourceExist(java.lang.String source_name)
                                          throws CallError,
                                                 java.lang.InterruptedException

Check if a data source has been registered.

Parameters:

source_name - The string name of the data source.

Returns:

A bool, true if the source has been registered

Throws:

CallError

java.lang.InterruptedException

getUserBindings

public java.util.Map<java.lang.String,java.lang.String> getUserBindings(java.lang.Integer uid)
                                                                 throws CallError,
                                                                        java.lang.InterruptedException

Get the sources a user is bound to.

Parameters:

uid - The int ID of the user.

Returns:

A map of string binding names and their string values.

Throws:

CallError

java.lang.InterruptedException

getUserDataSources

public java.util.List<java.lang.String> getUserDataSources()
                                                    throws CallError,
                                                           java.lang.InterruptedException

Check what data sources have been registered.

Returns:

A list of strings of each registered data source.

Throws:

CallError

java.lang.InterruptedException

getUserData

public java.lang.Object getUserData(java.lang.Integer uid,
                                    java.lang.String data_name,
                                    java.lang.String source_name)
                             throws CallError,
                                    java.lang.InterruptedException

Get some data about a user. Will throw if it does not exist

Parameters:

uid - The int ID of the user whose data to get.

data_name - The key of the data to get.

source_name - The string name of the data source.

Returns:

ALValue of the data.

Throws:

CallError

java.lang.InterruptedException

setUserData

public void setUserData(java.lang.Integer uid,
                        java.lang.String data_name,
                        java.lang.String source_name,
                        java.lang.Object data)
                 throws CallError,
                        java.lang.InterruptedException

Set some data about a user. Will throw if user does not exist

Parameters:

uid - The int ID of the user whose data to set.

data_name - The key of the data to set.

source_name - The string name of the data source.

data - ALValue of the data.

Throws:

CallError

java.lang.InterruptedException

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

doUsersExist

public java.lang.Boolean doUsersExist(java.util.List<java.lang.Integer> user_list)
                               throws CallError,
                                      java.lang.InterruptedException

Check if users exist in db.

Parameters:

user_list - A list of int ID of the users to check.

Returns:

A bool, true if all users exist.

Throws:

CallError

java.lang.InterruptedException

getUserList

public java.util.List<java.lang.Integer> getUserList()
                                              throws CallError,
                                                     java.lang.InterruptedException

Get a full list of the users.

Returns:

A list of int user IDs.

Throws:

CallError

java.lang.InterruptedException

getNumUsers

public java.lang.Integer getNumUsers()
                              throws CallError,
                                     java.lang.InterruptedException

Get the count of users in db.

Returns:

An int of how many users exist

Throws:

CallError

java.lang.InterruptedException

getFocusedUser

public java.lang.Integer getFocusedUser()
                                 throws CallError,
                                        java.lang.InterruptedException

Get which user has the robot's focus.

Returns:

The int ID of the focused user. -1 if no focused user.

Throws:

CallError

java.lang.InterruptedException

getOpenUserSessions

public java.util.List<java.lang.Integer> getOpenUserSessions()
                                                      throws CallError,
                                                             java.lang.InterruptedException

Get which users have an open session.

Returns:

A list of int IDs of each user with an open session.

Throws:

CallError

java.lang.InterruptedException

areUserSessionsOpen

public java.lang.Boolean areUserSessionsOpen(java.util.List<java.lang.Integer> user_list)
                                      throws CallError,
                                             java.lang.InterruptedException

Check if users have an open session.

Parameters:

user_list - A list of int IDs of each user to check.

Returns:

A bool, true if all users have open sessions.

Throws:

CallError

java.lang.InterruptedException

getBindingSources

public java.util.List<java.lang.String> getBindingSources()
                                                   throws CallError,
                                                          java.lang.InterruptedException

The list of binding sources that have been applied to UserSession

Returns:

A list of strings, one for each binding source.

Throws:

CallError

java.lang.InterruptedException

doesBindingSourceExist

public java.lang.Boolean doesBindingSourceExist(java.lang.String binding_name)
                                         throws CallError,
                                                java.lang.InterruptedException

Query if a particular has been applied to UserSession

Parameters:

binding_name - The string name of the binding source.

Returns:

A bool, true if a binding source exists.

Throws:

CallError

java.lang.InterruptedException