Package com.nimbusds.oauth2.sdk.ciba

Class CIBAPingCallback

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.oauth2.sdk.ProtectedResourceRequest

com.nimbusds.oauth2.sdk.ciba.CIBAPingCallback

All Implemented Interfaces:

Message, Request

@Immutable
public class CIBAPingCallback
extends ProtectedResourceRequest

CIBA ping callback to a client notification endpoint.

Example HTTP request:

 POST /cb HTTP/1.1
 Host: client.example.com
 Authorization: Bearer 8d67dc78-7faa-4d41-aabd-67707b374255
 Content-Type: application/json

 {
   "auth_req_id": "1c266114-a1be-4252-8ad1-04986c5b9ac1"
 }
 

Related specifications:

• OpenID Connect CIBA Flow - Core 1.0, section 10.2

Constructor Summary

Constructors

Constructor	Description
CIBAPingCallback(URI endpoint, BearerAccessToken accessToken, AuthRequestID authRequestID)	Creates a new CIBA ping callback.

Method Summary

Modifier and Type	Method	Description
AuthRequestID	getAuthRequestID()	Returns the CIBA request ID.
static CIBAPingCallback	parse(HTTPRequest httpRequest)	Parses a CIBA ping callback from the specified HTTP request.
HTTPRequest	toHTTPRequest()	Returns the matching HTTP request.

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 Detail

CIBAPingCallback

public CIBAPingCallback(URI endpoint,
                        BearerAccessToken accessToken,
                        AuthRequestID authRequestID)

Creates a new CIBA ping callback.

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.

Method Detail

getAuthRequestID

public AuthRequestID getAuthRequestID()

Returns the CIBA request ID.

Returns:

The CIBA request ID.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.

parse

public static CIBAPingCallback parse(HTTPRequest httpRequest)
                              throws ParseException

Parses a CIBA ping callback from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The CIBA ping callback.

Throws:

ParseException - If parsing failed.