io.vertx.ext.auth.oauth2

Interface AccessToken

All Superinterfaces:

User

Deprecated.

@Deprecated
public interface AccessToken
extends User

AccessToken extension to the User interface

Author:

Paulo Lopes

Method Summary

Modifier and Type	Method and Description
JsonObject	accessToken() Deprecated. The Access Token if present parsed as a JsonObject
boolean	expired() Deprecated. Check if the access token is expired or not.
AccessToken	fetch(HttpMethod method, String resource, JsonObject headers, Buffer payload, Handler<AsyncResult<OAuth2Response>> callback) Deprecated. Fetches a JSON resource using this Access Token.
default AccessToken	fetch(String resource, Handler<AsyncResult<OAuth2Response>> callback) Deprecated. Fetches a JSON resource using this Access Token.
JsonObject	idToken() Deprecated. The Id Token if present parsed as a JsonObject
AccessToken	introspect(Handler<AsyncResult<Void>> callback) Deprecated. Introspect access token.
AccessToken	introspect(String tokenType, Handler<AsyncResult<Void>> callback) Deprecated. Introspect access token.
AccessToken	logout(Handler<AsyncResult<Void>> callback) Deprecated. Revoke refresh token and calls the logout endpoint.
String	opaqueAccessToken() Deprecated. The RAW String if available for the Access Token
String	opaqueIdToken() Deprecated. The RAW String if available for the Id Token
String	opaqueRefreshToken() Deprecated. The RAW String if available for the Refresh Token
AccessToken	refresh(Handler<AsyncResult<Void>> callback) Deprecated. Refresh the access token
JsonObject	refreshToken() Deprecated. refresh tokens are specific to the provider and should not be handled by the consumer. Tokens are still available as an opaque string.
AccessToken	revoke(String token_type, Handler<AsyncResult<Void>> callback) Deprecated. Revoke access or refresh token
AccessToken	setTrustJWT(boolean trust) Deprecated.
String	tokenType() Deprecated.
AccessToken	userInfo(Handler<AsyncResult<JsonObject>> callback) Deprecated. Load the user info as per OIDC spec.

Methods inherited from interface io.vertx.ext.auth.User

clearCache, isAuthorised, isAuthorized, principal, setAuthProvider

Method Detail

expired

boolean expired()

Deprecated.

Check if the access token is expired or not.

accessToken

JsonObject accessToken()

Deprecated.

The Access Token if present parsed as a JsonObject

Returns:

JSON

refreshToken

@Deprecated
JsonObject refreshToken()

Deprecated. refresh tokens are specific to the provider and should not be handled by the consumer. Tokens are still available as an opaque string.

The Refresh Token if present parsed as a JsonObject

Returns:

JSON

idToken

JsonObject idToken()

Deprecated.

The Id Token if present parsed as a JsonObject

Returns:

JSON

opaqueAccessToken

String opaqueAccessToken()

Deprecated.

The RAW String if available for the Access Token

Returns:

String

opaqueRefreshToken

String opaqueRefreshToken()

Deprecated.

The RAW String if available for the Refresh Token

Returns:

String

opaqueIdToken

String opaqueIdToken()

Deprecated.

The RAW String if available for the Id Token

Returns:

String

tokenType

String tokenType()

Deprecated.

setTrustJWT

AccessToken setTrustJWT(boolean trust)

Deprecated.

refresh

AccessToken refresh(Handler<AsyncResult<Void>> callback)

Deprecated.

Refresh the access token

Parameters:

callback - - The callback function returning the results.

revoke

AccessToken revoke(String token_type,
                   Handler<AsyncResult<Void>> callback)

Deprecated.

Revoke access or refresh token

Parameters:

token_type - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

callback - - The callback function returning the results.

logout

AccessToken logout(Handler<AsyncResult<Void>> callback)

Deprecated.

Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.

Parameters:

callback - - The callback function returning the results.

introspect

AccessToken introspect(Handler<AsyncResult<Void>> callback)

Deprecated.

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

callback - - The callback function returning the results.

introspect

AccessToken introspect(String tokenType,
                       Handler<AsyncResult<Void>> callback)

Deprecated.

Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.

Parameters:

tokenType - - A String containing the type of token to revoke. Should be either "access_token" or "refresh_token".

callback - - The callback function returning the results.

userInfo

AccessToken userInfo(Handler<AsyncResult<JsonObject>> callback)

Deprecated.

Load the user info as per OIDC spec.

Parameters:

callback - - The callback function returning the results.

fetch

default AccessToken fetch(String resource,
                          Handler<AsyncResult<OAuth2Response>> callback)

Deprecated.

Fetches a JSON resource using this Access Token.

Parameters:

resource - - the resource to fetch.

callback - - The callback function returning the results.

fetch

AccessToken fetch(HttpMethod method,
                  String resource,
                  JsonObject headers,
                  Buffer payload,
                  Handler<AsyncResult<OAuth2Response>> callback)

Deprecated.

Fetches a JSON resource using this Access Token.

Parameters:

method - - the HTTP method to user.

resource - - the resource to fetch.

headers - - extra headers to pass to the request.

payload - - payload to send to the server.

callback - - The callback function returning the results.