org.apache.catalina.users

Class AbstractRole

public abstract class AbstractRole extends Object implements Role

Convenience base class for Role implementations.

Since: 4.1

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Field Summary
protected Stringdescription
The description of this Role.
protected Stringrolename
The role name of this Role.
Method Summary
StringgetDescription()
Return the description of this role.
StringgetName()
Make the principal name the same as the role name.
StringgetRolename()
Return the role name of this role, which must be unique within the scope of a UserDatabase.
abstract UserDatabasegetUserDatabase()
Return the UserDatabase within which this Role is defined.
voidsetDescription(String description)
Set the description of this role.
voidsetRolename(String rolename)
Set the role name of this role, which must be unique within the scope of a UserDatabase.

Field Detail

description

protected String description
The description of this Role.

rolename

protected String rolename
The role name of this Role.

Method Detail

getDescription

public String getDescription()
Return the description of this role.

getName

public String getName()
Make the principal name the same as the role name.

getRolename

public String getRolename()
Return the role name of this role, which must be unique within the scope of a UserDatabase.

getUserDatabase

public abstract UserDatabase getUserDatabase()
Return the UserDatabase within which this Role is defined.

setDescription

public void setDescription(String description)
Set the description of this role.

Parameters: description The new description

setRolename

public void setRolename(String rolename)
Set the role name of this role, which must be unique within the scope of a UserDatabase.

Parameters: rolename The new role name

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