Package com.atlassian.crowd.manager.application

Interface DefaultGroupMembershipService

All Known Implementing Classes:
DefaultGroupMembershipServiceImpl, NoOpDefaultGroupMembershipService
public interface DefaultGroupMembershipService
The service for configuring default group memberships.
Since:
v3.1.0

  • Method Details

    • add

      void add(Application application, ApplicationDirectoryMapping directoryMapping, String groupName) throws OperationFailedException
      Adds a new default group membership for the given application and group.
      Parameters:
      application - the application for which the default group membership will be created
      directoryMapping - directory mapping between the application and the directory from which the group originates, must be added to the application before calling this method
      groupName - the name of the group in the default group membership configuration
      Throws:
      OperationFailedException - when the directory mapping does not exist

    • remove

      void remove(Application application, ApplicationDirectoryMapping directoryMapping, String groupName) throws OperationFailedException
      Removes a default group membership configuration for the given application and group.
      Parameters:
      application - the application for which the default group membership will be removed
      directoryMapping - directory mapping between the application and the directory from which the group originates, must be added to the application before calling this method
      groupName - the name of the group in the default group membership configuration
      Throws:
      OperationFailedException - when the directory mapping does not exist

    • listAll

      List<String> listAll(Application application, ApplicationDirectoryMapping directoryMapping) throws OperationFailedException
      Lists all default group membership configurations for the given application/directory combination
      Parameters:
      application - the application for which the default group memberships should be listed
      directoryMapping - directory mapping between the application and the directory from which the group originates, must be added to the application before calling this method
      Returns:
      a list of group names representing the default group memberships for the given application/directory combination
      Throws:
      OperationFailedException - when the directory mapping does not exist