Package org.apache.catalina.users

# Class MemoryGroup

java.lang.Object
org.apache.catalina.users.AbstractGroup
org.apache.catalina.users.MemoryGroup

All Implemented Interfaces:
  `Principal`, `Group`

@Deprecated public class MemoryGroup extends AbstractGroup
Deprecated.
Use `AbstractGroup` instead.

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

Since:
  4.1
Author:
  Craig R. McClanahan

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected final MemoryUserDatabase`
  `database`
  Deprecated.
  The `MemoryUserDatabase` that owns this group.
  `protected final CopyOnWriteArrayList<Role>`
  `roles`
  Deprecated.
  The set of `Role`s associated with this group.

  ### Fields inherited from class org.apache.catalina.users.AbstractGroup

  `description, groupname`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addRole(Role role)`
  Deprecated.
  Add a new `Role` to those assigned specifically to this group.
  `Iterator<Role>`
  `getRoles()`
  Deprecated.
  Return the set of `Role`s assigned specifically to this group.
  `UserDatabase`
  `getUserDatabase()`
  Deprecated.
  Return the `UserDatabase` within which this Group is defined.
  `Iterator<User>`
  `getUsers()`
  Deprecated.
  Return the set of `User`s that are members of this group.
  `boolean`
  `isInRole(Role role)`
  Deprecated.
  Is this group specifically assigned the specified `Role`?
  `void`
  `removeRole(Role role)`
  Deprecated.
  Remove a `Role` from those assigned to this group.
  `void`
  `removeRoles()`
  Deprecated.
  Remove all `Role`s from those assigned to this group.
  `String`
  `toString()`
  Deprecated.
  Return a String representation of this group in XML format.

  ### Methods inherited from class org.apache.catalina.users.AbstractGroup

  `getDescription, getGroupname, getName, setDescription, setGroupname`

  ### 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, implies`

- ## Field Details

  - ### database

    protected final MemoryUserDatabase database
    Deprecated.
    The `MemoryUserDatabase` that owns this group.

  - ### roles

    protected final CopyOnWriteArrayList<Role> roles
    Deprecated.
    The set of `Role`s associated with this group.

- ## Method Details

  - ### getRoles

    public Iterator<Role> getRoles()
    Deprecated.
    Return the set of `Role`s assigned specifically to this group.
    Specified by:
      `getRoles` in interface `Group`
    Specified by:
      `getRoles` in class `AbstractGroup`
    Returns:
      the set of `Role`s assigned specifically to this group.

  - ### getUserDatabase

    public UserDatabase getUserDatabase()
    Deprecated.
    Return the `UserDatabase` within which this Group is defined.
    Specified by:
      `getUserDatabase` in interface `Group`
    Specified by:
      `getUserDatabase` in class `AbstractGroup`
    Returns:
      the `UserDatabase` within which this Group is defined.

  - ### getUsers

    public Iterator<User> getUsers()
    Deprecated.
    Return the set of `User`s that are members of this group.
    Specified by:
      `getUsers` in interface `Group`
    Specified by:
      `getUsers` in class `AbstractGroup`
    Returns:
      the set of `User`s that are members of this group.

  - ### addRole

    public void addRole(Role role)
    Deprecated.
    Add a new `Role` to those assigned specifically to this group.
    Specified by:
      `addRole` in interface `Group`
    Specified by:
      `addRole` in class `AbstractGroup`
    Parameters:
      `role` - The new role

  - ### isInRole

    public boolean isInRole(Role role)
    Deprecated.
    Is this group specifically assigned the specified `Role`?
    Specified by:
      `isInRole` in interface `Group`
    Specified by:
      `isInRole` in class `AbstractGroup`
    Parameters:
      `role` - The role to check
    Returns:
      `true` if the group is assigned to the specified role otherwise `false`

  - ### removeRole

    public void removeRole(Role role)
    Deprecated.
    Remove a `Role` from those assigned to this group.
    Specified by:
      `removeRole` in interface `Group`
    Specified by:
      `removeRole` in class `AbstractGroup`
    Parameters:
      `role` - The old role

  - ### removeRoles

    public void removeRoles()
    Deprecated.
    Remove all `Role`s from those assigned to this group.
    Specified by:
      `removeRoles` in interface `Group`
    Specified by:
      `removeRoles` in class `AbstractGroup`

  - ### toString

    public String toString()
    Deprecated.

    Return a String representation of this group in XML format.

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