io.vertx.reactivex.ext.web

Class UserContext

java.lang.Object

io.vertx.reactivex.ext.web.UserContext

All Implemented Interfaces:

io.vertx.lang.rx.RxDelegate

public class UserContext
extends Object
implements io.vertx.lang.rx.RxDelegate

A web user is extended user coupled to the context and is used to perform verifications and actions on behalf of the user. Actions can be:

• impersonate(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) - Require a re-authentication to switch user identities
• restore(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) - De-escalate a previous impersonate call
• logout(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) - Logout the user from this application and redirect to a uri
• clear() - Same as logout, without requirind a redirect

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<UserContext>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
UserContext(Object delegate)
UserContext(UserContext delegate)

Method Summary

Modifier and Type	Method and Description
boolean	authenticated()
void	clear() Clear can be called from any route handler which needs to terminate a login session.
boolean	equals(Object o)
User	get() Get the authenticated user (if any).
UserContext	getDelegate()
int	hashCode()
void	impersonate()
void	impersonate(Handler<AsyncResult<Void>> callback)
void	impersonate(String redirectUri)
void	impersonate(String redirectUri, Handler<AsyncResult<Void>> callback)
UserContext	loginHint(String loginHint) When performing a web identity operation, hint if possible to the identity provider to use the given login.
void	logout()
void	logout(Handler<AsyncResult<Void>> callback)
void	logout(String redirectUri)
void	logout(String redirectUri, Handler<AsyncResult<Void>> callback)
static UserContext	newInstance(UserContext arg)
void	restore()
void	restore(Handler<AsyncResult<Void>> callback)
void	restore(String redirectUri)
void	restore(String redirectUri, Handler<AsyncResult<Void>> callback)
Completable	rxImpersonate()
Completable	rxImpersonate(String redirectUri)
Completable	rxLogout()
Completable	rxLogout(String redirectUri)
Completable	rxRestore()
Completable	rxRestore(String redirectUri)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<UserContext> __TYPE_ARG

Constructor Detail

UserContext

public UserContext(UserContext delegate)

UserContext

public UserContext(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public UserContext getDelegate()

Specified by:

getDelegate in interface io.vertx.lang.rx.RxDelegate

get

public User get()

Get the authenticated user (if any). This will usually be injected by an auth handler if authentication if successful.

Returns:

the user, or null if the current user is not authenticated.

authenticated

public boolean authenticated()

loginHint

public UserContext loginHint(String loginHint)

When performing a web identity operation, hint if possible to the identity provider to use the given login.

Parameters:

loginHint - the desired login name, for example: admin.

Returns:

fluent self

impersonate

public void impersonate(Handler<AsyncResult<Void>> callback)

impersonate

public void impersonate()

rxImpersonate

public Completable rxImpersonate()

impersonate

public void impersonate(String redirectUri,
                        Handler<AsyncResult<Void>> callback)

impersonate

public void impersonate(String redirectUri)

rxImpersonate

public Completable rxImpersonate(String redirectUri)

restore

public void restore(Handler<AsyncResult<Void>> callback)

restore

public void restore()

rxRestore

public Completable rxRestore()

restore

public void restore(String redirectUri,
                    Handler<AsyncResult<Void>> callback)

restore

public void restore(String redirectUri)

rxRestore

public Completable rxRestore(String redirectUri)

logout

public void logout(String redirectUri,
                   Handler<AsyncResult<Void>> callback)

logout

public void logout(String redirectUri)

rxLogout

public Completable rxLogout(String redirectUri)

logout

public void logout(Handler<AsyncResult<Void>> callback)

logout

public void logout()

rxLogout

public Completable rxLogout()

clear

public void clear()

Clear can be called from any route handler which needs to terminate a login session. Invoking logout will remove the User and clear the Session (if any) in the current context. Unlike logout(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) no redirect will be performed.

newInstance

public static UserContext newInstance(UserContext arg)