Schnittstelle GroupManager

Alle Superschnittstellen:
Serializable
Alle bekannten Implementierungsklassen:
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$
Autor:
Eric Pugh
  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
    Avalon role - used to id the component within the manager
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    <T extends Group>
    T
    addGroup(T group)
    Creates a new group with specified attributes.
    boolean
    checkExists(String groupName)
    Determines if a Group exists in the security system with the specified name.
    boolean
    Determines if the Group exists in the security system.
    Retrieves all groups defined in the system.
    <T extends Group>
    T
    Retrieve a Group object with specified Id.
    <T extends Group>
    T
    Retrieve a Group object with specified name.
    <T extends Group>
    T
    Construct a blank Group object.
    <T extends Group>
    T
    Construct a blank Group object.
    void
    Removes a Group from the system.
    void
    renameGroup(Group group, String name)
    Renames an existing Group.
  • Felddetails

    • ROLE

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

    • 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.
      Typparameter:
      T - The group extending Group
      Gibt zurück:
      an object implementing Group interface.
      Löst aus:
      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.
      Typparameter:
      T - The group of type Group
      Parameter:
      groupName - The name of the Group
      Gibt zurück:
      an object implementing Group interface.
      Löst aus:
      DataBackendException - if the object could not be instantiated.
    • getGroupByName

      <T extends Group> T getGroupByName(String name) throws DataBackendException, UnknownEntityException
      Retrieve a Group object with specified name.
      Typparameter:
      T - The group of type Group
      Parameter:
      name - the name of the Group.
      Gibt zurück:
      an object representing the Group with specified name.
      Löst aus:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the group does not exist.
    • getGroupById

      <T extends Group> T getGroupById(Object id) throws DataBackendException, UnknownEntityException
      Retrieve a Group object with specified Id.
      Typparameter:
      T - Group type
      Parameter:
      id - the Id of the Group.
      Gibt zurück:
      an object representing the Group with specified name.
      Löst aus:
      UnknownEntityException - if the permission does not exist in the database.
      DataBackendException - if there is a problem accessing the storage.
    • renameGroup

      void renameGroup(Group group, String name) throws DataBackendException, UnknownEntityException
      Renames an existing Group.
      Parameter:
      group - The object describing the group to be renamed.
      name - the new name for the group.
      Löst aus:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the group does not exist.
    • removeGroup

      void removeGroup(Group group) throws DataBackendException, UnknownEntityException
      Removes a Group from the system.
      Parameter:
      group - The object describing the group to be removed.
      Löst aus:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the group does not exist.
    • addGroup

      <T extends Group> T addGroup(T group) throws DataBackendException, EntityExistsException
      Creates a new group with specified attributes.
      Typparameter:
      T -
      Parameter:
      group - the object describing the group to be created.
      Gibt zurück:
      the new Group object.
      Löst aus:
      DataBackendException - if there was an error accessing the data backend.
      EntityExistsException - if the group already exists.
    • getAllGroups

      GroupSet getAllGroups() throws DataBackendException
      Retrieves all groups defined in the system.
      Gibt zurück:
      the names of all groups defined in the system.
      Löst aus:
      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.
      Parameter:
      group - a Group value
      Gibt zurück:
      true if the group exists in the system, false otherwise
      Löst aus:
      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.
      Parameter:
      groupName - the name of a Group to check.
      Gibt zurück:
      true if the group exists in the system, false otherwise
      Löst aus:
      DataBackendException - when more than one group with the same name exists.