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
-
@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
All Methods Static Methods Instance Methods Concrete Methods 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
-
-
-
-
Constructor Detail
-
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 benull
.accessToken
- The client notification token. Must not benull
.authRequestID
- The CIBA request ID. Must not benull
.errorObject
- The error object. Must not benull
.
-
-
Method Detail
-
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 classCIBAPushCallback
- Returns:
true
if the callback indicates success, elsefalse
.
-
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 benull
.- Returns:
- The CIBA error push delivery.
- Throws:
ParseException
- If parsing failed.
-
-