Package io.quarkus.security.spi.runtime

Interface SecurityCheck

public interface SecurityCheck

Method Summary

Modifier and Type	Method	Description
void	apply(io.quarkus.security.identity.SecurityIdentity identity, MethodDescription methodDescription, Object[] parameters)
void	apply(io.quarkus.security.identity.SecurityIdentity identity, Method method, Object[] parameters)
default boolean	isPermitAll()
default io.smallrye.mutiny.Uni<?>	nonBlockingApply(io.quarkus.security.identity.SecurityIdentity identity, MethodDescription methodDescription, Object[] parameters)
default io.smallrye.mutiny.Uni<?>	nonBlockingApply(io.quarkus.security.identity.SecurityIdentity identity, Method method, Object[] parameters)
default boolean	requiresMethodArguments()	Security checks may be performed before the secured method is actually invoked.

Method Detail

apply

void apply(io.quarkus.security.identity.SecurityIdentity identity,
           Method method,
           Object[] parameters)

nonBlockingApply

default io.smallrye.mutiny.Uni<?> nonBlockingApply(io.quarkus.security.identity.SecurityIdentity identity,
                                                   Method method,
                                                   Object[] parameters)

apply

void apply(io.quarkus.security.identity.SecurityIdentity identity,
           MethodDescription methodDescription,
           Object[] parameters)

nonBlockingApply

default io.smallrye.mutiny.Uni<?> nonBlockingApply(io.quarkus.security.identity.SecurityIdentity identity,
                                                   MethodDescription methodDescription,
                                                   Object[] parameters)

isPermitAll

default boolean isPermitAll()

requiresMethodArguments

default boolean requiresMethodArguments()

Security checks may be performed before the secured method is actually invoked. This happens to make sure they are run before serialization and fully asynchronous checks work as expected. However, if the security checks requires arguments of invoked method, it is possible to postpone this check to the moment when arguments are available. IMPORTANT: in order to avoid security risks, all requests with postponed security checks must be authenticated

Returns:

true if the security check needs method parameters to work correctly