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

Interface HttpAuthenticationMechanism

All Known Implementing Classes:

BasicAuthenticationMechanism, FormAuthenticationMechanism, HttpAuthenticator.NoAuthenticationMechanism, MtlsAuthenticationMechanism

public interface HttpAuthenticationMechanism

An interface that performs HTTP based authentication

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpAuthenticationMechanism.ChallengeSender

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>	authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
io.smallrye.mutiny.Uni<ChallengeData>	getChallenge(io.vertx.ext.web.RoutingContext context)
default HttpCredentialTransport	getCredentialTransport()	Deprecated.
default io.smallrye.mutiny.Uni<HttpCredentialTransport>	getCredentialTransport(io.vertx.ext.web.RoutingContext context)	The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed.
Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>>	getCredentialTypes()	Returns the required credential types.
default int	getPriority()	Returns a priority which determines in which order HttpAuthenticationMechanisms handle the authentication and challenge requests when it is not possible to select the best candidate authentication mechanism based on the request credentials or path specific configuration.
default io.smallrye.mutiny.Uni<Boolean>	sendChallenge(io.vertx.ext.web.RoutingContext context)

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

authenticate

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

getChallenge

io.smallrye.mutiny.Uni<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 io.smallrye.mutiny.Uni<Boolean> sendChallenge(io.vertx.ext.web.RoutingContext context)

getCredentialTransport

@Deprecated
default HttpCredentialTransport getCredentialTransport()

Deprecated.

The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed. and finding the best candidate for issuing a challenge when more than one mechanism is installed. May be null if this mechanism cannot interfere with other mechanisms

getCredentialTransport

default io.smallrye.mutiny.Uni<HttpCredentialTransport> getCredentialTransport(io.vertx.ext.web.RoutingContext context)

The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed. May be null if this mechanism cannot interfere with other mechanisms

getPriority

default int getPriority()

Returns a priority which determines in which order HttpAuthenticationMechanisms handle the authentication and challenge requests when it is not possible to select the best candidate authentication mechanism based on the request credentials or path specific configuration. Multiple mechanisms are sorted in descending order, so the highest priority gets the first chance to send a challenge. The default priority is equal to 1000.

Returns:

priority