public interface User
Please consult the documentation for a detailed explanation.
Modifier and Type | Method and Description |
---|---|
User |
clearCache()
The User object will cache any authorities that it knows it has to avoid hitting the
underlying auth provider each time.
|
default User |
isAuthorised(String authority,
Handler<AsyncResult<Boolean>> resultHandler)
Deprecated.
|
User |
isAuthorized(String authority,
Handler<AsyncResult<Boolean>> resultHandler)
Is the user authorised to
|
JsonObject |
principal()
Get the underlying principal for the User.
|
void |
setAuthProvider(AuthProvider authProvider)
Set the auth provider for the User.
|
User isAuthorized(String authority, Handler<AsyncResult<Boolean>> resultHandler)
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 AsyncResult
containing the value
`true` if the they has the authority or `false` otherwise.@Deprecated default User isAuthorised(String authority, Handler<AsyncResult<Boolean>> resultHandler)
isAuthorized(String, Handler)
User clearCache()
JsonObject principal()
{ "username", "tim" }
void setAuthProvider(AuthProvider authProvider)
authProvider
- the AuthProvider - this must be the same type of AuthProvider that originally created the UserCopyright © 2019 Eclipse. All rights reserved.