public interface UserManager
UserInfo
and provides various
methods to manage users. To activate the user timeout recognition, the method activateUserActivityScheduler()
)
must be called. The UserManager can be created with UserManagerFactory.getUserManager(long)
)
as a singleton.Modifier and Type | Method and Description |
---|---|
void |
activateUserActivityScheduler()
Activates the
UserActivityScheduler to observe the user activities. |
void |
activateUserActivityScheduler(boolean isAutoClean)
Activates the
UserActivityScheduler to observe the user activities. |
UserInfo |
addUser(String aUserId)
Creates and adds the
UserInfo for the user id. |
void |
addUser(UserInfo aUserInfo)
Adds the
UserInfo to the UserManager. |
void |
deactivateUserActivityScheduler()
Deactivates the
UserActivityScheduler . |
UserInfo |
getUser(String aUserId)
Returns the
UserInfo for the user id. |
UserActivityScheduler |
getUserActivityScheduler()
Returns the
UserActivityScheduler which is instantiated with the UserManager. |
int |
getUserCount()
Returns the count of the added
UserInfo objects. |
Collection<UserInfo> |
getUsers()
Returns all added
UserInfo objects. |
boolean |
isUserContained(UserInfo aUserInfo)
Checks if a user is added to a domain.
|
UserInfo |
removeUser(String aUserId)
Removes the
UserInfo for the user id. |
boolean |
removeUser(UserInfo aUserInfo)
Removes the
UserInfo . |
void |
removeUsers()
Removes all added
UserInfo objects. |
void |
reset()
Resets the UserManager (removes all users, stops the user activity scheduler, etc.)
|
UserInfo addUser(String aUserId)
UserInfo
for the user id.aUserId
- id of the user to addUserInfo
void addUser(UserInfo aUserInfo)
UserInfo
to the UserManager.aUserInfo
- UserInfo
to addUserInfo removeUser(String aUserId)
UserInfo
for the user id.boolean removeUser(UserInfo aUserInfo)
UserInfo
.aUserInfo
- UserInfo
to removevoid removeUsers()
UserInfo
objects.boolean isUserContained(UserInfo aUserInfo)
aUserInfo
- userint getUserCount()
UserInfo
objects.UserInfo
objectsCollection<UserInfo> getUsers()
UserInfo
objects. It returns an empty
Collection
when no
UserInfo
objects are added.UserInfo
objectsvoid activateUserActivityScheduler()
UserActivityScheduler
to observe the user activities. When the users/clients should be
removed automatically, please use activateUserActivityScheduler(boolean)
.void activateUserActivityScheduler(boolean isAutoClean)
UserActivityScheduler
to observe the user activities.isAutoClean
- when set to true, the users/clients are removed automatically on timeoutvoid deactivateUserActivityScheduler()
UserActivityScheduler
. See UserActivityScheduler
for more information.UserActivityScheduler getUserActivityScheduler()
UserActivityScheduler
which is instantiated with the UserManager. The method
activateUserActivityScheduler()
must be called to start the UserActivityScheduler
.UserActivityScheduler
which is instantiated with the UserManagervoid reset()
Copyright © 2012. All Rights Reserved.