Package org.genesys.blocks.oauth.model

Enum Class OAuthRole

java.lang.Object

java.lang.Enum<OAuthRole>

org.genesys.blocks.oauth.model.OAuthRole

All Implemented Interfaces:

Serializable, Comparable<OAuthRole>, Constable, org.springframework.security.core.GrantedAuthority

public enum OAuthRole
extends Enum<OAuthRole>
implements org.springframework.security.core.GrantedAuthority

Roles available for OAuth clients.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	The client.
EVERYONE	Everyone.
TRUSTED_CLIENT	The trusted client.

Method Summary

Modifier and Type	Method	Description
String	getAuthority()	GrantedAuthorities start with ROLE_.
static OAuthRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OAuthRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT

public static final OAuthRole CLIENT

The client.

TRUSTED_CLIENT

public static final OAuthRole TRUSTED_CLIENT

The trusted client.

EVERYONE

public static final OAuthRole EVERYONE

Everyone.

Method Details

values

public static OAuthRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OAuthRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getAuthority

public String getAuthority()

GrantedAuthorities start with ROLE_.

Specified by:

getAuthority in interface org.springframework.security.core.GrantedAuthority

Returns:

the authority