com.atlassian.oauth2.client.api.storage.config

Enum GrantType

java.lang.Object

java.lang.Enum<GrantType>

com.atlassian.oauth2.client.api.storage.config.GrantType

All Implemented Interfaces:

Serializable, Comparable<GrantType>

public enum GrantType
extends Enum<GrantType>

Supported OAuth 2.0 grant types.

Since:

4.0.0

See Also:

OAuth 2.0 Grant Types

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHORIZATION_CODE_GRANT
CLIENT_CREDENTIALS_GRANT

Method Summary

Modifier and Type	Method and Description
static GrantType	defaultGrantType()
static GrantType	forValue(String value)
static Optional<GrantType>	getByName(String name)
static GrantType	getByNameOrDefault(String name)
String	getName() The name of the grant type as defined in the OAuth 2.0 specification.
static GrantType	orDefaultGrantType(GrantType grantType)
boolean	requiresAuthorization() Whether the grant type requires an authorization, also known as the 3LO (3-legged OAuth) flow.
static GrantType	valueOf(String name) Returns the enum constant of this type with the specified name.
static GrantType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHORIZATION_CODE_GRANT

public static final GrantType AUTHORIZATION_CODE_GRANT

CLIENT_CREDENTIALS_GRANT

public static final GrantType CLIENT_CREDENTIALS_GRANT

Method Detail

values

public static GrantType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GrantType c : GrantType.values())
    System.out.println(c);

Returns:

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

valueOf

public static GrantType 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

forValue

public static GrantType forValue(String value)

defaultGrantType

public static GrantType defaultGrantType()

getByName

public static Optional<GrantType> getByName(String name)

getByNameOrDefault

public static GrantType getByNameOrDefault(String name)

orDefaultGrantType

public static GrantType orDefaultGrantType(GrantType grantType)

getName

public String getName()

The name of the grant type as defined in the OAuth 2.0 specification.

Returns:

the grant type name

See Also:

RFC6749 "grant_type" syntax

requiresAuthorization

public boolean requiresAuthorization()

Whether the grant type requires an authorization, also known as the 3LO (3-legged OAuth) flow.