Package com.nimbusds.oauth2.sdk

Class ResponseType

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<ResponseType.Value>

com.nimbusds.oauth2.sdk.ResponseType

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ResponseType.Value>, Collection<ResponseType.Value>, Set<ResponseType.Value>

@NotThreadSafe
public class ResponseType
extends HashSet<ResponseType.Value>

Authorisation response type.

Example response type implying an authorisation code flow:

 ResponseType rt = ResponseType.CODE;
 

Example response type from OpenID Connect specifying an ID token and an access token (implies implicit flow):

 ResponseType rt = ResponseType.IDTOKEN_TOKEN);
 

The following helper methods can be used to find out the implied OAuth 2.0 protocol flow for a response type:

• impliesImplicitFlow()
• impliesCodeFlow()

Related specifications:

• OAuth 2.0 (RFC 6749), sections 3.1.1 and 4.1.1.
• OAuth 2.0 Multiple Response Type Encoding Practices.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResponseType.Value	Authorisation response type value.

Field Summary

Fields

Modifier and Type	Field	Description
static final ResponseType	CODE	Constant for response_type=code.
static final ResponseType	CODE_IDTOKEN	Constant for response_type=code id_token.
static final ResponseType	CODE_IDTOKEN_TOKEN	Constant for response_type=code id_token token.
static final ResponseType	CODE_TOKEN	Constant for response_type=code token.
static final ResponseType	IDTOKEN	Constant for response_type=id_token.
static final ResponseType	IDTOKEN_TOKEN	Constant for response_type=id_token token.
static final ResponseType	TOKEN	Constant for response_type=token.

Constructor Summary

Constructors

Constructor	Description
ResponseType()	Creates a new empty response type.
ResponseType(ResponseType.Value... values)	Creates a new response type with the specified values.
ResponseType(String... values)	Creates a new response type with the specified string values.

Method Summary

Modifier and Type	Method	Description
boolean	add(ResponseType.Value value)
boolean	addAll(Collection<? extends ResponseType.Value> c)
void	clear()
boolean	contains(String value)	Checks if this response type contains the specified string value.
static ResponseType	getDefault()	Gets the default response type.
boolean	impliesCodeFlow()	Returns true if this response type implies an authorisation code flow.
boolean	impliesHybridFlow()	Returns true if this response type implies an OpenID Connect hybrid flow.
boolean	impliesImplicitFlow()	Returns true if this response type implies an implicit flow.
static ResponseType	parse(String s)	Parses a set of authorisation response types.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
String	toString()	Returns the string representation of this authorisation response type.

Methods inherited from class java.util.HashSet

clone, contains, isEmpty, iterator, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

containsAll, equals, hashCode

Field Details

CODE

public static final ResponseType CODE

Constant for response_type=code.

TOKEN

public static final ResponseType TOKEN

Constant for response_type=token.

IDTOKEN_TOKEN

public static final ResponseType IDTOKEN_TOKEN

Constant for response_type=id_token token.

IDTOKEN

public static final ResponseType IDTOKEN

Constant for response_type=id_token.

CODE_IDTOKEN

public static final ResponseType CODE_IDTOKEN

Constant for response_type=code id_token.

CODE_TOKEN

public static final ResponseType CODE_TOKEN

Constant for response_type=code token.

CODE_IDTOKEN_TOKEN

public static final ResponseType CODE_IDTOKEN_TOKEN

Constant for response_type=code id_token token.

Constructor Details

ResponseType

public ResponseType()

Creates a new empty response type.

ResponseType

public ResponseType(String... values)

Creates a new response type with the specified string values.

Parameters:

values - The string values. Must not be null.

ResponseType

public ResponseType(ResponseType.Value... values)

Creates a new response type with the specified values.

Parameters:

values - The values. Must not be null.

Method Details

getDefault

public static ResponseType getDefault()

Gets the default response type.

Returns:

The default response type, consisting of the value ResponseType.Value.CODE.

parse

public static ResponseType parse(String s)
                          throws ParseException

Parses a set of authorisation response types.

Parameters:

s - Space-delimited list of one or more authorisation response types.

Returns:

The authorisation response types set.

Throws:

ParseException - If the parsed string is null or empty.

impliesCodeFlow

public boolean impliesCodeFlow()

Returns true if this response type implies an authorisation code flow.

Code flow response_type values: code

Returns:

true if a code flow is implied, else false.

impliesImplicitFlow

public boolean impliesImplicitFlow()

Returns true if this response type implies an implicit flow.

Implicit flow response_type values: token, id_token token, id_token

Returns:

true if an implicit flow is implied, else false.

impliesHybridFlow

public boolean impliesHybridFlow()

Returns true if this response type implies an OpenID Connect hybrid flow.

Hybrid flow response_type values: code id_token, code token, code id_token token

Returns:

true if a hybrid flow is implied, else false.

contains

public boolean contains(String value)

Checks if this response type contains the specified string value.

Parameters:

value - The string value. Must not be null.

Returns:

true if the value is contained, else false.

toString

public String toString()

Returns the string representation of this authorisation response type.

Example serialised response types:

 code
 token
 id_token
 id_token token
 code token
 code id_token
 code id_token token
 

Overrides:

toString in class AbstractCollection<ResponseType.Value>

Returns:

Space delimited string representing the authorisation response type.

add

public boolean add(ResponseType.Value value)

Specified by:

add in interface Collection<ResponseType.Value>

Specified by:

add in interface Set<ResponseType.Value>

Overrides:

add in class HashSet<ResponseType.Value>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<ResponseType.Value>

Specified by:

remove in interface Set<ResponseType.Value>

Overrides:

remove in class HashSet<ResponseType.Value>

clear

public void clear()

Specified by:

clear in interface Collection<ResponseType.Value>

Specified by:

clear in interface Set<ResponseType.Value>

Overrides:

clear in class HashSet<ResponseType.Value>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<ResponseType.Value>

Specified by:

removeAll in interface Set<ResponseType.Value>

Overrides:

removeAll in class AbstractSet<ResponseType.Value>

addAll

public boolean addAll(Collection<? extends ResponseType.Value> c)

Specified by:

addAll in interface Collection<ResponseType.Value>

Specified by:

addAll in interface Set<ResponseType.Value>

Overrides:

addAll in class AbstractCollection<ResponseType.Value>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<ResponseType.Value>

Specified by:

retainAll in interface Set<ResponseType.Value>

Overrides:

retainAll in class AbstractCollection<ResponseType.Value>