Package org.springframework.security.core.authority

Class SimpleGrantedAuthority

java.lang.Object

org.springframework.security.core.authority.SimpleGrantedAuthority

All Implemented Interfaces:

Serializable, GrantedAuthority

public final class SimpleGrantedAuthority
extends Object
implements GrantedAuthority

Basic concrete implementation of a GrantedAuthority.

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleGrantedAuthority(String authority)	Constructs a SimpleGrantedAuthority using the provided authority.

Method Summary

Modifier and Type	Method	Description
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 AuthorizationManager (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 Details

SimpleGrantedAuthority

public SimpleGrantedAuthority(String authority)

Constructs a SimpleGrantedAuthority using the provided authority.

Parameters:

authority - The provided authority, including any prefix; for example, ROLE_ADMIN

Method Details

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 AuthorizationManager (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).

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object