org.springframework.security

Class GrantedAuthorityImpl

java.lang.Object

org.springframework.security.GrantedAuthorityImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, GrantedAuthority

Direct Known Subclasses:

JaasGrantedAuthority, SwitchUserGrantedAuthority

public class GrantedAuthorityImpl
extends java.lang.Object
implements GrantedAuthority, java.io.Serializable

Basic concrete implementation of a GrantedAuthority.

Stores a String representation of an authority granted to the Authentication object.

If compared to a custom authority which returns null from getAuthority(), the compareTo method will return -1, so the custom authority will take precedence.

Version:

$Id$

Author:

Ben Alex

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GrantedAuthorityImpl(java.lang.String role)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object obj)
java.lang.String	getAuthority() If the GrantedAuthority can be represented as a String and that String is sufficient in precision to be relied upon for an access control decision by an AccessDecisionManager (or delegate), this method should return such a String.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrantedAuthorityImpl

public GrantedAuthorityImpl(java.lang.String role)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAuthority

public java.lang.String getAuthority()

Description copied from interface: GrantedAuthority

If the GrantedAuthority can be represented as a String and that String is sufficient in precision to be relied upon for an access control decision by an AccessDecisionManager (or delegate), this method should return such a String.

If the GrantedAuthority cannot be expressed with sufficient precision as a String, null should be returned. Returning null will require an AccessDecisionManager (or delegate) to specifically support the GrantedAuthority implementation, so returning null should be avoided unless actually required.

Specified by:

getAuthority in interface GrantedAuthority

Returns:

a representation of the granted authority (or null if the granted authority cannot be expressed as a String with sufficient precision).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable