|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.security.impl.UserManagerImpl
public class UserManagerImpl
Implementation for managing users and provides access to the User
.
Constructor Summary | |
---|---|
UserManagerImpl(SecurityProvider securityProvider)
|
|
UserManagerImpl(SecurityProvider securityProvider,
HierarchyResolver roleHierarchyResolver,
HierarchyResolver groupHierarchyResolver)
|
|
UserManagerImpl(SecurityProvider securityProvider,
HierarchyResolver roleHierarchyResolver,
HierarchyResolver groupHierarchyResolver,
java.lang.String anonymousUser)
|
|
UserManagerImpl(SecurityProvider securityProvider,
java.lang.String anonymousUser)
|
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. |
protected void |
createUser(java.lang.String username,
java.lang.String password,
java.lang.String atnProviderName,
boolean raw)
|
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 |
setRolesInheritableViaGroups(boolean rolesInheritableViaGroups)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserManagerImpl(SecurityProvider securityProvider)
securityProvider
- The security provider.public UserManagerImpl(SecurityProvider securityProvider, java.lang.String anonymousUser)
securityProvider
- The security provider.anonymousUser
- The anonymous user namepublic UserManagerImpl(SecurityProvider securityProvider, HierarchyResolver roleHierarchyResolver, HierarchyResolver groupHierarchyResolver)
securityProvider
- The security provider.roleHierarchyResolver
- The role hierachy resolver.groupHierarchyResolver
- The group hierarchy resolver.public UserManagerImpl(SecurityProvider securityProvider, HierarchyResolver roleHierarchyResolver, HierarchyResolver groupHierarchyResolver, java.lang.String anonymousUser)
securityProvider
- The security provider.roleHierarchyResolver
- The role hierachy resolver.groupHierarchyResolver
- The group hierarchy resolver.anonymousUser
- The anonymous user nameMethod Detail |
---|
public java.lang.String getAnonymousUser()
getAnonymousUser
in interface UserManager
public void setRolesInheritableViaGroups(boolean rolesInheritableViaGroups)
public boolean authenticate(java.lang.String username, java.lang.String password)
UserManager
Authenticate a user.
authenticate
in interface UserManager
username
- The user name.password
- The user password.
UserManager.authenticate(java.lang.String,
java.lang.String)
public void addUser(java.lang.String username, java.lang.String password) throws SecurityException
UserManager
Add a new user provided a username and password.
addUser
in interface UserManager
username
- The user name.password
- The password.
SecurityException
UserManager.addUser(java.lang.String,
java.lang.String)
public void addUser(java.lang.String username, java.lang.String password, java.lang.String atnProviderName) throws SecurityException
UserManager
Add a new user provided a username and password in the specified authentication provider store.
addUser
in interface UserManager
username
- The user name.password
- The password.atnProviderName
- The authentication provider name.
SecurityException
UserManager.addUser(java.lang.String,
java.lang.String, java.lang.String)
public void importUser(java.lang.String username, java.lang.String password, boolean passThrough) throws SecurityException
UserManager
Import a new user with username and password and allow to bypass the enconding algorithm
importUser
in interface UserManager
username
- The user name.password
- The password.passThrough
- If true the provided password will not be validated/encoded
SecurityException
UserManager.importUser(java.lang.String,
java.lang.String, boolean)
public void importUser(java.lang.String username, java.lang.String password, java.lang.String atnProviderName, boolean passThrough) throws SecurityException
UserManager
Import a new user with username and password in the specified authentication provider store and allow to bypass the enconding algorithm
importUser
in interface UserManager
username
- The user name.password
- The password.atnProviderName
- The authentication provider name.passThrough
- If true the provided password will not be validated/encoded
SecurityException
UserManager.importUser(java.lang.String,
java.lang.String, java.lang.String, boolean)
protected void createUser(java.lang.String username, java.lang.String password, java.lang.String atnProviderName, boolean raw) throws SecurityException
SecurityException
UserManager.addUser(java.lang.String,
java.lang.String, java.lang.String)
public void removeUser(java.lang.String username) throws SecurityException
UserManager
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.
removeUser
in interface UserManager
username
- The user name.
SecurityException
TODO Enforce that only administrators can do this.
public boolean userExists(java.lang.String username)
UserManager
Whether or not a user exists.
userExists
in interface UserManager
username
- The user name.
UserManager.userExists(java.lang.String)
public User getUser(java.lang.String username) throws SecurityException
UserManager
Get a User
for a given username.
getUser
in interface UserManager
username
- The username.
User
.
SecurityException
UserManager.getUser(java.lang.String)
public java.util.Iterator getUsers(java.lang.String filter) throws SecurityException
UserManager
An iterator of User
finding users matching the corresponding
filter criteria.
getUsers
in interface UserManager
filter
- The filter used to retrieve matching users.
User
.
SecurityException
UserManager.getUsers(java.lang.String)
public java.util.Iterator getUserNames(java.lang.String filter) throws SecurityException
UserManager
An iterator of user names, finding users matching the corresponding filter criteria.
TODO Complete filter implementation.
getUserNames
in interface UserManager
filter
- The filter used to retrieve matching users.
User
.
SecurityException
UserManager.getUserNames(java.lang.String)
public java.util.Collection getUsersInRole(java.lang.String roleFullPathName) throws SecurityException
UserManager
A collection of User
for all the users in a specific role.
getUsersInRole
in interface UserManager
roleFullPathName
- The role name full path (e.g.
theRoleName.theRoleNameChild).
User
.
SecurityException
UserManager.getUsersInRole(java.lang.String)
public java.util.Collection getUsersInGroup(java.lang.String groupFullPathName) throws SecurityException
UserManager
A collection of User
for a specific group.
getUsersInGroup
in interface UserManager
groupFullPathName
- The group name full path
(e.g. theGroupName.theGroupChildName).
User
.
SecurityException
UserManager.getUsersInGroup(java.lang.String)
public void setPassword(java.lang.String username, java.lang.String oldPassword, java.lang.String newPassword) throws SecurityException
UserManager
Set the user password.
setPassword
in interface UserManager
username
- The user name.oldPassword
- The old password.newPassword
- The new password.
SecurityException
TODO Enforce that only administrators can do this.
public void setPasswordEnabled(java.lang.String userName, boolean enabled) throws SecurityException
UserManager
Set the enabled state of the user password credential.
setPasswordEnabled
in interface UserManager
userName
- The user name.enabled
- The enabled state.
SecurityException
UserManager.setPasswordEnabled(java.lang.String,
boolean)
public void setPasswordUpdateRequired(java.lang.String userName, boolean updateRequired) throws SecurityException
UserManager
Set the update required state of the user password credential.
setPasswordUpdateRequired
in interface UserManager
userName
- The user name.updateRequired
- The update required state.
SecurityException
UserManager.setPasswordUpdateRequired(java.lang.String,
boolean)
public void setUserEnabled(java.lang.String userName, boolean enabled) throws SecurityException
UserManager
setUserEnabled
in interface UserManager
userName
- The user nameenabled
- enabled flag for the user
SecurityException
UserManager.setUserEnabled(java.lang.String, boolean)
public void setPasswordExpiration(java.lang.String userName, java.sql.Date expirationDate) throws SecurityException
UserManager
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.
setPasswordExpiration
in interface UserManager
userName
- The user name.expirationDate
- The expiration date to set.
SecurityException
UserManager.setPasswordExpiration(java.lang.String, java.sql.Date)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |