com.nimbusds.openid.connect.sdk

Class ResponseMode

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.openid.connect.sdk.ResponseMode

All Implemented Interfaces:

Comparable<Identifier>, net.minidev.json.JSONAware

@Immutable
public final class ResponseMode
extends Identifier

OAuth 2.0 response mode.

Related specifications:

• OAuth 2.0 Multiple Response Type Encoding Practices, section 2.1.

Field Summary

Fields

Modifier and Type	Field and Description
static ResponseMode	FORM_POST HTML form post response mode.
static ResponseMode	FRAGMENT Fragment response mode.
static ResponseMode	QUERY Query response mode.

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH

Constructor Summary

Constructors

Constructor and Description
ResponseMode(String value) Creates a new response mode with the specified value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Overrides Object.equals().
static ResponseMode	parse(String s) Parses a response mode from the specified string.

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, getValue, hashCode, toJSONString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

QUERY

public static final ResponseMode QUERY

Query response mode. In this mode, response parameters are encoded in the query string added to the redirect_uri when redirecting back to the client.

FRAGMENT

public static final ResponseMode FRAGMENT

Fragment response mode. In this mode, response parameters are encoded in the fragment added to the redirect_uri when redirecting back to the client.

FORM_POST

public static final ResponseMode FORM_POST

HTML form post response mode. In this mode, 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 response 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.

Constructor Detail

ResponseMode

public ResponseMode(String value)

Creates a new response mode with the specified value.

Parameters:

value - The response mode value. Must not be null or empty string.

Method Detail

equals

public boolean equals(Object object)

Description copied from class: Identifier

Overrides Object.equals().

Specified by:

equals in class Identifier

Parameters:

object - The object to compare to.

Returns:

true if the objects have the same value, otherwise false.

parse

public static ResponseMode parse(String s)

Parses a response mode from the specified string.

Parameters:

s - The string to parse, null or empty if no response mode is specified.

Returns:

The response mode, null if the parsed string was null or empty.