vertx-auth-oauth2-scala_2.12 3.6.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package auth
  Definition Classes
    ext
-  package oauth2
  Definition Classes
    auth
-  package providers
  Definition Classes
    oauth2
-  package rbac
  Definition Classes
    oauth2
- AccessToken
- KeycloakHelper
- OAuth2Auth
- OAuth2ClientOptions
- OAuth2RBAC
- OAuth2Response

c

io.vertx.scala.ext.auth.oauth2

# AccessToken 

###
Companion object AccessToken

#### class AccessToken extends User

AccessToken extension to the User interface

Linear Supertypes
User, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AccessToken
2. User
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new AccessToken(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def accessToken(): JsonObject

   The Access Token if present parsed as a JsonObject * @return JSON

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: AnyRef
   Definition Classes
     User
7.  def clearCache(): User
   Definition Classes
     User
8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
9.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
10.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
11.  def expired(): Boolean

    Check if the access token is expired or not.

12.  def fetch(method: HttpMethod, resource: String, headers: JsonObject, payload: Buffer, callback: Handler[AsyncResult[OAuth2Response]]): AccessToken

    Fetches a JSON resource using this Access Token.

    Fetches a JSON resource using this Access Token. * @param 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.

13.  def fetch(resource: String, callback: Handler[AsyncResult[OAuth2Response]]): AccessToken

    Fetches a JSON resource using this Access Token.

    Fetches a JSON resource using this Access Token. * @param resource - the resource to fetch.

    callback

      - The callback function returning the results.

14.  def fetchFuture(method: HttpMethod, resource: String, headers: JsonObject, payload: Buffer): Future[OAuth2Response]

    Like fetch but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

15.  def fetchFuture(resource: String): Future[OAuth2Response]

    Like fetch but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

16.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
17.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  def idToken(): JsonObject

    The Id Token if present parsed as a JsonObject * @return JSON

20.  def introspect(tokenType: String, callback: Handler[AsyncResult[Unit]]): AccessToken

    Introspect access token.

    Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid. * @param 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.

21.  def introspect(callback: Handler[AsyncResult[Unit]]): AccessToken

    Introspect access token.

    Introspect access token. This is an OAuth2 extension that allow to verify if an access token is still valid. * @param callback - The callback function returning the results.

22.  def introspectFuture(tokenType: String): Future[Unit]

    Like introspect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

23.  def introspectFuture(): Future[Unit]

    Like introspect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

24.  def isAuthorised(authority: String, resultHandler: Handler[AsyncResult[Boolean]]): User
    Definition Classes
      User
25.  def isAuthorisedFuture(authority: String): Future[Boolean]
    Definition Classes
      User
26.  def isAuthorized(authority: String, resultHandler: Handler[AsyncResult[Boolean]]): User
    Definition Classes
      User
27.  def isAuthorizedFuture(authority: String): Future[Boolean]
    Definition Classes
      User
28.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
29.  def logout(callback: Handler[AsyncResult[Unit]]): AccessToken

    Revoke refresh token and calls the logout endpoint.

    Revoke refresh token and calls the logout endpoint. This is a openid-connect extension and might not be available on all providers. * @param callback - The callback function returning the results.

30.  def logoutFuture(): Future[Unit]

    Like logout but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

31.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
32.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
33.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
34.  def opaqueAccessToken(): String

    The RAW String if available for the Access Token * @return String

35.  def opaqueIdToken(): String

    The RAW String if available for the Id Token * @return String

36.  def opaqueRefreshToken(): String

    The RAW String if available for the Refresh Token * @return String

37.  def principal(): JsonObject
    Definition Classes
      User
38.  def refresh(callback: Handler[AsyncResult[Unit]]): AccessToken

    Refresh the access token * @param callback - The callback function returning the results.

39.  def refreshFuture(): Future[Unit]

    Like refresh but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

40.  def refreshToken(): JsonObject

    The Refresh Token if present parsed as a JsonObject * @return JSON

41.  def revoke(token_type: String, callback: Handler[AsyncResult[Unit]]): AccessToken

    Revoke access or refresh token * @param token_type - A String containing the type of token to revoke.

    Revoke access or refresh token * @param 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.

42.  def revokeFuture(token_type: String): Future[Unit]

    Like revoke but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

43.  def setAuthProvider(authProvider: AuthProvider): Unit
    Definition Classes
      User
44.  def setTrustJWT(trust: Boolean): AccessToken
45.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
46.  def toString(): String
    Definition Classes
      AnyRef → Any
47.  def tokenType(): String
48.  def userInfo(callback: Handler[AsyncResult[JsonObject]]): AccessToken

    Load the user info as per OIDC spec.

    Load the user info as per OIDC spec. * @param callback - The callback function returning the results.

49.  def userInfoFuture(): Future[JsonObject]

    Like userInfo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

50.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
51.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
52.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from User

### Inherited from AnyRef

### Inherited from Any

### Ungrouped