|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupMembershipManager
This interface allows applications to query relationships between users and groups.
Method Summary | |
---|---|
void |
addMembership(String userName,
String groupName)
Adds a user identified by userName to the group identified by groupName . |
List |
getMembers(String groupName)
Obtains a list of all users in the group identified by groupName , sorted naturally. |
List |
getMemberships(String userName)
Deprecated. Since 1.4 |
boolean |
isMember(String userName,
String groupName)
Returns true if the user represented by userName is a member of groupName |
void |
removeMembership(String userName,
String groupName)
Removes a user identified by userName from the group identified by groupName . |
Method Detail |
---|
boolean isMember(String userName, String groupName) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
userName
is a member of groupName
userName
- The user to checkgroupName
- The group to check.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidAuthenticationException
- application authentication is not validvoid addMembership(String userName, String groupName) throws RemoteException, InvalidAuthorizationTokenException, ApplicationPermissionException, GroupNotFoundException, UserNotFoundException, InvalidAuthenticationException
userName
to the group identified by groupName
. If the user
is already a member of the group, this method will return successfully.
userName
- The user to addgroupName
- The group the user will be added to
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
GroupNotFoundException
- the group could not be found
UserNotFoundException
- the user could not be found
ApplicationPermissionException
- This application does not have permission to update group memberships.
InvalidAuthenticationException
- application authentication is not validvoid removeMembership(String userName, String groupName) throws RemoteException, InvalidAuthorizationTokenException, ApplicationPermissionException, GroupNotFoundException, UserNotFoundException, MembershipNotFoundException, InvalidAuthenticationException
userName
from the group identified by groupName
. If the
user was not a member of the group, this method will return successfully.
userName
- The user to removegroupName
- The group the user will be added from
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
GroupNotFoundException
- the group could not be found
UserNotFoundException
- the user could not be found
ApplicationPermissionException
- This application does not have permission to update group memberships.
InvalidAuthenticationException
- application authentication is not valid
MembershipNotFoundException
- Unable to find membershipList getMemberships(String userName) throws RemoteException, InvalidAuthorizationTokenException, UserNotFoundException, InvalidAuthenticationException
userName
belongs to, sorted naturally.
This can be a slow call, particularly on some LDAP directories, and so should be avoided. Use
isMember()
instead.
userName
- The user whose group memberships are desired.
List
of String
s containing all the groups the user belongs to, or an empty List
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
UserNotFoundException
- If the user could not be found.
InvalidAuthenticationException
- application authentication is not validList getMembers(String groupName) throws RemoteException, InvalidAuthorizationTokenException, GroupNotFoundException, InvalidAuthenticationException
groupName
, sorted naturally.
This is a fairly fast call, but implementers should still be using isMember()
wherever practicable.
groupName
- The group whose member users are desired.
List
of String
s containing all the users in the group, or an empty list.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
GroupNotFoundException
- If the group could not be found.
InvalidAuthenticationException
- application authentication is not valid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |