Package com.nimbusds.oauth2.sdk

Class PushedAuthorizationErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.PushedAuthorizationResponse

com.nimbusds.oauth2.sdk.PushedAuthorizationErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response

@Immutable
public class PushedAuthorizationErrorResponse
extends PushedAuthorizationResponse
implements ErrorResponse

Pushed authorisation error response.

Example HTTP response:

 HTTP/1.1 400 Bad Request
 Content-Type: application/json
 Cache-Control: no-cache, no-store

 {
  "error ": "invalid_request",
  "error_description" : "The redirect_uri is not valid for the given client"
 }
 

Related specifications:

• OAuth 2.0 Pushed Authorization Requests (RFC 9126)

Constructor Summary

Constructors

Constructor	Description
PushedAuthorizationErrorResponse(ErrorObject error)	Creates a new pushed authorisation error response.

Method Summary

Modifier and Type	Method	Description
ErrorObject	getErrorObject()	Gets the error associated with the error response.
boolean	indicatesSuccess()	Checks if the response indicates success.
static PushedAuthorizationErrorResponse	parse(HTTPResponse httpResponse)	Parses a pushed authorisation error response from the specified HTTP response.
HTTPResponse	toHTTPResponse()	Returns the matching HTTP response.

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

toErrorResponse, toSuccessResponse

Methods inherited from class java.lang.Object

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

Constructor Details

PushedAuthorizationErrorResponse

public PushedAuthorizationErrorResponse(ErrorObject error)

Creates a new pushed authorisation error response.

Parameters:

error - The error. Must not be null.

Method Details

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.

getErrorObject

public ErrorObject getErrorObject()

Description copied from interface: ErrorResponse

Gets the error associated with the error response.

Specified by:

getErrorObject in interface ErrorResponse

Returns:

The error, null if none.

toHTTPResponse

public HTTPResponse toHTTPResponse()

Description copied from interface: Response

Returns the matching HTTP response.

Specified by:

toHTTPResponse in interface Response

Returns:

The HTTP response.

parse

public static PushedAuthorizationErrorResponse parse(HTTPResponse httpResponse)
                                              throws ParseException

Parses a pushed authorisation error response from the specified HTTP response.

Parameters:

httpResponse - The HTTP response. Must not be null.

Returns:

The pushed authorisation error response.

Throws:

ParseException - If the HTTP response couldn't be parsed to a pushed authorisation error response.