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

Class HttpAuthenticator

java.lang.Object

io.quarkus.vertx.http.runtime.security.HttpAuthenticator

@Singleton
public class HttpAuthenticator
extends Object

Class that is responsible for running the HTTP based authentication

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	HttpAuthenticator.NoAuthenticationMechanism
(package private) static class	HttpAuthenticator.NoopCloseTask

Constructor Summary

Constructors

Constructor	Description
HttpAuthenticator(io.quarkus.security.identity.IdentityProviderManager identityProviderManager, javax.enterprise.inject.Instance<PathMatchingHttpSecurityPolicy> pathMatchingPolicy, javax.enterprise.inject.Instance<HttpAuthenticationMechanism> httpAuthenticationMechanism, javax.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>	attemptAuthentication(io.vertx.ext.web.RoutingContext routingContext)	Attempts authentication with the contents of the request.
io.smallrye.mutiny.Uni<ChallengeData>	getChallenge(io.vertx.ext.web.RoutingContext routingContext)
(package private) io.quarkus.security.identity.IdentityProviderManager	getIdentityProviderManager()
io.smallrye.mutiny.Uni<Boolean>	sendChallenge(io.vertx.ext.web.RoutingContext routingContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpAuthenticator

public HttpAuthenticator(io.quarkus.security.identity.IdentityProviderManager identityProviderManager,
                         javax.enterprise.inject.Instance<PathMatchingHttpSecurityPolicy> pathMatchingPolicy,
                         javax.enterprise.inject.Instance<HttpAuthenticationMechanism> httpAuthenticationMechanism,
                         javax.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers)

Method Detail

getIdentityProviderManager

io.quarkus.security.identity.IdentityProviderManager getIdentityProviderManager()

attemptAuthentication

public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> attemptAuthentication(io.vertx.ext.web.RoutingContext routingContext)

Attempts authentication with the contents of the request. If this is possible the Uni will resolve to a valid SecurityIdentity when it is subscribed to. Note that Uni is lazy, so this may not happen until the Uni is subscribed to.

If invalid credentials are present then the completion stage will resolve to a AuthenticationFailedException

If no credentials are present it will resolve to null.

sendChallenge

public io.smallrye.mutiny.Uni<Boolean> sendChallenge(io.vertx.ext.web.RoutingContext routingContext)

Returns:

getChallenge

public io.smallrye.mutiny.Uni<ChallengeData> getChallenge(io.vertx.ext.web.RoutingContext routingContext)