com.cloudbees.api.oauth

Enum GrantType

java.lang.Object

java.lang.Enum<GrantType>

com.cloudbees.api.oauth.GrantType

All Implemented Interfaces:

Serializable, Comparable<GrantType>

public enum GrantType
extends Enum<GrantType>

Possible modes of token creation that applications are allowed to do.

Author:

Kohsuke Kawaguchi

See Also:

OauthClientApplication.grant_types

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrantType.DeserializerImpl
static class	GrantType.SerializerImpl

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHORIZATION_CODE This is for a stereo-typical OAuth flow between a web application that users access via a browser.
CLIENT_CREDENTIALS This mode of token issuance is to use the OAuth application client ID and secret directly to create a token.

Method Summary

Methods

Modifier and Type	Method and Description
static GrantType	parse(String value) From the lower/upper case of the grant type value, obtains the enum constant.
String	toLowerCase()
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

public static final GrantType AUTHORIZATION_CODE

This is for a stereo-typical OAuth flow between a web application that users access via a browser. The web application redirects the user browser to Grand Central, then GC performs authentication, and the user is sent back to the web application with authorization code. The web application can then pass the authorization code to GC to get the token.

CLIENT_CREDENTIALS

public static final GrantType CLIENT_CREDENTIALS

This mode of token issuance is to use the OAuth application client ID and secret directly to create a token.

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

toLowerCase

public String toLowerCase()

parse

public static GrantType parse(String value)

From the lower/upper case of the grant type value, obtains the enum constant.