com.nimbusds.oauth2.sdk.client

Class ClientRegistrationErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.client.ClientRegistrationResponse

com.nimbusds.oauth2.sdk.client.ClientRegistrationErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response

@Immutable
public class ClientRegistrationErrorResponse
extends ClientRegistrationResponse
implements ErrorResponse

Client registration error response.

Standard errors:

• OAuth 2.0 Bearer Token errors:
  • BearerTokenError.MISSING_TOKEN
  • BearerTokenError.INVALID_REQUEST
  • BearerTokenError.INVALID_TOKEN
  • BearerTokenError.INSUFFICIENT_SCOPE
• OpenID Connect specific errors:
  • RegistrationError.INVALID_REDIRECT_URI
  • RegistrationError.INVALID_CLIENT_METADATA
  • RegistrationError.INVALID_SOFTWARE_STATEMENT
  • RegistrationError.UNAPPROVED_SOFTWARE_STATEMENT

Example HTTP response:

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

 {
  "error":"invalid_redirect_uri",
  "error_description":"The redirection URI of http://sketchy.example.com is not allowed for this server."
 }
 

Related specifications:

• OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section 3.2.2.
• OAuth 2.0 Bearer Token Usage (RFC 6750), section 3.1.

Constructor Summary

Constructors

Constructor and Description
ClientRegistrationErrorResponse(ErrorObject error) Creates a new client registration error response.

Method Summary

Methods

Modifier and Type	Method and Description
ErrorObject	getErrorObject() Gets the error associated with the error response.
static Set<ErrorObject>	getStandardErrors() Gets the standard errors for a client registration error response.
boolean	indicatesSuccess() Checks if the response indicates success.
static ClientRegistrationErrorResponse	parse(HTTPResponse httpResponse) Parses a client registration error response from the specified HTTP response.
HTTPResponse	toHTTPResponse() Returns the HTTP response for this client registration error response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRegistrationErrorResponse

public ClientRegistrationErrorResponse(ErrorObject error)

Creates a new client registration error response.

Parameters:

error - The error. Should match one of the standard errors for a client registration error response. Must not be null.

Method Detail

getStandardErrors

public static Set<ErrorObject> getStandardErrors()

Gets the standard errors for a client registration error response.

Returns:

The standard errors, as a read-only set.

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()

Returns the HTTP response for this client registration error response.

Example HTTP response:

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

 {
  "error":"invalid_redirect_uri",
  "error_description":"The redirection URI of http://sketchy.example.com is not allowed for this server."
 }
 

Specified by:

toHTTPResponse in interface Response

Returns:

The HTTP response.

parse

public static ClientRegistrationErrorResponse parse(HTTPResponse httpResponse)
                                             throws ParseException

Parses a client registration error response from the specified HTTP response.

Note: The HTTP status code is not checked for matching the error code semantics.

Parameters:

httpResponse - The HTTP response to parse. Its status code must not be 200 (OK). Must not be null.

Throws:

ParseException - If the HTTP response couldn't be parsed to a client registration error response.