Package io.continual.iam.identity
Interface Group
-
- All Superinterfaces:
UserDataHolder
- All Known Implementing Classes:
CommonJsonGroup
public interface Group extends UserDataHolder
A group of users
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetId()Get an identifier for this groupSet<String>getMembers()Get members of the groupStringgetName()Get a readable name for this groupbooleanisMember(String userId)Is the given user a member of this group?-
Methods inherited from interface io.continual.iam.identity.UserDataHolder
getAllUserData, getUserData, putUserData, reload, removeUserData
-
-
-
-
Method Detail
-
getId
String getId()
Get an identifier for this group- Returns:
- a string id
-
getName
String getName()
Get a readable name for this group- Returns:
- a name that's not necessarily unique in the system
-
isMember
boolean isMember(String userId) throws IamSvcException
Is the given user a member of this group?- Parameters:
userId- a user ID- Returns:
- true if the user is a member
- Throws:
IamSvcException- if there's a problem in the IAM service
-
getMembers
Set<String> getMembers() throws IamSvcException
Get members of the group- Returns:
- a set of 0 or more user IDs
- Throws:
IamSvcException- if there's a problem in the IAM service
-
-