|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupManager
Methods related to operations on groups, but not on their users.
Method Summary | |
---|---|
SOAPGroup |
addGroup(SOAPGroup group)
Adds group to the Crowd server. |
List |
getAllGroupNames()
Deprecated. Since 1.4. |
SOAPGroup |
getGroup(String groupName)
Given a groupName , returns a SOAPGroup that represents the group. |
boolean |
isGroup(String groupName)
Returns true if groupName represents a valid group, false otherwise. |
void |
removeGroup(String groupName)
Removes a group from Crowd. |
List |
searchGroups(SearchRestriction[] restrictions)
Searches the list of all available groups based on the passed-in restrictions and returns a list
of groups that match. |
void |
updateGroup(SOAPGroup group)
Updates a group's details in Crowd. |
Method Detail |
---|
boolean isGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
groupName
represents a valid group, false otherwise.
groupName
- The name 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 validSOAPGroup getGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, GroupNotFoundException, InvalidAuthenticationException
groupName
, returns a SOAPGroup
that represents the group. This group object
will not have any membership information associated with it.
groupName
- The name of the group to fetch
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.
InvalidAuthenticationException
- application authentication is not validSOAPGroup addGroup(SOAPGroup group) throws RemoteException, InvalidGroupException, InvalidAuthorizationTokenException, ApplicationPermissionException, InvalidAuthenticationException
group
to the Crowd server.
group
- The object containing the details of the group.
SOAPGroup
, as returned by the Crowd server.
RemoteException
- A communication error occurred - the Crowd server may not be available.
InvalidAuthorizationTokenException
- The application (not the user) was not authenticated correctly.
InvalidGroupException
- Could not add the group - it may be malformed, or a group with that name may already exist.
ApplicationPermissionException
- The application does not have permission to add groups.
InvalidAuthenticationException
- application authentication is not validList searchGroups(SearchRestriction[] restrictions) throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
restrictions
and returns a list
of groups that match.
restrictions
- search restrictions
List
of SOAPGroup
s that match the criteria.
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 updateGroup(SOAPGroup group) throws RemoteException, ApplicationPermissionException, InvalidAuthorizationTokenException, GroupNotFoundException, InvalidAuthenticationException
group
- The group to update
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 to update could not be found.
ApplicationPermissionException
- The application does not have permission to update groups.
InvalidAuthenticationException
- application authentication is not validvoid removeGroup(String groupName) throws RemoteException, InvalidAuthorizationTokenException, GroupNotFoundException, ApplicationPermissionException, InvalidAuthenticationException
groupName
- The name of the group to remove.
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 to remove could not be found.
ApplicationPermissionException
- The application does not have permission to remove groups.
InvalidAuthenticationException
- application authentication is not validList getAllGroupNames() throws RemoteException, InvalidAuthorizationTokenException, InvalidAuthenticationException
List
of String
s that list all the groups visible to this application.
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 valid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |