Package org.glassfish.security.common

Class Role

java.lang.Object

org.glassfish.security.common.Role

All Implemented Interfaces:

Serializable, Principal

public class Role
extends Object
implements Principal, Serializable

In EJBs, ACL checking is done using the Roles.

Roles are an abstraction of an application specific Logical Principals. These Principals do not have any properties of Principals within a Security Domain (or Realm). They merely serve as abstraction to application specific entities.

Author:

Harish Prabandham

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Role(String name)	Creates a new Role with a given name
Role(String name, String description)	Creates a new Role with a given name

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
String	getDescription()
String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Details

Role

public Role(String name)

Creates a new Role with a given name

Parameters:

name - cannot be null

Role

public Role(String name,
 String description)

Creates a new Role with a given name

Parameters:

name - cannot be null

description - can be null

Method Details

getName

public String getName()

Specified by:

getName in interface Principal

Returns:

role name

getDescription

public String getDescription()

Returns:

description of the role. Can be null.

equals

public boolean equals(Object other)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Returns:

true if the object is an instance of Role with the same name.

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

same as getName()