org.springframework.security.core.authority
Class GrantedAuthorityImpl

java.lang.Object
  extended by org.springframework.security.core.authority.GrantedAuthorityImpl
All Implemented Interfaces:
Serializable, GrantedAuthority
Direct Known Subclasses:
JaasGrantedAuthority, SwitchUserGrantedAuthority

public class GrantedAuthorityImpl
extends Object
implements GrantedAuthority, 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: GrantedAuthorityImpl.java 3558 2009-04-15 07:39:21Z ltaylor $
Author:
Ben Alex
See Also:
Serialized Form

Constructor Summary
GrantedAuthorityImpl(String role)
           
 
Method Summary
 int compareTo(GrantedAuthority ga)
           
 boolean equals(Object obj)
           
 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()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GrantedAuthorityImpl

public GrantedAuthorityImpl(String role)
Method Detail

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getAuthority

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

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(GrantedAuthority ga)


Copyright © 2004-2009 SpringSource, Inc. All Rights Reserved.