Package io.quarkus.vertx.http.runtime.security

Class QuarkusHttpUser

java.lang.Object
io.quarkus.vertx.http.runtime.security.QuarkusHttpUser
All Implemented Interfaces:
io.vertx.ext.auth.User
public class QuarkusHttpUser extends Object implements io.vertx.ext.auth.User
Basic vert.x user representation

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUTH_FAILURE_HANDLER
    The key that stores a BiConsumer that handles auth failures This can be overridden by downstream handlers such as Undertow to control auth failure handling.
    static final String
    DEFERRED_IDENTITY_KEY
    Only used when proactive auth is disabled

  • Constructor Summary

    Constructors
    Constructor
    Description
    QuarkusHttpUser(io.quarkus.security.identity.SecurityIdentity securityIdentity)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.vertx.core.json.JsonObject
    attributes()
     
    io.vertx.ext.auth.User
    clearCache()
    Deprecated.
    io.quarkus.security.identity.SecurityIdentity
    getSecurityIdentity()
     
    static io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>
    getSecurityIdentity(io.vertx.ext.web.RoutingContext routingContext, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
    Gets the current user from the routing context.
    static io.quarkus.security.identity.SecurityIdentity
    getSecurityIdentityBlocking(io.vertx.ext.web.RoutingContext routingContext, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
    Gets the current user from the routing context.
    io.vertx.ext.auth.User
    isAuthorized(io.vertx.ext.auth.authorization.Authorization authority, io.vertx.core.Handler<io.vertx.core.AsyncResult<Boolean>> resultHandler)
     
    io.vertx.ext.auth.User
    isAuthorized(String authority, io.vertx.core.Handler<io.vertx.core.AsyncResult<Boolean>> resultHandler)
     
    io.vertx.ext.auth.User
    merge(io.vertx.ext.auth.User other)
     
    io.vertx.core.json.JsonObject
    principal()
     
    void
    setAuthProvider(io.vertx.ext.auth.AuthProvider authProvider)
    Deprecated.
    static io.quarkus.security.identity.SecurityIdentity
    setIdentity(io.quarkus.security.identity.SecurityIdentity identity, io.vertx.ext.web.RoutingContext routingContext)
     
    (package private) static io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>
    setIdentity(io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identityUni, io.vertx.ext.web.RoutingContext routingContext)
     

    Methods inherited from class java.lang.Object

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

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

    authorizations, containsKey, expired, expired, get, getOrDefault, hasAmr, isAuthorized, isAuthorized, subject

  • Field Details

    • DEFERRED_IDENTITY_KEY

      public static final String DEFERRED_IDENTITY_KEY
      Only used when proactive auth is disabled
      See Also:

    • AUTH_FAILURE_HANDLER

      public static final String AUTH_FAILURE_HANDLER
      The key that stores a BiConsumer that handles auth failures This can be overridden by downstream handlers such as Undertow to control auth failure handling.
      See Also:

  • Constructor Details

    • QuarkusHttpUser

      public QuarkusHttpUser(io.quarkus.security.identity.SecurityIdentity securityIdentity)

  • Method Details

    • attributes

      public io.vertx.core.json.JsonObject attributes()
      Specified by:
      attributes in interface io.vertx.ext.auth.User

    • isAuthorized

      public io.vertx.ext.auth.User isAuthorized(io.vertx.ext.auth.authorization.Authorization authority, io.vertx.core.Handler<io.vertx.core.AsyncResult<Boolean>> resultHandler)
      Specified by:
      isAuthorized in interface io.vertx.ext.auth.User

    • isAuthorized

      public io.vertx.ext.auth.User isAuthorized(String authority, io.vertx.core.Handler<io.vertx.core.AsyncResult<Boolean>> resultHandler)
      Specified by:
      isAuthorized in interface io.vertx.ext.auth.User

    • clearCache

      @Deprecated public io.vertx.ext.auth.User clearCache()
      Deprecated.
      Specified by:
      clearCache in interface io.vertx.ext.auth.User

    • principal

      public io.vertx.core.json.JsonObject principal()
      Specified by:
      principal in interface io.vertx.ext.auth.User

    • setAuthProvider

      @Deprecated public void setAuthProvider(io.vertx.ext.auth.AuthProvider authProvider)
      Deprecated.
      Specified by:
      setAuthProvider in interface io.vertx.ext.auth.User

    • getSecurityIdentity

      public io.quarkus.security.identity.SecurityIdentity getSecurityIdentity()

    • getSecurityIdentityBlocking

      public static io.quarkus.security.identity.SecurityIdentity getSecurityIdentityBlocking(io.vertx.ext.web.RoutingContext routingContext, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
      Gets the current user from the routing context. This method may block if proactive authentication is disabled, as it may need to perform a potentially blocking operation. If an IPM is provided this method will return the anonymous identity if there is no active user, otherwise it will return null if there is no user.

    • merge

      public io.vertx.ext.auth.User merge(io.vertx.ext.auth.User other)
      Specified by:
      merge in interface io.vertx.ext.auth.User

    • getSecurityIdentity

      public static io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> getSecurityIdentity(io.vertx.ext.web.RoutingContext routingContext, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
      Gets the current user from the routing context. If an IPM is provided this method will return the anonymous identity if there is no active user, otherwise the Uni will resolve to null if there is no user.

    • setIdentity

      static io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> setIdentity(io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identityUni, io.vertx.ext.web.RoutingContext routingContext)

    • setIdentity

      public static io.quarkus.security.identity.SecurityIdentity setIdentity(io.quarkus.security.identity.SecurityIdentity identity, io.vertx.ext.web.RoutingContext routingContext)