public interface IdentityService
Modifier and Type | Method and Description |
---|---|
boolean |
checkPassword(String userId,
String password)
Checks if the password is valid for the given user.
|
void |
clearAuthentication()
Allows clearing the current authentication.
|
GroupQuery |
createGroupQuery()
Creates a
GroupQuery thats allows to programmatically query the groups. |
void |
createMembership(String userId,
String groupId) |
UserQuery |
createUserQuery()
Creates a
UserQuery that allows to programmatically query the users. |
void |
deleteGroup(String groupId)
Deletes the group.
|
void |
deleteMembership(String userId,
String groupId)
Delete the membership of the user in the group.
|
void |
deleteUser(String userId) |
void |
deleteUserAccount(String userId,
String accountName)
Deprecated.
|
void |
deleteUserInfo(String userId,
String key)
Delete an entry of the generic extensibility key-value pairs associated with a user
|
void |
deleteUserPicture(String userId)
Deletes the picture for a given user.
|
Authentication |
getCurrentAuthentication() |
Account |
getUserAccount(String userId,
String userPassword,
String accountName)
Deprecated.
|
List<String> |
getUserAccountNames(String userId)
Deprecated.
|
String |
getUserInfo(String userId,
String key)
Generic extensibility key-value pairs associated with a user
|
List<String> |
getUserInfoKeys(String userId)
Generic extensibility keys associated with a user
|
Picture |
getUserPicture(String userId)
Retrieves the picture for a given user.
|
boolean |
isReadOnly()
Allows to inquire whether this identity service implementation provides
read-only access to the user repository, false otherwise.
|
Group |
newGroup(String groupId)
Creates a new group.
|
User |
newUser(String userId)
Creates a new user.
|
void |
saveGroup(Group group)
Saves the group.
|
void |
saveUser(User user)
Saves the user.
|
void |
setAuthenticatedUserId(String authenticatedUserId)
Passes the authenticated user id for this thread.
|
void |
setAuthentication(Authentication currentAuthentication) |
void |
setAuthentication(String userId,
List<String> groups)
Passes the authenticated user id and groupIds for this thread.
|
void |
setUserAccount(String userId,
String userPassword,
String accountName,
String accountUsername,
String accountPassword,
Map<String,String> accountDetails)
Deprecated.
|
void |
setUserInfo(String userId,
String key,
String value)
Generic extensibility key-value pairs associated with a user
|
void |
setUserPicture(String userId,
Picture picture)
Sets the picture for a given user.
|
boolean isReadOnly()
Allows to inquire whether this identity service implementation provides read-only access to the user repository, false otherwise.
Read only identity service implementations do not support the following methods:newUser(String)
saveUser(User)
deleteUser(String)
newGroup(String)
saveGroup(Group)
deleteGroup(String)
createMembership(String, String)
deleteMembership(String, String)
If these methods are invoked on a read-only identity service implementation,
the invocation will throw an UnsupportedOperationException
.
User newUser(String userId)
saveUser(User)
.userId
- id for the new user, cannot be null.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.USER
.void saveUser(User user)
user
- user to save, cannot be null.RuntimeException
- when a user with the same name already exists.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.UPDATE
permissions on Resources.USER
(update existing user)
or if user has no Permissions.CREATE
permissions on Resources.USER
(save new user).UserQuery createUserQuery()
UserQuery
that allows to programmatically query the users.void deleteUser(String userId)
userId
- id of user to delete, cannot be null. When an id is passed
for an unexisting user, this operation is ignored.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.DELETE
permissions on Resources.USER
.Group newGroup(String groupId)
saveGroup(Group)
.groupId
- id for the new group, cannot be null.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.GROUP
.GroupQuery createGroupQuery()
GroupQuery
thats allows to programmatically query the groups.void saveGroup(Group group)
group
- group to save. Cannot be null.RuntimeException
- when a group with the same name already exists.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.UPDATE
permissions on Resources.GROUP
(update existing group)
or if user has no Permissions.CREATE
permissions on Resources.GROUP
(save new user).void deleteGroup(String groupId)
groupId
- id of the group that should be deleted, cannot be null.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.DELETE
permissions on Resources.GROUP
.void createMembership(String userId, String groupId)
userId
- the userId, cannot be null.groupId
- the groupId, cannot be null.RuntimeException
- when the given user or group doesn't exist or when the user
is already member of the group.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.GROUP_MEMBERSHIP
.void deleteMembership(String userId, String groupId)
userId
- the user's id, cannot be null.groupId
- the group's id, cannot be null.UnsupportedOperationException
- if identity service implementation is read only. See isReadOnly()
AuthorizationException
- if the user has no Permissions.DELETE
permissions on Resources.GROUP_MEMBERSHIP
.boolean checkPassword(String userId, String password)
void setAuthenticatedUserId(String authenticatedUserId)
clearAuthentication()
once the interaction is terminated.authenticatedUserId
- the id of the current user.groups
- the groups of the current user.void setAuthentication(String userId, List<String> groups)
clearAuthentication()
once the interaction is terminated.authenticatedUserId
- the id of the current user.groups
- the groups of the current user.void setAuthentication(Authentication currentAuthentication)
currentAuthentication
- Authentication getCurrentAuthentication()
void clearAuthentication()
void setUserPicture(String userId, Picture picture)
picture
- can be null to delete the picture.ProcessEngineException
- if the user doesn't exist.Picture getUserPicture(String userId)
ProcessEngineException
- if the user doesn't exist.void deleteUserPicture(String userId)
ProcessEngineException
- if the user doesn't exist.void setUserInfo(String userId, String key, String value)
String getUserInfo(String userId, String key)
List<String> getUserInfoKeys(String userId)
void deleteUserInfo(String userId, String key)
@Deprecated void setUserAccount(String userId, String userPassword, String accountName, String accountUsername, String accountPassword, Map<String,String> accountDetails)
@Deprecated List<String> getUserAccountNames(String userId)
@Deprecated Account getUserAccount(String userId, String userPassword, String accountName)
@Deprecated void deleteUserAccount(String userId, String accountName)
Copyright © 2015. All rights reserved.