com.nimbusds.oauth2.sdk

Class AuthorizationSuccessResponse

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationResponse

com.nimbusds.oauth2.sdk.AuthorizationSuccessResponse

All Implemented Interfaces:

Message, Response, SuccessResponse

Direct Known Subclasses:

AuthenticationSuccessResponse

@Immutable
public class AuthorizationSuccessResponse
extends AuthorizationResponse
implements SuccessResponse

Authorisation success response. Used to return an authorisation code or access token at the Authorisation endpoint.

Example HTTP response with code (code flow):

 HTTP/1.1 302 Found
 Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
 

Example HTTP response with access token (implicit flow):

 HTTP/1.1 302 Found
 Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
           &state=xyz&token_type=Bearer&expires_in=3600
 

Related specifications:

• OAuth 2.0 (RFC 6749), sections 4.1.2 and 4.2.2.

Constructor Summary

Constructors

Constructor and Description
AuthorizationSuccessResponse(URI redirectURI, AccessToken accessToken, State state) Creates a new authorisation success response in the implicit flow (implicit grant).
AuthorizationSuccessResponse(URI redirectURI, AuthorizationCode code, AccessToken accessToken, State state) Creates a new authorisation success response.
AuthorizationSuccessResponse(URI redirectURI, AuthorizationCode code, State state) Creates a new authorisation success response in the code flow (authorisation code grant).

Method Summary

Methods

Modifier and Type	Method and Description
AccessToken	getAccessToken() Gets the access token.
AuthorizationCode	getAuthorizationCode() Gets the authorisation code.
ResponseType	impliedResponseType() Returns the implied response type.
boolean	indicatesSuccess() Checks if the response indicates success.
static AuthorizationSuccessResponse	parse(HTTPResponse httpResponse) Parses an authorisation success response.
static AuthorizationSuccessResponse	parse(URI uri) Parses an authorisation success response.
static AuthorizationSuccessResponse	parse(URI redirectURI, Map<String,String> params) Parses an authorisation success response.
Map<String,String>	toParameters() Returns the parameters of this authorisation response.
URI	toURI() Returns the URI representation (redirection URI + fragment / query string) of this authorisation response.

Methods inherited from class com.nimbusds.oauth2.sdk.AuthorizationResponse

getRedirectionURI, getState, toHTTPResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nimbusds.oauth2.sdk.Response

toHTTPResponse

Constructor Detail

AuthorizationSuccessResponse

public AuthorizationSuccessResponse(URI redirectURI,
                            AuthorizationCode code,
                            State state)

Creates a new authorisation success response in the code flow (authorisation code grant).

Parameters:

redirectURI - The base redirection URI. Must not be null.

code - The authorisation code. Must not be null.

state - The state, null if not requested.

AuthorizationSuccessResponse

public AuthorizationSuccessResponse(URI redirectURI,
                            AccessToken accessToken,
                            State state)

Creates a new authorisation success response in the implicit flow (implicit grant).

Parameters:

redirectURI - The base redirection URI. Must not be null.

accessToken - The access token. Must not be null.

state - The state, null if not requested.

AuthorizationSuccessResponse

public AuthorizationSuccessResponse(URI redirectURI,
                            AuthorizationCode code,
                            AccessToken accessToken,
                            State state)

Creates a new authorisation success response.

Parameters:

redirectURI - The base redirection URI. Must not be null.

code - The authorisation code, null if not requested.

accessToken - The access token, null if not requested.

state - The state, null if not requested.

Method Detail

indicatesSuccess

public boolean indicatesSuccess()

Description copied from interface: Response

Checks if the response indicates success.

Specified by:

indicatesSuccess in interface Response

Returns:

true if the response indicates success, else false.

impliedResponseType

public ResponseType impliedResponseType()

Returns the implied response type.

Returns:

The implied response type.

getAuthorizationCode

public AuthorizationCode getAuthorizationCode()

Gets the authorisation code.

Returns:

The authorisation code, null if not requested.

getAccessToken

public AccessToken getAccessToken()

Gets the access token.

Returns:

The access token, null if not requested.

toParameters

public Map<String,String> toParameters()
                                throws SerializeException

Description copied from class: AuthorizationResponse

Returns the parameters of this authorisation response.

Example parameters (authorisation success):

 access_token = 2YotnFZFEjr1zCsicMWpAA
 state = xyz
 token_type = example
 expires_in = 3600
 

Specified by:

toParameters in class AuthorizationResponse

Returns:

The parameters as a map.

Throws:

SerializeException - If this response couldn't be serialised to a parameters map.

toURI

public URI toURI()
          throws SerializeException

Description copied from class: AuthorizationResponse

Returns the URI representation (redirection URI + fragment / query string) of this authorisation response.

Example URI:

 http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
 &state=xyz
 &token_type=example
 &expires_in=3600
 

Specified by:

toURI in class AuthorizationResponse

Returns:

The URI representation of this authorisation response.

Throws:

SerializeException - If this response couldn't be serialised to a URI.

parse

public static AuthorizationSuccessResponse parse(URI redirectURI,
                                 Map<String,String> params)
                                          throws ParseException

Parses an authorisation success response.

Parameters:

redirectURI - The base redirection URI. Must not be null.

params - The response parameters to parse. Must not be null.

Returns:

The authorisation success response.

Throws:

ParseException - If the parameters couldn't be parsed to an authorisation success response.

parse

public static AuthorizationSuccessResponse parse(URI uri)
                                          throws ParseException

Parses an authorisation success response.

Example URI:

 https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
 

Parameters:

uri - The URI to parse. Can be absolute or relative, with a fragment or query string containing the authorisation response parameters. Must not be null.

Returns:

The authorisation success response.

Throws:

ParseException - If the redirection URI couldn't be parsed to an authorisation success response.

parse

public static AuthorizationSuccessResponse parse(HTTPResponse httpResponse)
                                          throws ParseException

Parses an authorisation success response.

Example HTTP response:

 HTTP/1.1 302 Found
 Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
 

Parameters:

httpResponse - The HTTP response to parse. Must not be null.

Returns:

The authorisation success response.

Throws:

ParseException - If the HTTP response couldn't be parsed to an authorisation success response.