public class DefaultUserManager extends Object implements UserManager
UserInfo
and provides various
methods to manage users. To activate the user timeout recognition, the method UserManager.activateUserActivityScheduler()
)
must be called. The UserManager can be created with UserManagerFactory.getUserManager(long)
)
as a singleton.Constructor and Description |
---|
DefaultUserManager(long aTimeoutInterval)
Creates a new UserManager.
|
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.)
|
public DefaultUserManager(long aTimeoutInterval)
UserManagerFactory.getUserManager(long)
)aTimeoutInterval
- timeout interval (is only required if the UserActivityScheduler
needs to be started).public UserInfo addUser(String aUserId)
UserInfo
for the user id.addUser
in interface UserManager
aUserId
- id of the user to addUserInfo
public void addUser(UserInfo aUserInfo)
UserInfo
to the UserManager.addUser
in interface UserManager
aUserInfo
- UserInfo
to addpublic UserInfo removeUser(String aUserId)
UserInfo
for the user id.removeUser
in interface UserManager
aUserId
- user id of the UserInfo
to removeUserInfo
public boolean removeUser(UserInfo aUserInfo)
UserInfo
.
Observing threads get informed because it is not required to observe the removed user (anymore).removeUser
in interface UserManager
aUserInfo
- UserInfo
to removepublic void removeUsers()
UserInfo
objects.
Observing threads get informed because it is not required to observe the removed users (anymore).removeUsers
in interface UserManager
public boolean isUserContained(UserInfo aUserInfo)
isUserContained
in interface UserManager
aUserInfo
- userpublic UserInfo getUser(String aUserId)
getUser
in interface UserManager
aUserId
- user id of the requested UserInfo
UserInfo
for the user id. NULL when no
UserInfo
for the user id is added.public int getUserCount()
UserInfo
objects.getUserCount
in interface UserManager
UserInfo
objectspublic Collection<UserInfo> getUsers()
UserInfo
objects. It returns an empty
Collection
when no
UserInfo
objects are added.getUsers
in interface UserManager
UserInfo
objectspublic void activateUserActivityScheduler()
UserActivityScheduler
to observe the user activities. When the users/clients should be
removed automatically, please use UserManager.activateUserActivityScheduler(boolean)
.activateUserActivityScheduler
in interface UserManager
public void activateUserActivityScheduler(boolean isAutoClean)
UserActivityScheduler
to observe the user activities.activateUserActivityScheduler
in interface UserManager
isAutoClean
- when set to true, the users/clients are removed automatically on timeoutpublic void deactivateUserActivityScheduler()
UserActivityScheduler
. See UserActivityScheduler
for more information.deactivateUserActivityScheduler
in interface UserManager
public UserActivityScheduler getUserActivityScheduler()
UserActivityScheduler
which is instantiated with the UserManager. The method
UserManager.activateUserActivityScheduler()
must be called to start the UserActivityScheduler
.getUserActivityScheduler
in interface UserManager
UserActivityScheduler
which is instantiated with the UserManagerpublic void reset()
reset
in interface UserManager
Copyright © 2012. All Rights Reserved.