io.quarkus.vertx.http.runtime.security

Class HttpAuthenticator

java.lang.Object

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

@ApplicationScoped
public class HttpAuthenticator
extends Object

Class that is responsible for running the HTTP based authentication

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) io.quarkus.security.identity.IdentityProviderManager	identityProviderManager
(package private) HttpAuthenticationMechanism[]	mechanisms

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticator()
HttpAuthenticator(javax.enterprise.inject.Instance<HttpAuthenticationMechanism> instance, javax.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers)

Method Summary

Modifier and Type	Method and Description
CompletionStage<io.quarkus.security.identity.SecurityIdentity>	attemptAuthentication(io.vertx.ext.web.RoutingContext routingContext) Attempts authentication with the contents of the request.
CompletionStage<ChallengeData>	getChallenge(io.vertx.ext.web.RoutingContext routingContext)
CompletionStage<Void>	sendChallenge(io.vertx.ext.web.RoutingContext routingContext, Runnable closeTask)

Methods inherited from class java.lang.Object

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

Field Detail

identityProviderManager

@Inject
io.quarkus.security.identity.IdentityProviderManager identityProviderManager

mechanisms

final HttpAuthenticationMechanism[] mechanisms

Constructor Detail

HttpAuthenticator

public HttpAuthenticator()

HttpAuthenticator

@Inject
public HttpAuthenticator(javax.enterprise.inject.Instance<HttpAuthenticationMechanism> instance,
                                 javax.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers)

Method Detail

attemptAuthentication

public CompletionStage<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 CompletionStage will resolve to a valid SecurityIdentity. 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 CompletionStage<Void> sendChallenge(io.vertx.ext.web.RoutingContext routingContext,
                                           Runnable closeTask)

Parameters:

closeTask - The task that should be run to finalize the HTTP exchange.

Returns:

getChallenge

public CompletionStage<ChallengeData> getChallenge(io.vertx.ext.web.RoutingContext routingContext)