public interface SecurityRole
SecurityRole
interface represents the abstract notion
of a security role.
Users/groups can have different roles at different times, depending upon
what they are trying to do. For example, a user may have the role "Admin"
while doing administrative tasks, but the same user might not be allowed
to have that role outside normal work hours. Users/groups can have multiple
roles at the same time, depending upon what the security providers grant.
The methods on the SecurityRole
interface allow one to obtain
basic information about the SecurityRole
, or to compare it to another
security role. These methods are designed for the convenience of security providers.
Note: SecurityRole
implementations are returned as a Map
by the getRoles
method.
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals(java.lang.Object another) |
Compares this security role to the security role in the specified object.
|
java.lang.String |
getDescription() |
Gets a description of this security role.
|
java.lang.String |
getName() |
Gets the name of this security role.
|
int |
hashCode() |
Returns a hashcode for this security role.
|
java.lang.String |
toString() |
Returns a String representation of this security role.
|
boolean equals(java.lang.Object another)
equals
in class java.lang.Object
another
- the other security role with which to compare this security role.TRUE
if the security role passed in matches the security
role represented by the implementation of this interface,
and FALSE
otherwise.java.lang.String toString()
toString
in class java.lang.Object
int hashCode()
hashCode
in class java.lang.Object
java.lang.String getName()
java.lang.String getDescription()