com.unboundid.scim.sdk

Class OAuthTokenStatus

java.lang.Object

com.unboundid.scim.sdk.OAuthTokenStatus

public final class OAuthTokenStatus
extends Object

This class defines the validation status of a OAuth 2.0 bearer token, and allows a OAuthTokenHandler extension to insert an error description and OAuth scope value to be returned to the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthTokenStatus.ErrorCode Possible values for the error_code.

Constructor Summary

Constructors

Constructor and Description
OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode) Constructs an OAuthTokenStatus with the given ErrorCode.
OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode, String errorDescription) Constructs an OAuthTokenStatus with the given ErrorCode and error description.
OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode, String errorDescription, String scope) Constructs an OAuthTokenStatus with the given ErrorCode, error description, and scope value.

Method Summary

Methods

Modifier and Type	Method and Description
OAuthTokenStatus.ErrorCode	getErrorCode() Gets the specified ErrorCode for this OAuthTokenStatus.
String	getErrorDescription() Gets the specified error description for this OAuthTokenStatus.
String	getScope() Gets the specified OAuth scope for this OAuthTokenStatus.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthTokenStatus

public OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode)

Constructs an OAuthTokenStatus with the given ErrorCode.

Parameters:

errorCode - the OAuthTokenStatus.ErrorCode to use. This must not be null.

OAuthTokenStatus

public OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode,
                String errorDescription)

Constructs an OAuthTokenStatus with the given ErrorCode and error description.

Parameters:

errorCode - the OAuthTokenStatus.ErrorCode to use. This must not be null.

errorDescription - a human-readable description of the error. This may be null.

OAuthTokenStatus

public OAuthTokenStatus(OAuthTokenStatus.ErrorCode errorCode,
                String errorDescription,
                String scope)

Constructs an OAuthTokenStatus with the given ErrorCode, error description, and scope value.

Parameters:

errorCode - the OAuthTokenStatus.ErrorCode to use. This must not be null.

errorDescription - a human-readable description of the error. This may be null.

scope - a space-delimited list of case-sensitive scope values indicating the required scope of the access token for accessing the requested resource. Scope values are implementation defined; there is no centralized registry for them; allowed values are defined by the authorization server. The order of scope values is not significant. This may be null.

Method Detail

getErrorCode

public OAuthTokenStatus.ErrorCode getErrorCode()

Gets the specified ErrorCode for this OAuthTokenStatus.

Returns:

an OAuthTokenStatus.ErrorCode instance.

getErrorDescription

public String getErrorDescription()

Gets the specified error description for this OAuthTokenStatus.

Returns:

a human-readable explanation of the error condition, or null if none was specified.

getScope

public String getScope()

Gets the specified OAuth scope for this OAuthTokenStatus.

Returns:

a space-delimited list of case-sensitive scope values indicating the required scope of the access token for accessing the requested resource. Scope values are implementation defined; there is no centralized registry for them; allowed values are defined by the authorization server. The order of scope values is not significant. This may return null if no scope was specified.