Top Description Fields Constructors Methods
org.apache.catalina.users

public abstract Class AbstractRole

extends Object
implements Role
Class Inheritance
All Implemented Interfaces
org.apache.catalina.Role, java.security.Principal
Known Direct Subclasses
org.apache.catalina.users.GenericRole
Imports
org.apache.catalina.Role, .UserDatabase

Convenience base class for Role implementations.

Author
Craig R. McClanahan
Since
4.1

Field Summary

Modifier and TypeField and Description
protected String
description

The description of this Role.

protected String
rolename

The role name of this Role.

Constructor Summary

AccessConstructor and Description
public
AbstractRole()

Method Summary

Modifier and TypeMethod and Description
public String
getDescription()

Implements org.apache.catalina.Role.getDescription.

Return the description of this role.

public String
getName()

Implements java.security.Principal.getName.

Make the principal name the same as the role name.

public String
getRolename()

Implements org.apache.catalina.Role.getRolename.

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

public abstract UserDatabase
getUserDatabase()

Redeclares org.apache.catalina.Role.getUserDatabase.

Return the UserDatabase within which this Role is defined.

public void
setDescription(String
The new description
description)

Implements org.apache.catalina.Role.setDescription.

Set the description of this role.

public void
setRolename(String
The new role name
rolename)

Implements org.apache.catalina.Role.setRolename.

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

descriptionback to summary
protected String description

The description of this Role.

rolenameback to summary
protected String rolename

The role name of this Role.

Constructor Detail

AbstractRoleback to summary
public AbstractRole()

Method Detail

getDescriptionback to summary
public String getDescription()

Implements org.apache.catalina.Role.getDescription.

Return the description of this role.

Returns:String

Doc from org.apache.catalina.Role.getDescription.

the description of this role.

Annotations
@Override
getNameback to summary
public String getName()

Implements java.security.Principal.getName.

Make the principal name the same as the role name.

Returns:String

Doc from java.security.Principal.getName.

the name of this Principal.

Annotations
@Override
getRolenameback to summary
public String getRolename()

Implements org.apache.catalina.Role.getRolename.

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

Returns:String

Doc from org.apache.catalina.Role.getRolename.

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

Annotations
@Override
getUserDatabaseback to summary
public abstract UserDatabase getUserDatabase()

Redeclares org.apache.catalina.Role.getUserDatabase.

Return the UserDatabase within which this Role is defined.

Returns:UserDatabase

Doc from org.apache.catalina.Role.getUserDatabase.

the UserDatabase within which this Role is defined.

Annotations
@Override
setDescriptionback to summary
public void setDescription(String description)

Implements org.apache.catalina.Role.setDescription.

Set the description of this role.

Parameters
description:String

The new description

Annotations
@Override
setRolenameback to summary
public void setRolename(String rolename)

Implements org.apache.catalina.Role.setRolename.

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

Parameters
rolename:String

The new role name

Annotations
@Override