com.atlassian.crowd.service
Interface GroupManager

All Known Implementing Classes:

CachingGroupManager

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

isGroup

boolean isGroup(String groupName)
                throws RemoteException,
                       InvalidAuthorizationTokenException,
                       InvalidAuthenticationException

Returns true if groupName represents a valid group, false otherwise.

Parameters:

groupName - The name to check

Returns:

true if it's a group, false otherwise

Throws:

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

getGroup

SOAPGroup getGroup(String groupName)
                   throws RemoteException,
                          InvalidAuthorizationTokenException,
                          GroupNotFoundException,
                          InvalidAuthenticationException

Given a groupName, returns a SOAPGroup that represents the group. This group object will not have any membership information associated with it.

Parameters:

groupName - The name of the group to fetch

Returns:

An object representing the group, or null if it does not exist

Throws:

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 valid

addGroup

SOAPGroup addGroup(SOAPGroup group)
                   throws RemoteException,
                          InvalidGroupException,
                          InvalidAuthorizationTokenException,
                          ApplicationPermissionException,
                          InvalidAuthenticationException

Adds group to the Crowd server.

Parameters:

group - The object containing the details of the group.

Returns:

The SOAPGroup, as returned by the Crowd server.

Throws:

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 valid

searchGroups

List searchGroups(SearchRestriction[] restrictions)
                  throws RemoteException,
                         InvalidAuthorizationTokenException,
                         InvalidAuthenticationException

Searches the list of all available groups based on the passed-in restrictions and returns a list of groups that match.

Parameters:

restrictions - search restrictions

Returns:

A List of SOAPGroups that match the criteria.

Throws:

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

updateGroup

void updateGroup(SOAPGroup group)
                 throws RemoteException,
                        ApplicationPermissionException,
                        InvalidAuthorizationTokenException,
                        GroupNotFoundException,
                        InvalidAuthenticationException

Updates a group's details in Crowd.

Parameters:

group - The group to update

Throws:

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 valid

removeGroup

void removeGroup(String groupName)
                 throws RemoteException,
                        InvalidAuthorizationTokenException,
                        GroupNotFoundException,
                        ApplicationPermissionException,
                        InvalidAuthenticationException

Removes a group from Crowd.

Parameters:

groupName - The name of the group to remove.

Throws:

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 valid

getAllGroupNames

List getAllGroupNames()
                      throws RemoteException,
                             InvalidAuthorizationTokenException,
                             InvalidAuthenticationException

Deprecated. Since 1.4.

Returns a list of all available groups. We recommend against use of this method; depending on the environment, it may prevent your app from scaling. Some large organisations build very complex group processioning structures, with total group numbers in the tens of thousands.

Returns:

A List of Strings that list all the groups visible to this application.

Throws:

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