|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserManager
Describes the interface for managing users and provides access to the
User
.
Method Summary | |
---|---|
void |
addUser(java.lang.String username,
java.lang.String password)
Add a new user provided a username and password. |
void |
addUser(java.lang.String username,
java.lang.String password,
java.lang.String atnProviderName)
Add a new user provided a username and password in the specified authentication provider store. |
boolean |
authenticate(java.lang.String username,
java.lang.String password)
Authenticate a user. |
java.lang.String |
getAnonymousUser()
|
User |
getUser(java.lang.String username)
Get a User for a given username. |
java.util.Iterator |
getUserNames(java.lang.String filter)
An iterator of user names, finding users matching the corresponding filter criteria. |
java.util.Iterator |
getUsers(java.lang.String filter)
An iterator of User finding users matching the corresponding
filter criteria. |
java.util.Collection |
getUsersInGroup(java.lang.String groupFullPathName)
A collection of User for a specific group. |
java.util.Collection |
getUsersInRole(java.lang.String roleFullPathName)
A collection of User for all the users in a specific role. |
void |
importUser(java.lang.String username,
java.lang.String password,
boolean passThrough)
Import a new user with username and password and allow to bypass the enconding algorithm |
void |
importUser(java.lang.String username,
java.lang.String password,
java.lang.String atnProviderName,
boolean passThrough)
Import a new user with username and password in the specified authentication provider store and allow to bypass the enconding algorithm |
void |
removeUser(java.lang.String username)
Remove a user. |
void |
setPassword(java.lang.String username,
java.lang.String oldPassword,
java.lang.String newPassword)
Set the user password. |
void |
setPasswordEnabled(java.lang.String userName,
boolean enabled)
Set the enabled state of the user password credential. |
void |
setPasswordExpiration(java.lang.String userName,
java.sql.Date expirationDate)
Set the expiration date and the expired flag of the password credential. |
void |
setPasswordUpdateRequired(java.lang.String userName,
boolean updateRequired)
Set the update required state of the user password credential. |
void |
setUserEnabled(java.lang.String userName,
boolean enabled)
Enable or disable a user. |
boolean |
userExists(java.lang.String username)
Whether or not a user exists. |
Method Detail |
---|
java.lang.String getAnonymousUser()
boolean authenticate(java.lang.String username, java.lang.String password)
Authenticate a user.
username
- The user name.password
- The user password.
void addUser(java.lang.String username, java.lang.String password) throws SecurityException
Add a new user provided a username and password.
username
- The user name.password
- The password.
Throws
- a security exception.
SecurityException
void addUser(java.lang.String username, java.lang.String password, java.lang.String atnProviderName) throws SecurityException
Add a new user provided a username and password in the specified authentication provider store.
username
- The user name.password
- The password.atnProviderName
- The authentication provider name.
Throws
- a security exception.
SecurityException
void importUser(java.lang.String username, java.lang.String password, boolean passThrough) throws SecurityException
Import a new user with username and password and allow to bypass the enconding algorithm
username
- The user name.password
- The password.passThrough
- If true the provided password will not be validated/encoded
Throws
- a security exception.
SecurityException
void importUser(java.lang.String username, java.lang.String password, java.lang.String atnProviderName, boolean passThrough) throws SecurityException
Import a new user with username and password in the specified authentication provider store and allow to bypass the enconding algorithm
username
- The user name.password
- The password.atnProviderName
- The authentication provider name.passThrough
- If true the provided password will not be validated/encoded
Throws
- a security exception.
SecurityException
void removeUser(java.lang.String username) throws SecurityException
Remove a user. If there is a Preferences
node for
profile properties associated to this user, it will be removed as well.
Permission
for this user will be removed as well.
username
- The user name.
Throws
- a security exception.
SecurityException
boolean userExists(java.lang.String username)
Whether or not a user exists.
username
- The user name.
User getUser(java.lang.String username) throws SecurityException
Get a User
for a given username.
username
- The username.
User
.
Throws
- a security exception if the user cannot be found.
SecurityException
java.util.Iterator getUsers(java.lang.String filter) throws SecurityException
An iterator of User
finding users matching the corresponding
filter criteria.
filter
- The filter used to retrieve matching users.
User
.
SecurityException
java.util.Iterator getUserNames(java.lang.String filter) throws SecurityException
An iterator of user names, finding users matching the corresponding filter criteria.
TODO Complete filter implementation.
filter
- The filter used to retrieve matching users.
User
.
SecurityException
java.util.Collection getUsersInRole(java.lang.String roleFullPathName) throws SecurityException
A collection of User
for all the users in a specific role.
roleFullPathName
- The role name full path (e.g.
theRoleName.theRoleNameChild).
User
.
Throws
- a security exception if the role does not exist.
SecurityException
java.util.Collection getUsersInGroup(java.lang.String groupFullPathName) throws SecurityException
A collection of User
for a specific group.
groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
User
.
Throws
- security exception if the group does not exist.
SecurityException
void setPassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) throws SecurityException
Set the user password.
username
- The user name.oldPassword
- The old password.newPassword
- The new password.
Throws
- a security exception.
SecurityException
void setPasswordUpdateRequired(java.lang.String userName, boolean updateRequired) throws SecurityException
Set the update required state of the user password credential.
userName
- The user name.updateRequired
- The update required state.
Throws
- a security exception.
SecurityException
void setPasswordEnabled(java.lang.String userName, boolean enabled) throws SecurityException
Set the enabled state of the user password credential.
userName
- The user name.enabled
- The enabled state.
Throws
- a security exception.
SecurityException
void setUserEnabled(java.lang.String userName, boolean enabled) throws SecurityException
userName
- The user nameenabled
- enabled flag for the user
SecurityException
void setPasswordExpiration(java.lang.String userName, java.sql.Date expirationDate) throws SecurityException
Set the expiration date and the expired flag of the password credential.
If a date equal or before the current date is provided, the expired flag will be set to true, otherwise to false.
userName
- The user name.expirationDate
- The expiration date to set.
Throws
- a security exception.
SecurityException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |