com.authlete.jaxrs

Class AccessTokenValidator

java.lang.Object

com.authlete.jaxrs.AccessTokenValidator

public class AccessTokenValidator
extends Object

Access token validator.

Since:

1.2

Author:

Takahiko Kawasaki

Constructor Summary

Constructors

Constructor and Description
AccessTokenValidator(com.authlete.common.api.AuthleteApi api) Constructor with an implementation of AuthleteApi interface.

Method Summary

Modifier and Type	Method and Description
protected com.authlete.jaxrs.AuthleteApiCaller	getApiCaller()
protected javax.ws.rs.InternalServerErrorException	unexpected(String message, Throwable cause)
AccessTokenInfo	validate(String accessToken) Validate an access token.
AccessTokenInfo	validate(String accessToken, String[] requiredScopes) Validate an access token.
AccessTokenInfo	validate(String accessToken, String[] requiredScopes, String requiredSubject) Validate an access token.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenValidator

public AccessTokenValidator(com.authlete.common.api.AuthleteApi api)

Constructor with an implementation of AuthleteApi interface.

Parameters:

api - Implementation of AuthleteApi interface.

Method Detail

validate

public AccessTokenInfo validate(String accessToken)
                         throws javax.ws.rs.WebApplicationException

Validate an access token. This method is an alias of validate(accessToken, null, null).

When the given access token is not valid, this method throws a WebApplicationException. The response contained in the exception complies with the requirements described in RFC 6750 (The OAuth 2.0 Authorization Framework: Bearer Token Usage).

Parameters:

accessToken - An access token to validate.

Returns:

Information about the access token.

Throws:

javax.ws.rs.WebApplicationException - The access token is invalid. To be concrete, the access token does not exist or it has expired.

validate

public AccessTokenInfo validate(String accessToken,
                                String[] requiredScopes)
                         throws javax.ws.rs.WebApplicationException

Validate an access token. This method is an alias of validate(accessToken, requiredScopes, null).

When the given access token is not valid, this method throws a WebApplicationException. The response contained in the exception complies with the requirements described in RFC 6750 (The OAuth 2.0 Authorization Framework: Bearer Token Usage).

Parameters:

accessToken - An access token to validate.

requiredScopes - Scopes that must be associated with the access token. null is okay.

Returns:

Information about the access token.

Throws:

javax.ws.rs.WebApplicationException - The access token is invalid. To be concrete, one or more of the following conditions meet.

1. The access token does not exist.
2. The access token has expired.
3. The access token does not cover the required scopes.

validate

public AccessTokenInfo validate(String accessToken,
                                String[] requiredScopes,
                                String requiredSubject)
                         throws javax.ws.rs.WebApplicationException

Validate an access token.

When the given access token is not valid, this method throws a WebApplicationException. The response contained in the exception complies with the requirements described in RFC 6750 (The OAuth 2.0 Authorization Framework: Bearer Token Usage).

Parameters:

accessToken - An access token to validate.

requiredScopes - Scopes that must be associated with the access token. null is okay.

requiredSubject - Subject (= user's unique identifier) that must be associated with the access token. null is okay.

Returns:

Information about the access token.

Throws:

javax.ws.rs.WebApplicationException - The access token is invalid. To be concrete, one or more of the following conditions meet.

1. The access token does not exist.
2. The access token has expired.
3. The access token does not cover the required scopes.
4. The access token is not associated with the required subject.

getApiCaller

protected com.authlete.jaxrs.AuthleteApiCaller getApiCaller()

unexpected

protected javax.ws.rs.InternalServerErrorException unexpected(String message,
                                                              Throwable cause)