com.nimbusds.common.oauth2

Class BasicAccessTokenValidator

java.lang.Object

com.nimbusds.common.oauth2.BasicAccessTokenValidator

public class BasicAccessTokenValidator
extends Object

Basic access token validator. Supports servlet-based and JAX-RS based web applications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicAccessTokenValidator.ErrorResponse Bearer token error response.

Field Summary

Fields

Modifier and Type	Field and Description
static BasicAccessTokenValidator.ErrorResponse	INVALID_BEARER_TOKEN Error response: Invalid OAuth 2.0 Bearer access token.
static BasicAccessTokenValidator.ErrorResponse	MISSING_BEARER_TOKEN Error response: Missing OAuth 2.0 Bearer access token.
static BasicAccessTokenValidator.ErrorResponse	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

Modifier and Type	Method and Description
com.nimbusds.oauth2.sdk.token.BearerAccessToken	getAccessToken() Returns the Bearer access token.
boolean	validateBearerAccessToken(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Validates a bearer access token passed in the specified HTTP servlet request.
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 BasicAccessTokenValidator.ErrorResponse MISSING_BEARER_TOKEN

Error response: Missing OAuth 2.0 Bearer access token.

INVALID_BEARER_TOKEN

public static final BasicAccessTokenValidator.ErrorResponse INVALID_BEARER_TOKEN

Error response: Invalid OAuth 2.0 Bearer access token.

WEB_API_DISABLED

public static final BasicAccessTokenValidator.ErrorResponse WEB_API_DISABLED

Error response: 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.

validateBearerAccessToken

public boolean validateBearerAccessToken(javax.servlet.http.HttpServletRequest servletRequest,
                                         javax.servlet.http.HttpServletResponse servletResponse)
                                  throws IOException

Validates a bearer access token passed in the specified HTTP servlet request.

Parameters:

servletRequest - The HTTP servlet request. Must not be null.

servletResponse - The HTTP servlet response. Must not be null.

Returns:

true if the bearer access token was successfully validated, false.

Throws:

IOException - If the response couldn't be written.