Class AbstractRole

java.lang.Object
org.apache.catalina.users.AbstractRole
All Implemented Interfaces:
Principal, Role
Direct Known Subclasses:
GenericRole
public abstract class AbstractRole extends Object implements Role

Convenience base class for Role implementations.

Since:
4.1

  • Field Details

    • description

      protected String description
      The description of this Role.

    • rolename

      protected String rolename
      The role name of this Role.

  • Constructor Details

    • AbstractRole

      public AbstractRole()
      Constructs a new AbstractRole.

  • Method Details

    • getDescription

      public String getDescription()
      Description copied from interface: Role
      Gets the description of this role.
      Specified by:
      getDescription in interface Role
      Returns:
      The description of this role

    • setDescription

      public void setDescription(String description)
      Description copied from interface: Role
      Sets the description of this role.
      Specified by:
      setDescription in interface Role
      Parameters:
      description - The new description

    • getRolename

      public String getRolename()
      Description copied from interface: Role
      Gets the role name of this role, which must be unique within the scope of a UserDatabase.
      Specified by:
      getRolename in interface Role
      Returns:
      The role name

    • setRolename

      public void setRolename(String rolename)
      Description copied from interface: Role
      Sets the role name of this role, which must be unique within the scope of a UserDatabase.
      Specified by:
      setRolename in interface Role
      Parameters:
      rolename - The new role name

    • getName

      public String getName()
      Make the principal name the same as the role name.
      Specified by:
      getName in interface Principal