|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IdentityStore
The identity store does the actual work of persisting user accounts in a database, LDAP directory, etc.
Nested Class Summary | |
---|---|
static class |
IdentityStore.Feature
|
static class |
IdentityStore.FeatureSet
Represents a set of optional features that an IdentityStore implementation might support. |
Method Summary | |
---|---|
boolean |
addRoleToGroup(String role,
String group)
Adds the specified role as a member of the specified group. |
boolean |
authenticate(String username,
String password)
Authenticates the specified user, using the specified password. |
boolean |
changePassword(String name,
String password)
Changes the password of the specified user to the specified password. |
boolean |
createRole(String role)
Creates a new role with the specified role name. |
boolean |
createUser(String username,
String password)
Creates a new user with the specified username and password. |
boolean |
createUser(String username,
String password,
String firstname,
String lastname)
Creates a new user with the specified username, password, first name and last name. |
boolean |
deleteRole(String role)
Deletes the specified role. |
boolean |
deleteUser(String name)
Deletes the user with the specified username. |
boolean |
disableUser(String name)
Disables the user with the specified username. |
boolean |
enableUser(String name)
Enables the user with the specified username. |
List<String> |
getGrantedRoles(String name)
Returns a list of all the roles explicitly granted to the specified user. |
List<String> |
getImpliedRoles(String name)
Returns a list of all roles that the specified user is a member of. |
List<String> |
getRoleGroups(String name)
Returns a list of all the groups that the specified role is a member of. |
boolean |
grantRole(String name,
String role)
Grants the specified role to the specified user. |
boolean |
isUserEnabled(String name)
Returns true if the specified user is enabled. |
List<String> |
listGrantableRoles()
Returns a list of roles that can be granted (i.e, excluding conditional roles) |
List<String> |
listRoles()
Returns a list of all the roles. |
List<String> |
listUsers()
Returns a list of all users. |
List<String> |
listUsers(String filter)
Returns a list of all users containing the specified filter text within their username. |
boolean |
removeRoleFromGroup(String role,
String group)
Removes the specified role from the specified group. |
boolean |
revokeRole(String name,
String role)
Revokes the specified role from the specified user. |
boolean |
roleExists(String name)
Returns true if the specified role exists. |
boolean |
supportsFeature(IdentityStore.Feature feature)
Returns true if the IdentityStore implementation supports the specified feature. |
boolean |
userExists(String name)
Returns true if the specified user exists. |
Method Detail |
---|
boolean supportsFeature(IdentityStore.Feature feature)
boolean createUser(String username, String password)
boolean createUser(String username, String password, String firstname, String lastname)
boolean deleteUser(String name)
boolean enableUser(String name)
boolean disableUser(String name)
boolean isUserEnabled(String name)
boolean changePassword(String name, String password)
boolean userExists(String name)
boolean createRole(String role)
boolean grantRole(String name, String role)
name
- The name of the userrole
- The name of the role to grant to the user.
boolean revokeRole(String name, String role)
name
- The name of the userrole
- The name of the role to grant to the user.
boolean deleteRole(String role)
boolean roleExists(String name)
boolean addRoleToGroup(String role, String group)
role
- The name of the role to add as a membergroup
- The name of the group that the specified role will be added to.
boolean removeRoleFromGroup(String role, String group)
role
- The name of the role to remove from the group.group
- The group from which to remove the role.
List<String> listUsers()
List<String> listUsers(String filter)
List<String> listRoles()
List<String> listGrantableRoles()
List<String> getGrantedRoles(String name)
List<String> getImpliedRoles(String name)
List<String> getRoleGroups(String name)
boolean authenticate(String username, String password)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |