class JWTAuth extends AuthProvider
Factory interface for creating JWT based io.vertx.scala.ext.auth.AuthProvider instances.
- Alphabetic
- By Inheritance
- JWTAuth
- AuthProvider
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new JWTAuth(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- AuthProvider
-
def
authenticate(authInfo: JsonObject, resultHandler: Handler[AsyncResult[User]]): Unit
Authenticate a user.
Authenticate a user.
The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:
{ "username": "tim", "password": "mypassword" `
For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.If the user is successfully authenticated a io.vertx.scala.ext.auth.User object is passed to the handler in an io.vertx.scala.core.AsyncResult. The user object can then be used for authorisation. * @param authInfo The auth information
- resultHandler
The result handler
- Definition Classes
- AuthProvider
-
def
authenticateFuture(authInfo: JsonObject): Future[User]
Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
- Definition Classes
- AuthProvider
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
generateToken(claims: JsonObject, options: JWTOptions): String
Generate a new JWT token.
Generate a new JWT token. * @param claims Json with user defined claims for a list of official claims
- options
extra options for the generation see JWTOptions
- returns
JWT encoded token
-
def
generateToken(claims: JsonObject): String
Generate a new JWT token.
Generate a new JWT token. * @param claims Json with user defined claims for a list of official claims
- returns
JWT encoded token
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )