com.nimbusds.oauth2.sdk

Class TokenIntrospectionErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.TokenIntrospectionResponse

com.nimbusds.oauth2.sdk.TokenIntrospectionErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response

@Immutable
public class TokenIntrospectionErrorResponse
extends TokenIntrospectionResponse
implements ErrorResponse

Token introspection error response.

Standard errors:

• OAuth2Error.INVALID_REQUEST
• OAuth2Error.INVALID_CLIENT
• BearerTokenError.MISSING_TOKEN
• BearerTokenError.INVALID_REQUEST
• BearerTokenError.INVALID_TOKEN
• BearerTokenError.INSUFFICIENT_SCOPE

Example HTTP response:

 HTTP/1.1 401 Unauthorized
 WWW-Authenticate: Bearer realm="example.com",
                   error="invalid_token",
                   error_description="The access token expired"
 

Related specifications:

• OAuth 2.0 Token Introspection (RFC 7662).

Constructor Summary

Constructors

Constructor and Description
TokenIntrospectionErrorResponse(ErrorObject error) Creates a new token introspection error response.

Method Summary

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 token introspection error response.
boolean	indicatesSuccess() Checks if the response indicates success.
static TokenIntrospectionErrorResponse	parse(HTTPResponse httpResponse) Parses a token introspection error response from the specified HTTP response.
HTTPResponse	toHTTPResponse() Returns the matching HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenIntrospectionErrorResponse

public TokenIntrospectionErrorResponse(ErrorObject error)

Creates a new token introspection error response.

Parameters:

error - The error, null if not specified.

Method Detail

getStandardErrors

public static Set<ErrorObject> getStandardErrors()

Gets the standard errors for a token introspection error response.

Returns:

The standard errors, as a read-only set.

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.

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.

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 TokenIntrospectionErrorResponse parse(HTTPResponse httpResponse)
                                             throws ParseException

Parses a token introspection error response from the specified HTTP response.

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 token introspection error response.