public class ALUserSession extends ALProxy
Constructor and Description |
---|
ALUserSession(Session session) |
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'
|
call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService
public ALUserSession(Session session) throws java.lang.Exception
java.lang.Exception
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
uid
- The int ID of the user whose data to get.data_name
- The key of the data to get.CallError
java.lang.InterruptedException
public java.lang.String getUserBinding(java.lang.Integer uid, java.lang.String binding_name) throws CallError, java.lang.InterruptedException
uid
- The int ID of the user.binding_name
- The string name of the binding source.CallError
java.lang.InterruptedException
public java.util.List<java.lang.Integer> findUsersWithBinding(java.lang.String binding_name, java.lang.String binding_value) throws CallError, java.lang.InterruptedException
binding_name
- The string name of the binding source.binding_value
- The string ID of the user at the binding source.CallError
java.lang.InterruptedException
public java.lang.Boolean doesUserDataSourceExist(java.lang.String source_name) throws CallError, java.lang.InterruptedException
source_name
- The string name of the data source.CallError
java.lang.InterruptedException
public java.util.Map<java.lang.String,java.lang.String> getUserBindings(java.lang.Integer uid) throws CallError, java.lang.InterruptedException
uid
- The int ID of the user.CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getUserDataSources() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object getUserData(java.lang.Integer uid, java.lang.String data_name, java.lang.String source_name) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
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
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.CallError
java.lang.InterruptedException
public java.lang.Boolean isStatsEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void clearStats() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean isTraceEnabled() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public void exit() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String version() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean ping() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getMethodList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Object getMethodHelp(java.lang.String methodName) throws CallError, java.lang.InterruptedException
methodName
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Object getModuleHelp() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) throws CallError, java.lang.InterruptedException
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.CallError
java.lang.InterruptedException
public java.lang.Boolean isRunning(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- The ID of the method that was returned when calling the method using 'post'CallError
java.lang.InterruptedException
public void stop(java.lang.Integer id) throws CallError, java.lang.InterruptedException
id
- the ID of the method to wait forCallError
java.lang.InterruptedException
public java.lang.String getBrokerName() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.String getUsage(java.lang.String name) throws CallError, java.lang.InterruptedException
name
- The name of the method.CallError
java.lang.InterruptedException
public java.lang.Boolean doUsersExist(java.util.List<java.lang.Integer> user_list) throws CallError, java.lang.InterruptedException
user_list
- A list of int ID of the users to check.CallError
java.lang.InterruptedException
public java.util.List<java.lang.Integer> getUserList() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Integer getNumUsers() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Integer getFocusedUser() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.util.List<java.lang.Integer> getOpenUserSessions() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean areUserSessionsOpen(java.util.List<java.lang.Integer> user_list) throws CallError, java.lang.InterruptedException
user_list
- A list of int IDs of each user to check.CallError
java.lang.InterruptedException
public java.util.List<java.lang.String> getBindingSources() throws CallError, java.lang.InterruptedException
CallError
java.lang.InterruptedException
public java.lang.Boolean doesBindingSourceExist(java.lang.String binding_name) throws CallError, java.lang.InterruptedException
binding_name
- The string name of the binding source.CallError
java.lang.InterruptedException
Aldebaran SDK for Java
Copyright 2006-2015 Aldebaran Robotics. All Rights Reserved.