Package io.quarkus.security.runtime

Class SecurityCheckRecorder

java.lang.Object
io.quarkus.security.runtime.SecurityCheckRecorder
public class SecurityCheckRecorder extends Object

  • Constructor Details

    • SecurityCheckRecorder

      public SecurityCheckRecorder()

  • Method Details

    • denyAll

      public io.quarkus.security.spi.runtime.SecurityCheck denyAll()

    • permitAll

      public io.quarkus.security.spi.runtime.SecurityCheck permitAll()

    • rolesAllowed

      public io.quarkus.security.spi.runtime.SecurityCheck rolesAllowed(String... roles)

    • rolesAllowedSupplier

      public io.quarkus.security.spi.runtime.SecurityCheck rolesAllowedSupplier(String[] allowedRoles, int[] configExpIndexes, int[] configKeys)

    • recordRolesAllowedConfigExpression

      public void recordRolesAllowedConfigExpression(String configExpression, int configKeyIndex, BiConsumer<String,Supplier<String[]>> configValueRecorder)

    • authenticated

      public io.quarkus.security.spi.runtime.SecurityCheck authenticated()

    • permissionsAllowed

      public io.quarkus.security.spi.runtime.SecurityCheck permissionsAllowed(Function<Object[],Permission> computedPermission, io.quarkus.runtime.RuntimeValue<Permission> permissionRuntimeValue)
      Creates SecurityCheck for a single permission.
      Returns:
      SecurityCheck

    • permissionsAllowed

      public io.quarkus.security.spi.runtime.SecurityCheck permissionsAllowed(List<Function<Object[],Permission>> computedPermissions, List<io.quarkus.runtime.RuntimeValue<Permission>> permissionsRuntimeValue)
      Creates SecurityCheck for a permission set. User must have at least one of security check permissions.
      Returns:
      SecurityCheck

    • permissionsAllowedGroups

      public io.quarkus.security.spi.runtime.SecurityCheck permissionsAllowedGroups(List<List<Function<Object[],Permission>>> computedPermissionGroups, List<List<io.quarkus.runtime.RuntimeValue<Permission>>> permissionGroupsRuntimeValue)
      Creates SecurityCheck for a permission groups. User must have at least one of security check permissions from each permission group.
      Returns:
      SecurityCheck

    • toComputedPermission

      public Function<Object[],Permission> toComputedPermission(io.quarkus.runtime.RuntimeValue<Permission> permissionRuntimeVal)

    • createStringPermission

      public io.quarkus.runtime.RuntimeValue<Permission> createStringPermission(String name, String[] actions)

    • createPermission

      public io.quarkus.runtime.RuntimeValue<Permission> createPermission(String name, String clazz, String[] actions, boolean passActionsToConstructor)
      Creates permission.
      Parameters:
      name - permission name
      clazz - permission class
      actions - nullable actions
      passActionsToConstructor - flag signals whether Permission constructor accepts (name) or (name, actions)
      Returns:
      io.quarkus.runtime.RuntimeValue<Permission>

    • createComputedPermission

      public Function<Object[],Permission> createComputedPermission(String permissionName, String clazz, String[] actions, boolean passActionsToConstructor, int[] formalParamIndexes, String[] formalParamConverters, Map<String,io.quarkus.runtime.RuntimeValue<MethodHandle>> converterNameToMethodHandle)
      Creates function that transform arguments of a method annotated with PermissionsAllowed to custom Permission.
      Parameters:
      permissionName - permission name
      clazz - permission class
      actions - permission actions
      passActionsToConstructor - flag signals whether Permission constructor accepts (name) or (name, actions)
      formalParamIndexes - indexes of secured method params that should be passed to permission constructor
      formalParamConverters - converts method parameter to constructor parameter; most of the time, this will be either identity function or a method calling method parameter getter
      Returns:
      computed permission

    • newBuilder

      public io.quarkus.runtime.RuntimeValue<SecurityCheckStorageBuilder> newBuilder()

    • addMethod

      public void addMethod(io.quarkus.runtime.RuntimeValue<SecurityCheckStorageBuilder> builder, String className, String methodName, String[] parameterTypes, io.quarkus.security.spi.runtime.SecurityCheck securityCheck)

    • create

      public io.quarkus.security.spi.runtime.SecurityCheckStorage create(io.quarkus.runtime.RuntimeValue<SecurityCheckStorageBuilder> builder)

    • resolveRolesAllowedConfigExpRoles

      public void resolveRolesAllowedConfigExpRoles()

    • registerDefaultSecurityCheck

      public void registerDefaultSecurityCheck(io.quarkus.runtime.RuntimeValue<SecurityCheckStorageBuilder> builder, io.quarkus.security.spi.runtime.SecurityCheck securityCheck)

    • createSecurityConstrainer

      public Supplier<SecurityConstrainer> createSecurityConstrainer(Supplier<Map<String,Object>> additionalEventPropsSupplier)

    • setRuntimeConfigReady

      public void setRuntimeConfigReady()

    • unsetRuntimeConfigReady

      public void unsetRuntimeConfigReady(io.quarkus.runtime.ShutdownContext shutdownContext)

    • createPermissionMethodConverter

      public io.quarkus.runtime.RuntimeValue<MethodHandle> createPermissionMethodConverter(String methodName, io.quarkus.runtime.RuntimeValue<Class<?>> clazz)

    • loadClassRuntimeVal

      public io.quarkus.runtime.RuntimeValue<Class<?>> loadClassRuntimeVal(String className)

    • createPermissionAugmentor

      public Function<io.quarkus.arc.SyntheticCreationalContext<QuarkusPermissionSecurityIdentityAugmentor>,QuarkusPermissionSecurityIdentityAugmentor> createPermissionAugmentor()