Interface GroupManager

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    AbstractGroupManager

    public interface GroupManager
    extends Serializable
    A GroupManager performs Group objects related tasks on behalf of the BaseSecurityService. The responsibilities of this class include loading data of an group from the storage and putting them into the Group objects, saving those data to the permanent storage.
    Version:
    $Id$
    Author:
    Eric Pugh
    • Field Detail

      • ROLE

        static final String ROLE
        Avalon role - used to id the component within the manager
    • Method Detail

      • getGroupInstance

        <T extends Group> T getGroupInstance()
                                      throws DataBackendException
        Construct a blank Group object. This method calls getGroupClass, and then creates a new object using the default constructor.
        Type Parameters:
        T - The group extending Group
        Returns:
        an object implementing Group interface.
        Throws:
        DataBackendException - if the object could not be instantiated.
      • getGroupInstance

        <T extends Group> T getGroupInstance​(String groupName)
                                      throws DataBackendException
        Construct a blank Group object. This method calls getGroupClass, and then creates a new object using the default constructor.
        Type Parameters:
        T - The group of type Group
        Parameters:
        groupName - The name of the Group
        Returns:
        an object implementing Group interface.
        Throws:
        DataBackendException - if the object could not be instantiated.
      • getAllGroups

        GroupSet getAllGroups()
                       throws DataBackendException
        Retrieves all groups defined in the system.
        Returns:
        the names of all groups defined in the system.
        Throws:
        DataBackendException - if there was an error accessing the data backend.
      • checkExists

        boolean checkExists​(Group group)
                     throws DataBackendException
        Determines if the Group exists in the security system.
        Parameters:
        group - a Group value
        Returns:
        true if the group exists in the system, false otherwise
        Throws:
        DataBackendException - when more than one group with the same name exists.
      • checkExists

        boolean checkExists​(String groupName)
                     throws DataBackendException
        Determines if a Group exists in the security system with the specified name.
        Parameters:
        groupName - the name of a Group to check.
        Returns:
        true if the group exists in the system, false otherwise
        Throws:
        DataBackendException - when more than one group with the same name exists.