Enum ClientSecretMethod

java.lang.Object
java.lang.Enum<ClientSecretMethod>
eu.webtoolkit.jwt.auth.ClientSecretMethod
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ClientSecretMethod>, java.lang.constant.Constable

public enum ClientSecretMethod
extends java.lang.Enum<ClientSecretMethod>
Enumeration of the OAuth client authorization method.

Specifies how the OAuth client authorizes itself with the auth provider. I.e. how it passes the client ID and secret to the provider.

See Also:
OAuthService.getClientSecretMethod(), OAuthClient.getAuthMethod()
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    HttpAuthorizationBasic
    Pass the client ID and secret to the auth provider with a GET request with Basic auth.
    PlainUrlParameter
    Pass the client ID and secret to the auth provider as URL parameters of a GET request.
    RequestBodyParameter
    Pass the client ID and secret to the auth provider as parameters of a POST request.
  • Method Summary

    Modifier and Type Method Description
    int getValue()
    Returns the numerical representation of this enum.
    static ClientSecretMethod valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static ClientSecretMethod[] 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

    • HttpAuthorizationBasic

      public static final ClientSecretMethod HttpAuthorizationBasic
      Pass the client ID and secret to the auth provider with a GET request with Basic auth.
    • PlainUrlParameter

      public static final ClientSecretMethod PlainUrlParameter
      Pass the client ID and secret to the auth provider as URL parameters of a GET request.

      This is not part of the standard but this is what Facebook does.

    • RequestBodyParameter

      public static final ClientSecretMethod RequestBodyParameter
      Pass the client ID and secret to the auth provider as parameters of a POST request.
  • Method Details

    • values

      public static ClientSecretMethod[] 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 ClientSecretMethod valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • getValue

      public int getValue()
      Returns the numerical representation of this enum.