Package io.vertx.rxjava3.ext.web

Class UserContext

  • All Implemented Interfaces:
    RxDelegate
    public class UserContext
extends Object
implements 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() - Require a re-authentication to switch user identities
    • restore() - De-escalate a previous impersonate call
    • logout(java.lang.String) - 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.

    • Constructor Detail

      • UserContext

        public UserContext​(UserContext delegate)

      • UserContext

        public UserContext​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • 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 io.reactivex.rxjava3.core.Completable impersonate()

      • rxImpersonate

        public io.reactivex.rxjava3.core.Completable rxImpersonate()

      • impersonate

        public io.reactivex.rxjava3.core.Completable impersonate​(String redirectUri)

      • rxImpersonate

        public io.reactivex.rxjava3.core.Completable rxImpersonate​(String redirectUri)

      • restore

        public io.reactivex.rxjava3.core.Completable restore()

      • rxRestore

        public io.reactivex.rxjava3.core.Completable rxRestore()

      • restore

        public io.reactivex.rxjava3.core.Completable restore​(String redirectUri)

      • rxRestore

        public io.reactivex.rxjava3.core.Completable rxRestore​(String redirectUri)

      • logout

        public io.reactivex.rxjava3.core.Completable logout​(String redirectUri)

      • rxLogout

        public io.reactivex.rxjava3.core.Completable rxLogout​(String redirectUri)

      • logout

        public io.reactivex.rxjava3.core.Completable logout()

      • rxLogout

        public io.reactivex.rxjava3.core.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) no redirect will be performed.