io.vertx.ext.auth.impl

Class UserImpl

java.lang.Object

io.vertx.ext.auth.impl.UserImpl

All Implemented Interfaces:

ClusterSerializable, User

Direct Known Subclasses:

AccessTokenImpl

public class UserImpl
extends Object
implements User, ClusterSerializable

Default implementation of a User

Author:

Stephane Bastian

Constructor Summary

Constructors

Constructor and Description
UserImpl()
UserImpl(JsonObject principal)
UserImpl(JsonObject principal, JsonObject attributes)

Method Summary

Modifier and Type	Method and Description
JsonObject	attributes() Gets extra attributes of the user.
Authorizations	authorizations() Returns user's authorizations that have been previously loaded by the providers.
boolean	equals(Object obj)
int	hashCode()
User	isAuthorized(Authorization authorization, Handler<AsyncResult<Boolean>> resultHandler) Is the user authorised to
JsonObject	principal() Get the underlying principal for the User.
int	readFromBuffer(int pos, Buffer buffer)
void	setAuthProvider(AuthProvider authProvider) Set the auth provider for the User.
void	writeToBuffer(Buffer buffer)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.ext.auth.User

clearCache, containsKey, create, create, expired, expired, fromName, fromToken, get, isAuthorized, isAuthorized, isAuthorized

Constructor Detail

UserImpl

public UserImpl()

UserImpl

public UserImpl(JsonObject principal)

UserImpl

public UserImpl(JsonObject principal,
                JsonObject attributes)

Method Detail

authorizations

public Authorizations authorizations()

Description copied from interface: User

Returns user's authorizations that have been previously loaded by the providers.

Specified by:

authorizations in interface User

Returns:

authorizations holder for the user.

attributes

public JsonObject attributes()

Description copied from interface: User

Gets extra attributes of the user. Attributes contains any attributes related to the outcome of authenticating a user (e.g.: issued date, metadata, etc...)

Specified by:

attributes in interface User

Returns:

a json object with any relevant attribute.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAuthorized

public User isAuthorized(Authorization authorization,
                         Handler<AsyncResult<Boolean>> resultHandler)

Description copied from interface: User

Is the user authorised to

Specified by:

isAuthorized in interface User

Parameters:

authorization - 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.

Returns:

the User to enable fluent use

principal

public JsonObject principal()

Description copied from interface: 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"
   }
 

Specified by:

principal in interface User

Returns:

JSON representation of the Principal

setAuthProvider

public void setAuthProvider(AuthProvider authProvider)

Description copied from interface: 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.

Specified by:

setAuthProvider in interface User

Parameters:

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

writeToBuffer

public void writeToBuffer(Buffer buffer)

Specified by:

writeToBuffer in interface ClusterSerializable

readFromBuffer

public int readFromBuffer(int pos,
                          Buffer buffer)

Specified by:

readFromBuffer in interface ClusterSerializable