com.nimbusds.openid.connect.sdk

Class AuthenticationResponseParser

java.lang.Object

com.nimbusds.openid.connect.sdk.AuthenticationResponseParser

public class AuthenticationResponseParser
extends Object

Parser of OpenID Connect authentication response messages.

Related specifications:

• OpenID Connect Core 1.0, sections 3.1.2.5. and 3.1.2.6.

Method Summary

Methods

Modifier and Type	Method and Description
static AuthenticationResponse	parse(HTTPResponse httpResponse) Parses an OpenID Connect authentication success or error response from the specified HTTP response.
static AuthenticationResponse	parse(URI uri) Parses an OpenID Connect authentication success or error response from the specified URI.
static AuthenticationResponse	parse(URI redirectURI, Map<String,String> params) Parses an OpenID Connect authentication success or error response from the specified redirection URI and parameters.

Methods inherited from class java.lang.Object

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

Method Detail

parse

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

Parses an OpenID Connect authentication success or error response from the specified redirection URI and parameters.

Parameters:

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

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

Returns:

The OpenID Connect authentication success or error response.

Throws:

ParseException - If the parameters couldn't be parsed to an OpenID Connect authentication success or error response.

parse

public static AuthenticationResponse parse(URI uri)
                                    throws ParseException

Parses an OpenID Connect authentication success or error response from the specified URI.

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 authentication response parameters. Must not be null.

Returns:

The OpenID Connect authentication success or error response.

Throws:

ParseException - If the redirection URI couldn't be parsed to an OpenID Connect authentication success or error response.

parse

public static AuthenticationResponse parse(HTTPResponse httpResponse)
                                    throws ParseException

Parses an OpenID Connect authentication success or error response from the specified HTTP 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 OpenID Connect authentication success or error response.

Throws:

ParseException - If the HTTP response couldn't be parsed to an OpenID Connect authentication success or error response.