MemoryRole (Apache Tomcat 8.5.53 API Documentation)

org.apache.catalina.users

## Class MemoryRole

- java.lang.Object
- - org.apache.catalina.users.AbstractRole
  - - org.apache.catalina.users.MemoryRole

- All Implemented Interfaces:
    Principal, Role

      public class MemoryRole
      extends AbstractRole

  Concrete implementation of `Role` for the `MemoryUserDatabase` implementation of `UserDatabase`.

  Since:
    4.1
  Author:
    Craig R. McClanahan

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected MemoryUserDatabase` | `database` The `MemoryUserDatabase` that owns this role.

    - ### Fields inherited from class org.apache.catalina.users.AbstractRole

      `description, rolename`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `UserDatabase` | `getUserDatabase()` Return the `UserDatabase` within which this role is defined.
    `String` | `toString()` Return a String representation of this role in XML format.

    - ### Methods inherited from class org.apache.catalina.users.AbstractRole

      `getDescription, getName, getRolename, setDescription, setRolename`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface java.security.Principal

      `equals, hashCode`

- - ### Field Detail

    - #### database

          protected final MemoryUserDatabase database

      The `MemoryUserDatabase` that owns this role.

  - ### Method Detail

    - #### getUserDatabase

          public UserDatabase getUserDatabase()

      Return the `UserDatabase` within which this role is defined.
      Specified by:
        `getUserDatabase` in interface `Role`
      Specified by:
        `getUserDatabase` in class `AbstractRole`
      Returns:
        the `UserDatabase` within which this Role is defined.

    - #### toString

          public String toString()

      Return a String representation of this role in XML format.

      Specified by:
        `toString` in interface `Principal`
      Overrides:
        `toString` in class `Object`

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.