Package org.apache.catalina.users

Class AbstractGroup

java.lang.Object

org.apache.catalina.users.AbstractGroup

All Implemented Interfaces:

java.security.Principal, Group

Direct Known Subclasses:

GenericGroup

public abstract class AbstractGroup
extends java.lang.Object
implements Group

Convenience base class for Group implementations.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	description	The description of this group.
protected java.lang.String	groupname	The group name of this group.

Constructor Summary

Constructors

Constructor	Description
AbstractGroup()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
java.lang.String	getGroupname()
java.lang.String	getName()	Make the principal name the same as the group name.
void	setDescription(java.lang.String description)	Set the description of this group.
void	setGroupname(java.lang.String groupname)	Set the group name of this group, which must be unique within the scope of a UserDatabase.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.catalina.Group

addRole, getRoles, getUserDatabase, getUsers, isInRole, removeRole, removeRoles

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Field Detail

description

protected java.lang.String description

The description of this group.

groupname

protected java.lang.String groupname

The group name of this group.

Constructor Detail

AbstractGroup

public AbstractGroup()

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Group

Returns:

the description of this group.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: Group

Set the description of this group.

Specified by:

setDescription in interface Group

Parameters:

description - The new description

getGroupname

public java.lang.String getGroupname()

Specified by:

getGroupname in interface Group

Returns:

the group name of this group, which must be unique within the scope of a UserDatabase.

setGroupname

public void setGroupname(java.lang.String groupname)

Description copied from interface: Group

Set the group name of this group, which must be unique within the scope of a UserDatabase.

Specified by:

setGroupname in interface Group

Parameters:

groupname - The new group name

getName

public java.lang.String getName()

Make the principal name the same as the group name.

Specified by:

getName in interface java.security.Principal