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

Class HttpSecurityConfiguration

java.lang.Object

io.quarkus.vertx.http.runtime.security.HttpSecurityConfiguration

public final class HttpSecurityConfiguration
extends Object

This singleton carries final HTTP Security configuration and act as a single source of truth for it. This class is not part of the public API and is subject to change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	HttpSecurityConfiguration.AuthenticationMechanism
(package private) static interface	HttpSecurityConfiguration.HttpPermissionCarrier
(package private) static final record	HttpSecurityConfiguration.Policy
static final class	HttpSecurityConfiguration.ProgrammaticTlsConfig

Method Summary

Modifier and Type	Method	Description
(package private) static List<HttpSecurityConfiguration.HttpPermissionCarrier>	adaptToHttpPermissionCarriers(Map<String,PolicyMappingConfig> mappings)
(package private) static void	clear()
(package private) boolean	formAuthEnabled()
(package private) String	formPostLocation()
(package private) static HttpSecurityConfiguration	get()
(package private) static HttpSecurityConfiguration	get(VertxHttpConfig httpConfig, VertxHttpBuildTimeConfig httpBuildTimeConfig)
(package private) BasicAuthenticationMechanism	getBasicAuthenticationMechanism()
(package private) FormAuthenticationMechanism	getFormAuthenticationMechanism()
(package private) HttpAuthenticationMechanism[]	getMechanisms(jakarta.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers, boolean inclusiveAuth)
(package private) MtlsAuthenticationMechanism	getMtlsAuthenticationMechanism()
(package private) List<HttpSecurityConfiguration.HttpPermissionCarrier>	httpPermissions()
static boolean	isNotReady(VertxHttpConfig httpConfig, VertxHttpBuildTimeConfig httpBuildTimeConfig, LaunchMode launchMode)	This method allows to assure from outside of this HTTP Security package that HTTP Security config is ready.
(package private) RolesMapping	rolesMapping()

Methods inherited from class java.lang.Object

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

Method Details

getBasicAuthenticationMechanism

BasicAuthenticationMechanism getBasicAuthenticationMechanism()

getFormAuthenticationMechanism

FormAuthenticationMechanism getFormAuthenticationMechanism()

getMtlsAuthenticationMechanism

MtlsAuthenticationMechanism getMtlsAuthenticationMechanism()

getMechanisms

HttpAuthenticationMechanism[] getMechanisms(jakarta.enterprise.inject.Instance<io.quarkus.security.identity.IdentityProvider<?>> providers,
 boolean inclusiveAuth)

get

static HttpSecurityConfiguration get()

get

static HttpSecurityConfiguration get(VertxHttpConfig httpConfig,
 VertxHttpBuildTimeConfig httpBuildTimeConfig)

clear

static void clear()

adaptToHttpPermissionCarriers

static List<HttpSecurityConfiguration.HttpPermissionCarrier> adaptToHttpPermissionCarriers(Map<String,PolicyMappingConfig> mappings)

rolesMapping

RolesMapping rolesMapping()

httpPermissions

List<HttpSecurityConfiguration.HttpPermissionCarrier> httpPermissions()

formAuthEnabled

boolean formAuthEnabled()

formPostLocation

String formPostLocation()

isNotReady

public static boolean isNotReady(VertxHttpConfig httpConfig,
 VertxHttpBuildTimeConfig httpBuildTimeConfig,
 LaunchMode launchMode)

This method allows to assure from outside of this HTTP Security package that HTTP Security config is ready. It should be only used in very special cases, like to assure that programmatic TLS configuration and TLS client authentication are loaded. It is unnecessary to use this method inside this HTTP Security package.

Returns:

true if programmatic configuration is ready