org.jbpm.api
Interface IdentityService

public interface IdentityService

interface to expose the (configurable) identity component that is used by jBPM.

Author:

Tom Baeyens

Method Summary

java.lang.String	createGroup(java.lang.String groupName) create a group new group
java.lang.String	createGroup(java.lang.String groupName, java.lang.String groupType) create a group new group
java.lang.String	createGroup(java.lang.String groupName, java.lang.String groupType, java.lang.String parentGroupId) create a group new group
void	createMembership(java.lang.String userId, java.lang.String groupId) makes the given user a member of the given group.
void	createMembership(java.lang.String userId, java.lang.String groupId, java.lang.String role) makes the given user a member of the given group with the given role.
void	createUser(java.lang.String userId, java.lang.String givenName, java.lang.String familyName) create a new user.
void	createUser(java.lang.String userId, java.lang.String givenName, java.lang.String familyName, java.lang.String businessEmail) create a new user, providing an email address
void	deleteGroup(java.lang.String groupId) deletes the given group.
void	deleteMembership(java.lang.String userId, java.lang.String groupId, java.lang.String role) deletes the identified relation between a user and a group.
void	deleteUser(java.lang.String userId) delete the given user.
Group	findGroupById(java.lang.String groupId) lookup a group.
java.util.List<java.lang.String>	findGroupIdsByUser(java.lang.String userId) all group ids (String) for which this user is a member.
java.util.List<Group>	findGroupsByUser(java.lang.String userId) all group ids (String) for which this user is a member.
java.util.List<Group>	findGroupsByUserAndGroupType(java.lang.String userId, java.lang.String groupType) groups of the given groupType for which the given user is a member.
User	findUserById(java.lang.String userId) lookup a user
java.util.List<User>	findUsers() get all the users in the system.

Method Detail

createUser

void createUser(java.lang.String userId,
                java.lang.String givenName,
                java.lang.String familyName)

create a new user.

createUser

void createUser(java.lang.String userId,
                java.lang.String givenName,
                java.lang.String familyName,
                java.lang.String businessEmail)

create a new user, providing an email address

findUserById

User findUserById(java.lang.String userId)

lookup a user

Returns:

the user or null if no such user exists

findUsers

java.util.List<User> findUsers()

get all the users in the system. Returns an empty list if no users exist.

deleteUser

void deleteUser(java.lang.String userId)

delete the given user. No effect (no exception) if the user does not exist. Deletes also the memberships related to the given user, but does not delete the associated groups.

createGroup

java.lang.String createGroup(java.lang.String groupName)

create a group new group

Returns:

the generated id for this group.

createGroup

java.lang.String createGroup(java.lang.String groupName,
                             java.lang.String groupType)

create a group new group

Returns:

the generated id for this group.

createGroup

java.lang.String createGroup(java.lang.String groupName,
                             java.lang.String groupType,
                             java.lang.String parentGroupId)

create a group new group

Returns:

the generated id for this group.

findGroupById

Group findGroupById(java.lang.String groupId)

lookup a group.

Returns:

the user or null if no such user exists

findGroupsByUserAndGroupType

java.util.List<Group> findGroupsByUserAndGroupType(java.lang.String userId,
                                                   java.lang.String groupType)

groups of the given groupType for which the given user is a member. Returns an empty list if no such groups exist.

findGroupsByUser

java.util.List<Group> findGroupsByUser(java.lang.String userId)

all group ids (String) for which this user is a member. Returns an empty list if no such groups exist.

findGroupIdsByUser

java.util.List<java.lang.String> findGroupIdsByUser(java.lang.String userId)

all group ids (String) for which this user is a member. Returns an empty list if no such groups exist.

deleteGroup

void deleteGroup(java.lang.String groupId)

deletes the given group. No effect (no exception) if the group does not exist. Deleting a group also deletes all the memberships associated to that group, but not the associated users.

createMembership

void createMembership(java.lang.String userId,
                      java.lang.String groupId)

makes the given user a member of the given group.

createMembership

void createMembership(java.lang.String userId,
                      java.lang.String groupId,
                      java.lang.String role)

makes the given user a member of the given group with the given role. Role can be null.

deleteMembership

void deleteMembership(java.lang.String userId,
                      java.lang.String groupId,
                      java.lang.String role)

deletes the identified relation between a user and a group. Role can be null. If no such membership exists, this method will not throw an exception and have no effect.