io.quarkus.vertx.http.runtime.security

Interface HttpAuthenticationMechanism

All Known Implementing Classes:

BasicAuthenticationMechanism, FormAuthenticationMechanism, HttpAuthenticator.NoAuthenticationMechanism

public interface HttpAuthenticationMechanism

An interface that performs HTTP based authentication

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpAuthenticationMechanism.ChallengeSender

Method Summary

Modifier and Type	Method and Description
CompletionStage<io.quarkus.security.identity.SecurityIdentity>	authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
CompletionStage<ChallengeData>	getChallenge(io.vertx.ext.web.RoutingContext context)
HttpCredentialTransport	getCredentialTransport() The credential transport, used to make sure multiple incompatible mechanisms are not installed May be null if this mechanism cannot interfere with other mechanisms
Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>>	getCredentialTypes() Returns the required credential types.
default CompletionStage<Boolean>	sendChallenge(io.vertx.ext.web.RoutingContext context)

Method Detail

authenticate

CompletionStage<io.quarkus.security.identity.SecurityIdentity> authenticate(io.vertx.ext.web.RoutingContext context,
                                                                            io.quarkus.security.identity.IdentityProviderManager identityProviderManager)

getChallenge

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

getCredentialTypes

Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>> getCredentialTypes()

Returns the required credential types. If there are no identity managers installed that support the listed types then this mechanism will not be enabled.

sendChallenge

default CompletionStage<Boolean> sendChallenge(io.vertx.ext.web.RoutingContext context)

getCredentialTransport

HttpCredentialTransport getCredentialTransport()

The credential transport, used to make sure multiple incompatible mechanisms are not installed May be null if this mechanism cannot interfere with other mechanisms