org.apache.catalina.users
Class AbstractRole

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

All Implemented Interfaces:

Principal, Role

Direct Known Subclasses:

MemoryRole

public abstract class AbstractRole
extends Object
implements Role

Convenience base class for Role implementations.

Since:

4.1

Version:

$Id: AbstractRole.java 1094650 2011-04-18 16:59:26Z markt $

Author:

Craig R. McClanahan

Field Summary

protected String	description The description of this Role.
protected String	rolename The role name of this Role.

Constructor Summary

AbstractRole()

Method Summary

String	getDescription() Return the description of this role.
String	getName() Make the principal name the same as the role name.
String	getRolename() Return the role name of this role, which must be unique within the scope of a UserDatabase.
abstract UserDatabase	getUserDatabase() Return the UserDatabase within which this Role is defined.
void	setDescription(String description) Set the description of this role.
void	setRolename(String rolename) Set the role name of this role, 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 java.security.Principal

equals, hashCode, toString

Field Detail

description

protected String description

The description of this Role.

rolename

protected String rolename

The role name of this Role.

Constructor Detail

AbstractRole

public AbstractRole()

Method Detail

getDescription

public String getDescription()

Return the description of this role.

Specified by:

getDescription in interface Role

setDescription

public void setDescription(String description)

Set the description of this role.

Specified by:

setDescription in interface Role

Parameters:

description - The new description

getRolename

public String getRolename()

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

Specified by:

getRolename in interface Role

setRolename

public void setRolename(String rolename)

Set 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

getUserDatabase

public abstract UserDatabase getUserDatabase()

Return the UserDatabase within which this Role is defined.

Specified by:

getUserDatabase in interface Role

getName

public String getName()

Make the principal name the same as the role name.

Specified by:

getName in interface Principal