Package com.nimbusds.oauth2.sdk.ciba

Class CIBAErrorDelivery

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.ProtectedResourceRequest

com.nimbusds.oauth2.sdk.ciba.CIBAPushCallback

com.nimbusds.oauth2.sdk.ciba.CIBAErrorDelivery

All Implemented Interfaces:

Message, Request

@Immutable
public class CIBAErrorDelivery
extends CIBAPushCallback

CIBA error push delivery to the client notification endpoint.

Related specifications:

• OpenID Connect CIBA Flow - Core 1.0, section 12.

Constructor Summary

Constructors

Constructor	Description
CIBAErrorDelivery(URI endpoint, BearerAccessToken accessToken, AuthRequestID authRequestID, ErrorObject errorObject)	Creates a new CIBA error push delivery.

Method Summary

Modifier and Type	Method	Description
ErrorObject	getErrorObject()	Returns the error object.
static Set<ErrorObject>	getStandardErrors()	Gets the standard OAuth 2.0 errors for a CIBA error delivery.
boolean	indicatesSuccess()	Checks if the callback indicates success.
static CIBAErrorDelivery	parse(HTTPRequest httpRequest)	Parses a CIBA error push delivery from the specified HTTP request.
HTTPRequest	toHTTPRequest()	Returns the matching HTTP request.

Methods inherited from class com.nimbusds.oauth2.sdk.ciba.CIBAPushCallback

getAuthRequestID, toErrorDelivery, toTokenDelivery

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

getAccessToken

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

getEndpointURI

Methods inherited from class java.lang.Object

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

Constructor Details

CIBAErrorDelivery

public CIBAErrorDelivery(URI endpoint,
 BearerAccessToken accessToken,
 AuthRequestID authRequestID,
 ErrorObject errorObject)

Creates a new CIBA error push delivery.

Parameters:

endpoint - The client notification endpoint. Must not be null.

accessToken - The client notification token. Must not be null.

authRequestID - The CIBA request ID. Must not be null.

errorObject - The error object. Must not be null.

Method Details

getStandardErrors

public static Set<ErrorObject> getStandardErrors()

Gets the standard OAuth 2.0 errors for a CIBA error delivery.

Returns:

The standard errors, as a read-only set.

indicatesSuccess

public boolean indicatesSuccess()

Description copied from class: CIBAPushCallback

Checks if the callback indicates success.

Specified by:

indicatesSuccess in class CIBAPushCallback

Returns:

true if the callback indicates success, else false.

getErrorObject

public ErrorObject getErrorObject()

Returns the error object.

Returns:

The error object.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

parse

public static CIBAErrorDelivery parse(HTTPRequest httpRequest)
                               throws ParseException

Parses a CIBA error push delivery from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The CIBA error push delivery.

Throws:

ParseException - If parsing failed.