Interface RoleManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractRoleManager

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

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Avalon role - used to id the component within the manager
  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends Role>
    T
    addRole(T role)
    Creates a new role with specified attributes.
    boolean
    checkExists(String roleName)
    Determines if a Role exists in the security system with the specified role name.
    boolean
    Determines if the Role exists in the security system.
    Retrieves all roles defined in the system.
    <T extends Role>
    T
    Retrieve a Role object with specified Id.
    <T extends Role>
    T
    Retrieve a Role object with specified name.
    <T extends Role>
    T
    Construct a blank Role object This method calls getRoleClass, and then creates a new object using the default constructor.
    <T extends Role>
    T
    Construct a blank Role object.
    void
    Removes a Role from the system.
    void
    renameRole(Role role, String name)
    Renames an existing Role.
  • Field Details

    • ROLE

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

    • getRoleInstance

      <T extends Role> T getRoleInstance() throws DataBackendException
      Construct a blank Role object This method calls getRoleClass, and then creates a new object using the default constructor.
      Type Parameters:
      T - role type
      Returns:
      an object implementing Role interface.
      Throws:
      DataBackendException - if the object could not be instantiated
    • getRoleInstance

      <T extends Role> T getRoleInstance(String roleName) throws DataBackendException
      Construct a blank Role object. This method calls getRoleClass, and then creates a new object using the default constructor.
      Type Parameters:
      T - Role
      Parameters:
      roleName - The name of the Role
      Returns:
      an object implementing Role interface.
      Throws:
      DataBackendException - if the object could not be instantiated.
    • getRoleByName

      <T extends Role> T getRoleByName(String name) throws DataBackendException, UnknownEntityException
      Retrieve a Role object with specified name.
      Type Parameters:
      T - Role
      Parameters:
      name - the name of the Role.
      Returns:
      an object representing the Role with specified name.
      Throws:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the role does not exist.
    • getRoleById

      <T extends Role> T getRoleById(Object id) throws DataBackendException, UnknownEntityException
      Retrieve a Role object with specified Id.
      Type Parameters:
      T - Role
      Parameters:
      id - the Id of the Role.
      Returns:
      an object representing the Role with specified name.
      Throws:
      UnknownEntityException - if the permission does not exist in the database.
      DataBackendException - if there is a problem accessing the storage.
    • getAllRoles

      RoleSet getAllRoles() throws DataBackendException
      Retrieves all roles defined in the system.
      Returns:
      the names of all roles defined in the system.
      Throws:
      DataBackendException - if there was an error accessing the data backend.
    • addRole

      <T extends Role> T addRole(T role) throws DataBackendException, EntityExistsException
      Creates a new role with specified attributes.
      Type Parameters:
      T - Role
      Parameters:
      role - The object describing the role to be created.
      Returns:
      the new Role object.
      Throws:
      DataBackendException - if there was an error accessing the data backend.
      EntityExistsException - if the role already exists.
    • removeRole

      void removeRole(Role role) throws DataBackendException, UnknownEntityException
      Removes a Role from the system.
      Parameters:
      role - The object describing the role to be removed.
      Throws:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the role does not exist.
    • renameRole

      void renameRole(Role role, String name) throws DataBackendException, UnknownEntityException
      Renames an existing Role.
      Parameters:
      role - The object describing the role to be renamed.
      name - the new name for the role.
      Throws:
      DataBackendException - if there was an error accessing the data backend.
      UnknownEntityException - if the role does not exist.
    • checkExists

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

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