Package com.nimbusds.oauth2.sdk

Enum Role

java.lang.Object
java.lang.Enum<Role>
com.nimbusds.oauth2.sdk.Role
All Implemented Interfaces:
Serializable, Comparable<Role>, java.lang.constant.Constable
public enum Role extends Enum<Role>
Enumeration of the OAuth 2.0 roles.

Related specifications:

  • OAuth 2.0 (RFC 6749)

  • 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
    AUTHORIZATION_SERVER
    The server issuing access tokens to the client after successfully authenticating the resource owner and obtaining authorization.
    CLIENT
    An application making protected resource requests on behalf of the resource owner and with its authorization.
    RESOURCE_OWNER
    An entity capable of granting access to a protected resource.
    RESOURCE_SERVER
    The server hosting the protected resources, capable of accepting and responding to protected resource requests using access tokens.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Role
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Role[]
    values()
    Returns an array containing the constants of this enum type, 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

    • RESOURCE_OWNER

      public static final Role RESOURCE_OWNER
      An entity capable of granting access to a protected resource. When the resource owner is a person, it is referred to as an end-user.

    • RESOURCE_SERVER

      public static final Role RESOURCE_SERVER
      The server hosting the protected resources, capable of accepting and responding to protected resource requests using access tokens.

    • CLIENT

      public static final Role CLIENT
      An application making protected resource requests on behalf of the resource owner and with its authorization. The term "client" does not imply any particular implementation characteristics (e.g. whether the application executes on a server, a desktop, or other devices).

    • AUTHORIZATION_SERVER

      public static final Role AUTHORIZATION_SERVER
      The server issuing access tokens to the client after successfully authenticating the resource owner and obtaining authorization.

  • Method Details

    • values

      public static Role[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Role valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null