Module org.glassfish.jersey.security.oauth2.client

Package org.glassfish.jersey.client.oauth2

Enum Class OAuth2CodeGrantFlow.Phase

java.lang.Object

java.lang.Enum<OAuth2CodeGrantFlow.Phase>

org.glassfish.jersey.client.oauth2.OAuth2CodeGrantFlow.Phase

All Implemented Interfaces:

Serializable, Comparable<OAuth2CodeGrantFlow.Phase>, Constable

Enclosing interface:

OAuth2CodeGrantFlow

public static enum OAuth2CodeGrantFlow.Phase
extends Enum<OAuth2CodeGrantFlow.Phase>

Phase of the Authorization Code Grant Flow.

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
ACCESS_TOKEN_REQUEST	Requesting the access token phase.
ALL	All phases.
AUTHORIZATION	Authorization phase.
REFRESH_ACCESS_TOKEN	Refreshing the access token phase.

Method Summary

Modifier and Type	Method	Description
abstract void	property(String key, String value, Map<String,String> authorizationProps, Map<String,String> accessTokenProps, Map<String,String> refreshTokenProps)	Set property defined by key and value to the appropriate property map based on this phase.
static OAuth2CodeGrantFlow.Phase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OAuth2CodeGrantFlow.Phase[]	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

AUTHORIZATION

public static final OAuth2CodeGrantFlow.Phase AUTHORIZATION

Authorization phase. The phase when user is redirected to the authorization server to authorize the application.

ACCESS_TOKEN_REQUEST

public static final OAuth2CodeGrantFlow.Phase ACCESS_TOKEN_REQUEST

Requesting the access token phase.

REFRESH_ACCESS_TOKEN

public static final OAuth2CodeGrantFlow.Phase REFRESH_ACCESS_TOKEN

Refreshing the access token phase.

ALL

public static final OAuth2CodeGrantFlow.Phase ALL

All phases.

Method Details

values

public static OAuth2CodeGrantFlow.Phase[] 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 OAuth2CodeGrantFlow.Phase 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

property

public abstract void property(String key,
 String value,
 Map<String,String> authorizationProps,
 Map<String,String> accessTokenProps,
 Map<String,String> refreshTokenProps)

Set property defined by key and value to the appropriate property map based on this phase.

Parameters:

key - Property key.

value - Property value.

authorizationProps - Properties used in construction of redirect URI.

accessTokenProps - Properties (parameters) used in access token request.

refreshTokenProps - Properties (parameters) used in request for refreshing the access token.