class User extends AnyRef
Represents an authenticates User and contains operations to authorise the user.
Please consult the documentation for a detailed explanation.
- Alphabetic
- By Inheritance
- User
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new User(_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
-
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. * @return the User to enable fluent use
-
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] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isAuthorised(authority: String, resultHandler: Handler[AsyncResult[Boolean]]): User
-
def
isAuthorisedFuture(authority: String): Future[Boolean]
Like isAuthorised but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
def
isAuthorized(authority: String, resultHandler: Handler[AsyncResult[Boolean]]): User
Is the user authorised to * @param authority the authority - what this really means is determined by the specific implementation.
Is the user authorised to * @param 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 orfalse
otherwise.- returns
the User to enable fluent use
-
def
isAuthorizedFuture(authority: String): Future[Boolean]
Like isAuthorized but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
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()
-
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" `
* @return JSON representation of the Principal -
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. * @param authProvider the AuthProvider - this must be the same type of AuthProvider that originally created the User
-
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( ... )