## Uses of Class
io.vertx.rxjava3.ext.auth.User

- Packages that use User
  Package | Description
  --- | ---
  io.vertx.rxjava3.ext.auth |
  io.vertx.rxjava3.ext.auth.authentication |
  io.vertx.rxjava3.ext.auth.authorization |
  io.vertx.rxjava3.ext.auth.mongo |
  io.vertx.rxjava3.ext.auth.oauth2 |
  io.vertx.rxjava3.ext.stomp |
  io.vertx.rxjava3.ext.web |
  io.vertx.rxjava3.ext.web.handler |
  io.vertx.rxjava3.ext.web.handler.sockjs |

- - ### Uses of User in io.vertx.rxjava3.ext.auth

    Fields in io.vertx.rxjava3.ext.auth with type parameters of type User
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<User>` | User.`__TYPE_ARG`

    Methods in io.vertx.rxjava3.ext.auth that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | User.`clearCache()` Deprecated.
    `static User` | User.`create(JsonObject principal)` Factory for user instances that are free form.
    `static User` | User.`create(JsonObject principal, JsonObject attributes)` Factory for user instances that are free form.
    `static User` | User.`fromName(String username)` Factory for user instances that are single string.
    `static User` | User.`fromToken(String token)` Factory for user instances that are single string.
    `User` | User.`merge(User other)` Merge the principal and attributes of a second user into this object properties.
    `static User` | User.`newInstance(User arg)`

    Methods in io.vertx.rxjava3.ext.auth with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `User` | User.`merge(User other)` Merge the principal and attributes of a second user into this object properties.

  - ### Uses of User in io.vertx.rxjava3.ext.auth.authentication

    Methods in io.vertx.rxjava3.ext.auth.authentication that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `Single<User>` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`authenticate(JsonObject credentials)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate(Credentials credentials)` Authenticate a user.
    `Single<User>` | AuthenticationProvider.`rxAuthenticate(JsonObject credentials)` Authenticate a user.

  - ### Uses of User in io.vertx.rxjava3.ext.auth.authorization

    Methods in io.vertx.rxjava3.ext.auth.authorization that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | AuthorizationContext.`user()` Get the authenticated user

    Methods in io.vertx.rxjava3.ext.auth.authorization with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `static AuthorizationContext` | AuthorizationContext.`create(User user)` Factory for Authorization Context
    `Completable` | AuthorizationProvider.`getAuthorizations(User user)` Updates the user with the set of authorizations.
    `boolean` | Authorization.`match(User user)` this methods verifies whether or not the authorization match the specified user.
    `Completable` | AuthorizationProvider.`rxGetAuthorizations(User user)` Updates the user with the set of authorizations.

  - ### Uses of User in io.vertx.rxjava3.ext.auth.mongo

    Methods in io.vertx.rxjava3.ext.auth.mongo with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `String` | HashStrategy.`computeHash(String password, User user)` Deprecated.
    `String` | HashStrategy.`getSalt(User user)` Deprecated.
    `String` | HashStrategy.`getStoredPwd(User user)` Deprecated.

  - ### Uses of User in io.vertx.rxjava3.ext.auth.oauth2

    Methods in io.vertx.rxjava3.ext.auth.oauth2 that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `Single<User>` | OAuth2Auth.`refresh(User user)` Refresh the current User (access token).
    `Single<User>` | OAuth2Auth.`rxRefresh(User user)` Refresh the current User (access token).

    Methods in io.vertx.rxjava3.ext.auth.oauth2 with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `String` | OAuth2Auth.`endSessionURL(User user)` The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
    `String` | OAuth2Auth.`endSessionURL(User user, JsonObject params)` The logout (end-session) endpoint is specified in OpenID Connect Session Management 1.0.
    `Single<User>` | OAuth2Auth.`refresh(User user)` Refresh the current User (access token).
    `Completable` | OAuth2Auth.`revoke(User user)` Revoke an obtained access token.
    `Completable` | OAuth2Auth.`revoke(User user, String tokenType)` Revoke an obtained access or refresh token.
    `Single<User>` | OAuth2Auth.`rxRefresh(User user)` Refresh the current User (access token).
    `Completable` | OAuth2Auth.`rxRevoke(User user)` Revoke an obtained access token.
    `Completable` | OAuth2Auth.`rxRevoke(User user, String tokenType)` Revoke an obtained access or refresh token.
    `Single<JsonObject>` | OAuth2Auth.`rxUserInfo(User user)` Retrieve profile information and other attributes for a logged-in end-user.
    `Single<JsonObject>` | OAuth2Auth.`userInfo(User user)` Retrieve profile information and other attributes for a logged-in end-user.

  - ### Uses of User in io.vertx.rxjava3.ext.stomp

    Methods in io.vertx.rxjava3.ext.stomp that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | StompServerHandler.`getUserBySession(String session)` Provides for authorization matches on a destination level, this will return the User created by the .

  - ### Uses of User in io.vertx.rxjava3.ext.web

    Methods in io.vertx.rxjava3.ext.web that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | RoutingContext.`user()` Get the authenticated user (if any).

    Methods in io.vertx.rxjava3.ext.web with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoutingContext.`setUser(User user)` Set the user.

  - ### Uses of User in io.vertx.rxjava3.ext.web.handler

    Methods in io.vertx.rxjava3.ext.web.handler with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `Completable` | SessionHandler.`rxSetUser(RoutingContext context, User user)` Set the user for the session
    `Completable` | SessionHandler.`setUser(RoutingContext context, User user)` Set the user for the session

    Method parameters in io.vertx.rxjava3.ext.web.handler with type arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `SimpleAuthenticationHandler` | SimpleAuthenticationHandler.`authenticate(java.util.function.Function<RoutingContext,Single<User>> authenticationFunction)` This function will allow you to perform authentication the way you intended to.

  - ### Uses of User in io.vertx.rxjava3.ext.web.handler.sockjs

    Methods in io.vertx.rxjava3.ext.web.handler.sockjs that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | SockJSSocket.`webUser()`

Copyright © 2021 Eclipse. All rights reserved.