org.apache.catalina
Interface Role

All Superinterfaces:

Principal

All Known Implementing Classes:

AbstractRole, MemoryRole

public interface Role
extends Principal

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

Since:

4.1

Version:

$Id: Role.java 939305 2010-04-29 13:43:39Z kkolinko $

Author:

Craig R. McClanahan

Method Summary

String	getDescription() Return the description of this role.
String	getRolename() Return the role name of this role, which must be unique within the scope of a UserDatabase.
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 interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getDescription

String getDescription()

Return the description of this role.

setDescription

void setDescription(String description)

Set the description of this role.

Parameters:

description - The new description

getRolename

String getRolename()

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

setRolename

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

getUserDatabase

UserDatabase getUserDatabase()

Return the UserDatabase within which this Role is defined.