GrantType (com.authlete:authlete-java-common 2.9 API)

java.lang.Object
- java.lang.Enum<GrantType>
- - com.authlete.common.types.GrantType

All Implemented Interfaces:

Serializable, Comparable<GrantType>
```
public enum GrantType
extends Enum<GrantType>
```
Values for grant_type.

Author:

Takahiko Kawasaki

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHORIZATION_CODE` `"authorization_code"` (1), a `grant_type` to request an access token and/or an ID token, and optionally a refresh token, using an authorization code.
`CLIENT_CREDENTIALS` `"client_credentials"` (4), a `grant_type` to request an access token using a client's credentials.
`IMPLICIT` `"implicit"` (2), representing Implicit Flow.
`PASSWORD` `"password"` (3), a `grant_type` to request an access token using a resource owner's username and password.
`REFRESH_TOKEN` `"refresh_token"` (5), a `grant_type` to request an access token, and optionally an ID token and/or a refresh token, using a refresh token.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GrantType`	`getByValue(short value)` Find an instance of this enum by a value.
`short`	`getValue()` Get the integer representation of this enum instance.
`static GrantType`	`parse(String grantType)` Convert `String` to `GrantType`.
`static GrantType[]`	`toArray(int bits)`
`static int`	`toBits(EnumSet<GrantType> set)`
`static EnumSet<GrantType>`	`toSet(GrantType[] array)`
`static EnumSet<GrantType>`	`toSet(int bits)`
`String`	`toString()`
`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, 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
```
    "authorization_code" (1), a grant_type to request an access token and/or an ID token, and optionally a refresh token, using an authorization code.
    
    See Also:
    
    RFC 6749 (OAuth 2.0), 4.1.3. Access Token Request, OpenID Connect Core 1.0, 3.1.3. Token Endpoint
  - IMPLICIT
```
public static final GrantType IMPLICIT
```
    "implicit" (2), representing Implicit Flow.
    This is not a value for grant_type but listed in this enum because OpenID Connect Dynamic Client Registration 1.0 uses "implicit" as a value for grant_types of client metadata.
    
    See Also:
    
    OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata
  - PASSWORD
```
public static final GrantType PASSWORD
```
    "password" (3), a grant_type to request an access token using a resource owner's username and password.
    
    See Also:
    
    RFC 6749 (OAuth 2.0), 4.3.2. Access Token Request
  - CLIENT_CREDENTIALS
```
public static final GrantType CLIENT_CREDENTIALS
```
    "client_credentials" (4), a grant_type to request an access token using a client's credentials.
    
    See Also:
    
    RFC 6749 (OAuth 2.0), 4.4.2. Access Token Request
  - REFRESH_TOKEN
```
public static final GrantType REFRESH_TOKEN
```
    "refresh_token" (5), a grant_type to request an access token, and optionally an ID token and/or a refresh token, using a refresh token.
    
    See Also:
    
    RFC 6749 (OAuth 2.0), 6. Refreshing an Access Token, OpenID Connect Core 1.0, 12. Using Refresh Tokens
- 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
  - getValue
```
public short getValue()
```
    Get the integer representation of this enum instance.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<GrantType>
  - getByValue
```
public static GrantType getByValue(short value)
```
    Find an instance of this enum by a value.
    
    Parameters:
    
    value - The integer representation of the instance to find.
    
    Returns:
    
    An instance of this enum, or null if not found.
  - parse
```
public static GrantType parse(String grantType)
```
    Convert String to GrantType.
    
    Parameters:
    
    grantType - A grant type. For example, "authorization_code".
    
    Returns:
    
    GrantType instance, or null.
  - toBits
```
public static int toBits(EnumSet<GrantType> set)
```
  - toArray
```
public static GrantType[] toArray(int bits)
```
  - toSet
```
public static EnumSet<GrantType> toSet(int bits)
```
  - toSet
```
public static EnumSet<GrantType> toSet(GrantType[] array)
```

Enum GrantType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTHORIZATION_CODE

IMPLICIT

PASSWORD

CLIENT_CREDENTIALS

REFRESH_TOKEN

Method Detail

values

valueOf

getValue

toString

getByValue

parse

toBits

toArray

toSet

toSet