FileDocCategorySizeDatePackage
AbstractRole.javaAPI DocGlassfish v2 API4077Fri May 04 22:32:30 BST 2007org.apache.catalina.users

AbstractRole

public abstract class AbstractRole extends Object implements org.apache.catalina.Role

Convenience base class for {@link Role} implementations.

author
Craig R. McClanahan
version
$Revision: 1.3 $ $Date: 2007/05/05 05:32:29 $
since
4.1

Fields Summary
protected String
description
The description of this Role.
protected String
rolename
The role name of this Role.
Constructors Summary
Methods Summary
public java.lang.StringgetDescription()
Return the description of this role.



    // ------------------------------------------------------------- Properties


               
       

        return (this.description);

    
public java.lang.StringgetName()
Make the principal name the same as the role name.


        return (getRolename());

    
public java.lang.StringgetRolename()
Return the role name of this role, which must be unique within the scope of a {@link UserDatabase}.


        return (this.rolename);

    
public abstract org.apache.catalina.UserDatabasegetUserDatabase()
Return the {@link UserDatabase} within which this Role is defined.

public voidsetDescription(java.lang.String description)
Set the description of this role.

param
description The new description


        this.description = description;

    
public voidsetRolename(java.lang.String rolename)
Set the role name of this role, which must be unique within the scope of a {@link UserDatabase}.

param
rolename The new role name


        this.rolename = rolename;