com.authlete.common.types

Enum ResponseMode

java.lang.Object

java.lang.Enum<ResponseMode>

com.authlete.common.types.ResponseMode

All Implemented Interfaces:

Serializable, Comparable<ResponseMode>

public enum ResponseMode
extends Enum<ResponseMode>

Values for response_mode.

From OAuth 2.0 Multiple Response Type Encoding Practices, 2.1. Response Modes

query

In this mode, Authorization Response parameters are encoded in the query string added to the redirect_uri when redirecting back to the Client.

fragment

In this mode, Authorization Response parameters are encoded in the fragment added to the redirect_uri when redirecting back to the Client.

From OAuth 2.0 Form Post Response Mode

form_post

In this mode, Authorization Response parameters are encoded as HTML form values that are auto-submitted in the User Agent, and thus are transmitted via the HTTP POST method to the Client, with the result parameters being encoded in the body using the application/x-www-form-urlencoded format. The action attribute of the form MUST be the Client's Redirection URI. The method of the form attribute MUST be POST.

Any technique supported by the User Agent MAY be used to cause the submission of the form, and any form content necessary to support this MAY be included, such as submit controls and client-side scripting commands. However, the Client MUST be able to process the message without regard for the mechanism by which the form submission was initiated.

Author:

Takahiko Kawasaki

See Also:

OAuth 2.0 Form Post Response Mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORM_POST "form_post" (3); response_mode to request authorization response parameters be encoded as HTML form values.
FRAGMENT "fragment" (2); response_mode to request authorization response parameters be encoded in the fragment.
QUERY "query" (1); response_mode to request authorization response parameters be encoded in the query string.

Method Summary

Modifier and Type	Method and Description
static ResponseMode	getByValue(short value) Find an instance of this enum by a value.
short	getValue() Get the integer representation of this enum instance.
static ResponseMode	parse(String responseMode) Convert String to ResponseMode.
static ResponseMode[]	toArray(int bits)
static int	toBits(EnumSet<ResponseMode> set)
static EnumSet<ResponseMode>	toSet(int bits)
static EnumSet<ResponseMode>	toSet(ResponseMode[] array)
String	toString()
static ResponseMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResponseMode[]	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

QUERY

public static final ResponseMode QUERY

"query" (1); response_mode to request authorization response parameters be encoded in the query string.

FRAGMENT

public static final ResponseMode FRAGMENT

"fragment" (2); response_mode to request authorization response parameters be encoded in the fragment.

FORM_POST

public static final ResponseMode FORM_POST

"form_post" (3); response_mode to request authorization response parameters be encoded as HTML form values.

Method Detail

values

public static ResponseMode[] 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 (ResponseMode c : ResponseMode.values())
    System.out.println(c);

Returns:

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

valueOf

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

getByValue

public static ResponseMode 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 ResponseMode parse(String responseMode)

Convert String to ResponseMode.

Parameters:

responseMode - A response mode. For example, "query".

Returns:

ResponseMode instance, or null.

toBits

public static int toBits(EnumSet<ResponseMode> set)

toArray

public static ResponseMode[] toArray(int bits)

toSet

public static EnumSet<ResponseMode> toSet(int bits)

toSet

public static EnumSet<ResponseMode> toSet(ResponseMode[] array)