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

Class AbstractPathMatchingHttpSecurityPolicy

java.lang.Object

io.quarkus.vertx.http.runtime.security.AbstractPathMatchingHttpSecurityPolicy

Direct Known Subclasses:

ManagementPathMatchingHttpSecurityPolicy, PathMatchingHttpSecurityPolicy

public class AbstractPathMatchingHttpSecurityPolicy
extends Object

A security policy that allows for matching of other security policies based on paths.

This is used for the default path/method based RBAC.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	AbstractPathMatchingHttpSecurityPolicy.HttpMatcher

Constructor Summary

Constructors

Constructor	Description
AbstractPathMatchingHttpSecurityPolicy(List<HttpSecurityConfiguration.HttpPermissionCarrier> httpPermissions, Map<String,PolicyConfig> rolePolicy, String rootPath, jakarta.enterprise.inject.Instance<HttpSecurityPolicy> installedPolicies, PolicyMappingConfig.AppliesTo appliesTo)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<HttpSecurityPolicy.CheckResult>	checkPermission(io.vertx.ext.web.RoutingContext routingContext, io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identity, HttpSecurityPolicy.AuthorizationRequestContext requestContext)
(package private) io.smallrye.mutiny.Uni<HttpSecurityPolicy.CheckResult>	checkPermissions(io.vertx.ext.web.RoutingContext routingContext, io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identity, HttpSecurityPolicy.AuthorizationRequestContext requestContext, HttpSecurityPolicy... additionalPolicies)
(package private) static ConfigurationException	duplicateNamedPoliciesNotAllowedEx(HttpSecurityPolicy policy1, HttpSecurityPolicy policy2)
(package private) HttpSecurityConfiguration.AuthenticationMechanism	getAuthMechanism(io.vertx.ext.web.RoutingContext routingContext)
String	getAuthMechanismName(io.vertx.ext.web.RoutingContext routingContext)	Deprecated, for removal: This API element is subject to removal in a future version. This method is internal by nature, if you have a good use case, please report it so that we can document the use case and test it.
boolean	hasNoPermissions()
(package private) static boolean	policyApplied(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 Details

AbstractPathMatchingHttpSecurityPolicy

AbstractPathMatchingHttpSecurityPolicy(List<HttpSecurityConfiguration.HttpPermissionCarrier> httpPermissions,
 Map<String,PolicyConfig> rolePolicy,
 String rootPath,
 jakarta.enterprise.inject.Instance<HttpSecurityPolicy> installedPolicies,
 PolicyMappingConfig.AppliesTo appliesTo)

Method Details

getAuthMechanism

HttpSecurityConfiguration.AuthenticationMechanism getAuthMechanism(io.vertx.ext.web.RoutingContext routingContext)

getAuthMechanismName

@Deprecated(forRemoval=true,
            since="3.25")
public String getAuthMechanismName(io.vertx.ext.web.RoutingContext routingContext)

Deprecated, for removal: This API element is subject to removal in a future version.

This method is internal by nature, if you have a good use case, please report it so that we can document the use case and test it.

hasNoPermissions

public boolean hasNoPermissions()

checkPermission

public io.smallrye.mutiny.Uni<HttpSecurityPolicy.CheckResult> checkPermission(io.vertx.ext.web.RoutingContext routingContext,
 io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identity,
 HttpSecurityPolicy.AuthorizationRequestContext requestContext)

checkPermissions

io.smallrye.mutiny.Uni<HttpSecurityPolicy.CheckResult> checkPermissions(io.vertx.ext.web.RoutingContext routingContext,
 io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> identity,
 HttpSecurityPolicy.AuthorizationRequestContext requestContext,
 HttpSecurityPolicy... additionalPolicies)

policyApplied

static boolean policyApplied(io.vertx.ext.web.RoutingContext routingContext)

duplicateNamedPoliciesNotAllowedEx

static ConfigurationException duplicateNamedPoliciesNotAllowedEx(HttpSecurityPolicy policy1,
 HttpSecurityPolicy policy2)