## Uses of Interface
io.vertx.ext.auth.User

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

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

    Methods in io.vertx.ext.auth that return User
    Modifier and Type | Method and Description
    --- | ---
    `default User` | User.`clearCache()` Deprecated. This method will be removed. Use `Authorizations.clear()`
    `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.`isAuthorized(Authorization authority, Handler<AsyncResult<Boolean>> resultHandler)` Deprecated.
    `default User` | User.`isAuthorized(String authority, Handler<AsyncResult<Boolean>> resultHandler)` Deprecated. Use typed alternative `isAuthorized(Authorization, Handler)`
    `User` | User.`merge(User other)` Merge the principal and attributes of a second user into this object properties.

    Methods in io.vertx.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.ext.auth.authentication

    Methods in io.vertx.ext.auth.authentication that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `default Future<User>` | AuthenticationProvider.`authenticate(Credentials credentials)` Authenticate a user.
    `default Future<User>` | AuthenticationProvider.`authenticate(JsonObject credentials)` Deprecated. For type safety this method should be avoided and `AuthenticationProvider.authenticate(Credentials)` should be used instead.

    Method parameters in io.vertx.ext.auth.authentication with type arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `default void` | AuthenticationProvider.`authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler)` Authenticate a user.
    `void` | AuthenticationProvider.`authenticate(JsonObject credentials, Handler<AsyncResult<User>> resultHandler)` Deprecated. For type safety this method should be avoided and `AuthenticationProvider.authenticate(Credentials, Handler)` should be used instead.

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

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

    Methods in io.vertx.ext.auth.authorization with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `static AuthorizationContext` | AuthorizationContext.`create(User user)` Factory for Authorization Context
    `default Future<Void>` | AuthorizationProvider.`getAuthorizations(User user)` Updates the user with the set of authorizations.
    `void` | AuthorizationProvider.`getAuthorizations(User user, Handler<AsyncResult<Void>> handler)` Updates the user with the set of authorizations.
    `default boolean` | Authorization.`match(User user)` this methods verifies whether or not the authorization match the specified user.

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

    Methods in io.vertx.ext.auth.mongo with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `String` | HashStrategy.`computeHash(String password, User user)` Deprecated. Compute the hashed password given the unhashed password and the user
    `String` | HashStrategy.`getSalt(User user)` Deprecated. Retrieve the salt.
    `String` | HashStrategy.`getStoredPwd(User user)` Deprecated. Retrieve the password from the user, or as clear text or as hashed version, depending on the definition

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

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

    Methods in io.vertx.ext.auth.oauth2 with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `default 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.
    `Future<User>` | OAuth2Auth.`refresh(User user)` Refresh the current User (access token).
    `default OAuth2Auth` | OAuth2Auth.`refresh(User user, Handler<AsyncResult<User>> handler)` Refresh the current User (access token).
    `default Future<Void>` | OAuth2Auth.`revoke(User user)` Revoke an obtained access token.
    `default OAuth2Auth` | OAuth2Auth.`revoke(User user, Handler<AsyncResult<Void>> handler)` Revoke an obtained access token.
    `Future<Void>` | OAuth2Auth.`revoke(User user, String tokenType)` Revoke an obtained access or refresh token.
    `default OAuth2Auth` | OAuth2Auth.`revoke(User user, String tokenType, Handler<AsyncResult<Void>> handler)` Revoke an obtained access or refresh token.
    `Future<JsonObject>` | OAuth2Auth.`userInfo(User user)` Retrieve profile information and other attributes for a logged-in end-user.
    `default OAuth2Auth` | OAuth2Auth.`userInfo(User user, Handler<AsyncResult<JsonObject>> handler)` Retrieve profile information and other attributes for a logged-in end-user.

    Method parameters in io.vertx.ext.auth.oauth2 with type arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `default OAuth2Auth` | OAuth2Auth.`refresh(User user, Handler<AsyncResult<User>> handler)` Refresh the current User (access token).

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

    Methods in io.vertx.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 `AuthenticationProvider`.

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

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

    Methods in io.vertx.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.ext.web.client

    Methods in io.vertx.ext.web.client that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | OAuth2WebClient.`getUser()` Get the authenticated user (if any) that is associated with this client.

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

    Methods in io.vertx.ext.web.handler with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `Future<Void>` | SessionHandler.`setUser(RoutingContext context, User user)` Set the user for the session
    `default SessionHandler` | SessionHandler.`setUser(RoutingContext context, User user, Handler<AsyncResult<Void>> handler)` Set the user for the session

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

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

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

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

    Methods in io.vertx.reactivex.ext.auth that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | User.`getDelegate()`

    Methods in io.vertx.reactivex.ext.auth with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `static User` | User.`newInstance(User arg)`

    Constructors in io.vertx.reactivex.ext.auth with parameters of type User
    Constructor and Description
    `User(User delegate)`

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

    Methods in io.vertx.rxjava.ext.auth that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | User.`getDelegate()`

    Methods in io.vertx.rxjava.ext.auth with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `static User` | User.`newInstance(User arg)`

    Constructors in io.vertx.rxjava.ext.auth with parameters of type User
    Constructor and Description
    `User(User delegate)`

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

    Methods in io.vertx.rxjava3.ext.auth that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | User.`getDelegate()`

    Methods in io.vertx.rxjava3.ext.auth with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `static User` | User.`newInstance(User arg)`

    Constructors in io.vertx.rxjava3.ext.auth with parameters of type User
    Constructor and Description
    `User(User delegate)`

Copyright © 2024 Eclipse. All rights reserved.