| org.apache.jetspeed.security.UserManager
All known Subclasses: org.apache.jetspeed.security.impl.UserManagerImpl,
| UserManager | | public interface UserManager (Code) | |
Describes the interface for managing users and provides access to the
User .
author:
David Le Strat |
| Method Summary | |
| void | addUser(String username, String password)
Add a new user provided a username and password. | | void | addUser(String username, String password, String atnProviderName)
Add a new user provided a username and password in the specified authentication
provider store. | | boolean | authenticate(String username, String password)
Authenticate a user.
Parameters:
username - The user name.
Parameters:
password - The user password. | | String | getAnonymousUser()
| | User | getUser(String username)
Get a
User for a given username.
Parameters:
username - The username. | | Iterator | getUserNames(String filter)
An iterator of user names, finding users matching the corresponding
filter criteria.
TODO Complete filter implementation.
Parameters:
filter - The filter used to retrieve matching users. | | Iterator | getUsers(String filter)
An iterator of
User finding users matching the corresponding
filter criteria.
TODO Complete filter implementation.
Parameters:
filter - The filter used to retrieve matching users. | | Collection | getUsersInGroup(String groupFullPathName)
A collection of
User for a specific group.
Parameters:
groupFullPathName - The group name full path(e.g. | | Collection | getUsersInRole(String roleFullPathName)
A collection of
User for all the users in a specific role.
Parameters:
roleFullPathName - The role name full path (e.g.theRoleName.theRoleNameChild). | | void | importUser(String username, String password, boolean passThrough)
| | void | importUser(String username, String password, String atnProviderName, boolean passThrough)
| | void | removeUser(String username)
Remove a user. | | void | setPassword(String username, String oldPassword, String newPassword)
Set the user password. | | void | setPasswordEnabled(String userName, boolean enabled)
Set the enabled state of the user password credential. | | void | setPasswordExpiration(String userName, Date expirationDate)
| | void | setPasswordUpdateRequired(String userName, boolean updateRequired)
Set the update required state of the user password credential. | | void | setUserEnabled(String userName, boolean enabled)
Enable or disable a user. | | boolean | userExists(String username)
Whether or not a user exists.
Parameters:
username - The user name. |
| addUser | | void addUser(String username, String password) throws SecurityException(Code) | |
Add a new user provided a username and password.
Parameters:
username - The user name.
Parameters:
password - The password.
throws:
Throws - a security exception. |
| addUser | | void addUser(String username, String password, String atnProviderName) throws SecurityException(Code) | |
Add a new user provided a username and password in the specified authentication
provider store.
Parameters:
username - The user name.
Parameters:
password - The password.
Parameters:
atnProviderName - The authentication provider name.
throws:
Throws - a security exception. |
| authenticate | | boolean authenticate(String username, String password)(Code) | |
Authenticate a user.
Parameters:
username - The user name.
Parameters:
password - The user password. Whether or not a user is authenticated. |
| getAnonymousUser | | String getAnonymousUser()(Code) | | the name of the anonymous user |
| getUser | | User getUser(String username) throws SecurityException(Code) | |
Get a
User for a given username.
Parameters:
username - The username. The User.
throws:
Throws - a security exception if the user cannot be found. |
| getUserNames | | Iterator getUserNames(String filter) throws SecurityException(Code) | |
An iterator of user names, finding users matching the corresponding
filter criteria.
TODO Complete filter implementation.
Parameters:
filter - The filter used to retrieve matching users. The Iterator of User. |
| getUsers | | Iterator getUsers(String filter) throws SecurityException(Code) | |
An iterator of
User finding users matching the corresponding
filter criteria.
TODO Complete filter implementation.
Parameters:
filter - The filter used to retrieve matching users. The Iterator of User. |
| getUsersInGroup | | Collection getUsersInGroup(String groupFullPathName) throws SecurityException(Code) | | A collection of
User for a specific group.
Parameters:
groupFullPathName - The group name full path(e.g. theGroupName.theGroupChildName). A collection of User.
throws:
Throws - security exception if the group does not exist. |
| getUsersInRole | | Collection getUsersInRole(String roleFullPathName) throws SecurityException(Code) | |
A collection of
User for all the users in a specific role.
Parameters:
roleFullPathName - The role name full path (e.g.theRoleName.theRoleNameChild). A Collection of User.
throws:
Throws - a security exception if the role does not exist. |
| importUser | | void importUser(String username, String password, boolean passThrough) throws SecurityException(Code) | |
Import a new user with username and password and allow to bypass the enconding algorithm
Parameters:
username - The user name.
Parameters:
password - The password.
Parameters:
passThrough - If true the provided password will not be validated/encoded
throws:
Throws - a security exception. |
| importUser | | void importUser(String username, String password, String atnProviderName, boolean passThrough) throws SecurityException(Code) | |
Import a new user with username and password in the specified authentication
provider store and allow to bypass the enconding algorithm
Parameters:
username - The user name.
Parameters:
password - The password.
Parameters:
atnProviderName - The authentication provider name.
Parameters:
passThrough - If true the provided password will not be validated/encoded
throws:
Throws - a security exception. |
| setPassword | | void setPassword(String username, String oldPassword, String newPassword) throws SecurityException(Code) | |
Set the user password.
Parameters:
username - The user name.
Parameters:
oldPassword - The old password.
Parameters:
newPassword - The new password.
throws:
Throws - a security exception. |
| setPasswordEnabled | | void setPasswordEnabled(String userName, boolean enabled) throws SecurityException(Code) | |
Set the enabled state of the user password credential.
Parameters:
userName - The user name.
Parameters:
enabled - The enabled state.
throws:
Throws - a security exception. |
| setPasswordExpiration | | void setPasswordExpiration(String userName, Date expirationDate) throws SecurityException(Code) | |
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.
Parameters:
userName - The user name.
Parameters:
expirationDate - The expiration date to set.
throws:
Throws - a security exception. |
| setPasswordUpdateRequired | | void setPasswordUpdateRequired(String userName, boolean updateRequired) throws SecurityException(Code) | |
Set the update required state of the user password credential.
Parameters:
userName - The user name.
Parameters:
updateRequired - The update required state.
throws:
Throws - a security exception. |
| setUserEnabled | | void setUserEnabled(String userName, boolean enabled) throws SecurityException(Code) | | Enable or disable a user.
Parameters:
userName - The user name
Parameters:
enabled - enabled flag for the user |
| userExists | | boolean userExists(String username)(Code) | |
Whether or not a user exists.
Parameters:
username - The user name. Whether or not a user exists. |
|
|