org.apache.catalina

Interface Role

All Superinterfaces:
Principal
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.

Version:
$Revision: 1.2 $ $Date: 2004/02/27 14:58:39 $

Author:
Craig R. McClanahan

Since:
4.1

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.

Method Details

getDescription

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


getRolename

public String getRolename()


getUserDatabase

public 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)

Parameters:
rolename - The new role name


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.