com.nimbusds.common.oauth2

Class BasicAccessTokenValidator

java.lang.Object

com.nimbusds.common.oauth2.BasicAccessTokenValidator

public class BasicAccessTokenValidator
extends Object

Basic access token validator, intended for JAX-RS web applications.

Field Summary

Fields

Modifier and Type	Field and Description
static javax.ws.rs.WebApplicationException	INVALID_BEARER_TOKEN Error response: Invalid OAuth 2.0 Bearer access token.
static javax.ws.rs.WebApplicationException	MISSING_BEARER_TOKEN Error response: Missing OAuth 2.0 Bearer access token.
static javax.ws.rs.WebApplicationException	WEB_API_DISABLED Error response: Web API disabled.

Constructor Summary

Constructors

Constructor and Description
BasicAccessTokenValidator(com.nimbusds.oauth2.sdk.token.BearerAccessToken accessToken) Creates a new basic access token validator.

Method Summary

Methods

Modifier and Type	Method and Description
com.nimbusds.oauth2.sdk.token.BearerAccessToken	getAccessToken() Returns the Bearer access token.
void	validateBearerAccessToken(String authzHeader) Validates a Bearer access token passed in the specified HTTP Authorization header value.

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_BEARER_TOKEN

public static final javax.ws.rs.WebApplicationException MISSING_BEARER_TOKEN

Error response: Missing OAuth 2.0 Bearer access token.

JSON object:

 {
   "error"             : "missing_token",
   "error_description" : "Unauthorized: Missing Bearer access token"
 }
 

INVALID_BEARER_TOKEN

public static final javax.ws.rs.WebApplicationException INVALID_BEARER_TOKEN

Error response: Invalid OAuth 2.0 Bearer access token.

JSON object:

 {
   "error"             : "invalid_token",
   "error_description" : "Unauthorized: Invalid Bearer access token"
 }
 

WEB_API_DISABLED

public static final javax.ws.rs.WebApplicationException WEB_API_DISABLED

Error response: Web API disabled.

JSON object:

 {
   "error"             : "web_api_disabled",
   "error_description" : "Forbidden: Web API disabled"
 }
 

Constructor Detail

BasicAccessTokenValidator

public BasicAccessTokenValidator(com.nimbusds.oauth2.sdk.token.BearerAccessToken accessToken)

Creates a new basic access token validator.

Parameters:

accessToken - The Bearer access token. If null access to the web API will be disabled.

Method Detail

getAccessToken

public com.nimbusds.oauth2.sdk.token.BearerAccessToken getAccessToken()

Returns the Bearer access token.

Returns:

The Bearer access token, null access to the web API is disabled.

validateBearerAccessToken

public void validateBearerAccessToken(String authzHeader)
                               throws javax.ws.rs.WebApplicationException

Validates a Bearer access token passed in the specified HTTP Authorization header value.

Parameters:

authzHeader - The HTTP Authorization header value, null if not specified.

Throws:

javax.ws.rs.WebApplicationException - If the header value is null, the web API is disabled, or the Bearer access token is missing or invalid.