Top Description Methods
org.apache.catalina

public Interface Role

extends Principal
Known Direct Implementers
org.apache.catalina.users.AbstractRole
Imports
java.security.Principal

Abstract representation of a security role, suitable for use in environments like JAAS that want to deal with Principals.

Author
Craig R. McClanahan
Since
4.1

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the description of this role.
getDescription()

public String

Returns:

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

public UserDatabase

Returns:

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

public void
setDescription(String
The new description
description)

Set the description of this role.

public void
setRolename(String
The new role name
rolename)

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

Inherited from java.security.Principal:
equalsgetNamehashCodeimpliestoString

Method Detail

getDescriptionback to summary
public String getDescription()
Returns:String

the description of this role.

getRolenameback to summary
public String getRolename()
Returns:String

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

getUserDatabaseback to summary
public UserDatabase getUserDatabase()
Returns:UserDatabase

the UserDatabase within which this Role is defined.

setDescriptionback to summary
public void setDescription(String description)

Set the description of this role.

Parameters
description:String

The new description

setRolenameback to summary
public void setRolename(String rolename)

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

Parameters
rolename:String

The new role name