org.jbpm.pvm.internal.identity.spi
Interface IdentitySession

All Known Implementing Classes:

IdentitySessionImpl, JBossIdmIdentitySessionImpl

public interface IdentitySession

Author:

Tom Baeyens

Method Summary

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, java.lang.String role) makes the given user a member of the given group with the given role.
java.lang.String	createUser(java.lang.String userId, java.lang.String givenName, java.lang.String familyName, java.lang.String businessEmail) create a new user
void	deleteGroup(java.lang.String groupId) deletes the given group.
void	deleteMembership(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	deleteUser(java.lang.String userId) delete the given user.
Group	findGroupById(java.lang.String groupId) lookup a group.
java.util.List<Group>	findGroupsByUser(java.lang.String userId) all groups 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.
java.util.List<User>	findUsersByGroup(java.lang.String groupId) lookup users with membership in group.
java.util.List<User>	findUsersById(java.lang.String... userIds) lookup users with the given identifiers.

Method Detail

createUser

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

create a new user

findUserById

User findUserById(java.lang.String userId)

lookup a user.

Returns:

the user or null if no such user exists

findUsersById

java.util.List<User> findUsersById(java.lang.String... userIds)

lookup users with the given identifiers.

Returns:

an empty list if no such users exist

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.

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.

findUsersByGroup

java.util.List<User> findUsersByGroup(java.lang.String groupId)

lookup users with membership in group.

Returns:

the users or an empty list if no users exist

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 groups 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.

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)

makes the given user a member of the given group with the given role. Role can be null. If no such membership exists, this method will not throw an exception and have no effect.