AccessToken (Vert.x Stack - Docs 4.1.8 API)

All Superinterfaces:

User

Deprecated.
```
@Deprecated
public interface AccessToken
extends User
```
AccessToken extension to the User interface

Author:

Paulo Lopes

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`JsonObject`	`accessToken()` Deprecated. The Access Token if present parsed as a JsonObject
`default Future<OAuth2Response>`	`fetch(HttpMethod method, String resource, JsonObject headers, Buffer payload)` Deprecated. Fetches a JSON resource using this Access Token.
`AccessToken`	`fetch(HttpMethod method, String resource, JsonObject headers, Buffer payload, Handler<AsyncResult<OAuth2Response>> callback)` Deprecated. Fetches a JSON resource using this Access Token.
`default Future<OAuth2Response>`	`fetch(String resource)` 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
`default Future<Void>`	`introspect()` Deprecated. Introspect access token.
`AccessToken`	`introspect(Handler<AsyncResult<Void>> callback)` Deprecated. Introspect access token.
`default Future<Void>`	`introspect(String tokenType)` Deprecated. Introspect access token.
`AccessToken`	`introspect(String tokenType, Handler<AsyncResult<Void>> callback)` Deprecated. Introspect access token.
`boolean`	`isScopeGranted()` Deprecated. Check if the access token own the required scopes to access to the resource.
`default Future<Void>`	`logout()` Deprecated. Revoke refresh token and calls the logout endpoint.
`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
`default Future<Void>`	`refresh()` Deprecated. Refresh the access token
`AccessToken`	`refresh(Handler<AsyncResult<Void>> callback)` Deprecated. Refresh the access token
`default Future<Void>`	`revoke(String token_type)` Deprecated. Revoke access or refresh token
`AccessToken`	`revoke(String token_type, Handler<AsyncResult<Void>> callback)` Deprecated. Revoke access or refresh token
`AccessToken`	`setTrustJWT(boolean trust)` Deprecated.
`String`	`tokenType()` Deprecated.
`default Future<JsonObject>`	`userInfo()` Deprecated. Load the user info as per OIDC spec.
`AccessToken`	`userInfo(Handler<AsyncResult<JsonObject>> callback)` Deprecated. Load the user info as per OIDC spec.

Methods inherited from interface io.vertx.ext.auth.User
attributes, authorizations, clearCache, containsKey, create, create, expired, expired, fromName, fromToken, get, isAuthorized, isAuthorized, isAuthorized, isAuthorized, principal, setAuthProvider

- Method Detail
  - isScopeGranted
```
boolean isScopeGranted()
```
    Deprecated.
    
    Check if the access token own the required scopes to access to the resource.
  - accessToken
```
JsonObject accessToken()
```
    Deprecated.
    
    The Access 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.
  - refresh
```
default Future<Void> refresh()
```
    Deprecated.
    
    Refresh the access token
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    refresh(Handler)
  - 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.
  - revoke
```
default Future<Void> revoke(String token_type)
```
    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".
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    revoke(String, Handler)
  - 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.
  - logout
```
default Future<Void> logout()
```
    Deprecated.
    
    Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers.
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    logout(Handler)
  - 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
```
default Future<Void> introspect()
```
    Deprecated.
    
    Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid.
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    introspect(Handler)
  - 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.
  - introspect
```
default Future<Void> introspect(String tokenType)
```
    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".
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    introspect(String, Handler)
  - userInfo
```
AccessToken userInfo(Handler<AsyncResult<JsonObject>> callback)
```
    Deprecated.
    
    Load the user info as per OIDC spec.
    
    Parameters:
    
    callback - - The callback function returning the results.
  - userInfo
```
default Future<JsonObject> userInfo()
```
    Deprecated.
    
    Load the user info as per OIDC spec.
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    userInfo(Handler)
  - 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
```
default Future<OAuth2Response> fetch(String resource)
```
    Deprecated.
    
    Fetches a JSON resource using this Access Token.
    
    Parameters:
    
    resource - - the resource to fetch.
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    fetch(String, Handler)
  - 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.
  - fetch
```
default Future<OAuth2Response> fetch(HttpMethod method,
                                     String resource,
                                     JsonObject headers,
                                     Buffer payload)
```
    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.
    
    Returns:
    
    future returning the results.
    
    See Also:
    
    fetch(HttpMethod, String, JsonObject, Buffer, Handler)

Interface AccessToken

Method Summary

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

Method Detail

isScopeGranted

accessToken

idToken

opaqueAccessToken

opaqueRefreshToken

opaqueIdToken

tokenType

setTrustJWT

refresh

refresh

revoke

revoke

logout

logout

introspect

introspect

introspect

introspect

userInfo

userInfo

fetch

fetch

fetch

fetch