io.quarkus.vertx.http.runtime.security

Interface HttpSecurityPolicy

All Known Implementing Classes:

AuthenticatedHttpSecurityPolicy, DenySecurityPolicy, PathMatchingHttpSecurityPolicy, PermitSecurityPolicy, RolesAllowedHttpSecurityPolicy

public interface HttpSecurityPolicy

A HTTP Security policy, that controls which requests are allowed to proceeed. There are two different ways these policies can be installed. The easiest is to just create a CDI bean, in which case the policy will be invoked on every request. Alternatively HttpSecurityPolicyBuildItem can be used to create a named policy. This policy can then be referenced in the application.properties path matching rules, which allows this policy to be applied to specific requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpSecurityPolicy.AuthorizationRequestContext A context object that can be used to run blocking tasks
static class	HttpSecurityPolicy.CheckResult The results of a permission check

Method Summary

Modifier and Type	Method and Description
CompletionStage<HttpSecurityPolicy.CheckResult>	checkPermission(io.vertx.ext.web.RoutingContext request, io.quarkus.security.identity.SecurityIdentity identity, HttpSecurityPolicy.AuthorizationRequestContext requestContext)

Method Detail

checkPermission

CompletionStage<HttpSecurityPolicy.CheckResult> checkPermission(io.vertx.ext.web.RoutingContext request,
                                                                io.quarkus.security.identity.SecurityIdentity identity,
                                                                HttpSecurityPolicy.AuthorizationRequestContext requestContext)