com.edorasware.one.identity

Interface IdentityManager

All Known Implementing Classes:

DefaultIdentityManager

public interface IdentityManager

Manager to retrieve user and group information. All APIs are restricted to the current tenant unless specifically noted otherwise.

Method Summary

Modifier and Type	Method and Description
String	getCurrentSystemAdminUserId() Returns current tenant administrator user ID
String	getSessionUserName() Returns the display name of the current session user.
List<String>	getUsersOfGroup(String groupId) Returns all users for the given group id.
List<String>	getUsersOfGroups(Collection<String> groupIds) Returns all users for the given group ids.
boolean	isUserInAllGroups(String userId, Collection<String> groupIds) Checks if the user with the given id is a member of all groups the collection.
boolean	isUserInGroup(String userId, String groupId) Checks if the given user is a member of the group with the given id.
boolean	isUserInGroups(String userId, Collection<String> groupIds) Checks if the user with the given id is a member of at least one group in the collection.

Method Detail

getUsersOfGroup

List<String> getUsersOfGroup(String groupId)

Returns all users for the given group id.

Parameters:

groupId - the id of the group

Returns:

list of users for the given group id.

Throws:

IllegalArgumentException - if the given group id is null

EntityNotFoundException - if a group with the given id does not exist

getUsersOfGroups

List<String> getUsersOfGroups(Collection<String> groupIds)

Returns all users for the given group ids.

Parameters:

groupIds - the ids of the groups

Returns:

list of users for the given group ids.

Throws:

IllegalArgumentException - if one of the given group ids is null

EntityNotFoundException - if one of the groups with the given id does not exist

isUserInGroup

boolean isUserInGroup(String userId,
                      String groupId)

Checks if the given user is a member of the group with the given id.

Parameters:

userId - the user id, not null

groupId - the group id, not null

Returns:

true if the user with the given id is member of the group with the given id, false otherwise

Throws:

IllegalArgumentException - if the given group or user id is null

EntityNotFoundException - if the user or the group with the given id does not exist

isUserInGroups

boolean isUserInGroups(String userId,
                       Collection<String> groupIds)

Checks if the user with the given id is a member of at least one group in the collection.

Parameters:

userId - the user id, not null

groupIds - collection of group Ids, not null

Returns:

true if the user with the given id is member of at least one group in the collection, false otherwise, in case of empty collection false is returned

Throws:

IllegalArgumentException - if the given collection of groups or user id is null

EntityNotFoundException - if the user or the group with the given id does not exist

isUserInAllGroups

boolean isUserInAllGroups(String userId,
                          Collection<String> groupIds)

Checks if the user with the given id is a member of all groups the collection.

Parameters:

userId - the user id, not null

groupIds - collection of group Ids, not null

Returns:

true if the user with the given id is member of all groups in the collection, false otherwise, , in case of empty collection false is returned

Throws:

IllegalArgumentException - if the given collection of groups or user id is null

EntityNotFoundException - if the user or the group with the given id does not exist

getSessionUserName

String getSessionUserName()

Returns the display name of the current session user. It also adds the information if the user is impersonated by another user. Example: If the user is not impersonated it will return: "Firstname Lastname", else it will return "Firstname1 Lastname1 on behalf of Firstname2 Lastname2".

Returns:

the session user name

getCurrentSystemAdminUserId

String getCurrentSystemAdminUserId()

Returns current tenant administrator user ID

Returns:

the administrator userId