vertx-lang-scala-docs_2.12 3.4.0 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
- AccessToken
- KeycloakHelper
- OAuth2Auth
- OAuth2ClientOptions

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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     User
6.  def clearCache(): User

   The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time.

   The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time. Use this method if you want to clear this cache.

   returns

     the User to enable fluent use

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

    Check if the access token is expired or not.

11.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
12.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
13.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
14.  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.

    callback

      - The callback function returning the results.

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

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

16.  def isAuthorised(authority: String, resultHandler: Handler[AsyncResult[Boolean]]): User

    Is the user authorised to

    Is the user authorised to

    authority

      the authority - what this really means is determined by the specific implementation. It might represent a permission to access a resource e.g. `printers:printer34` or it might represent authority to a role in a roles based model, e.g. `role:admin`.

    resultHandler

      handler that will be called with an io.vertx.lang.scala.AsyncResult containing the value `true` if the they has the authority or `false` otherwise.

    returns

      the User to enable fluent use

    Definition Classes
      User
17.  def isAuthorisedFuture(authority: String): Future[Boolean]

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

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

    Definition Classes
      User
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  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.

    callback

      - The callback function returning the results.

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

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

21.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
22.  final def notify(): Unit
    Definition Classes
      AnyRef
23.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
24.  def principal(): JsonObject

    Get the underlying principal for the User.

    Get the underlying principal for the User. What this actually returns depends on the implementation. For a simple user/password based auth, it's likely to contain a JSON object with the following structure:

          {
            "username", "tim"
          `

    returns

      JSON representation of the Principal

    Definition Classes
      User
25.  def refresh(callback: Handler[AsyncResult[Unit]]): AccessToken

    Refresh the access token

    Refresh the access token

    callback

      - The callback function returning the results.

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

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

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

    Revoke access or refresh token

    Revoke access or refresh token

    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.

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

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

29.  def setAuthProvider(authProvider: AuthProvider): Unit

    Set the auth provider for the User.

    Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g. after it has been deserialized.

    authProvider

      the AuthProvider - this must be the same type of AuthProvider that originally created the User

    Definition Classes
      User
30.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
31.  def toString(): String
    Definition Classes
      AnyRef → Any
32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from User

### Inherited from AnyRef

### Inherited from Any

### Ungrouped