Module io.helidon.security.abac.policy

Package io.helidon.security.abac.policy.spi

Interface PolicyExecutorService

All Known Implementing Classes:

JavaxElPolicyExecutorService

public interface PolicyExecutorService

Java service for PolicyValidator ABAC validator.

Method Summary

Modifier and Type	Method	Description
String	configKey()	Configuration key that is expected by this policy validator service.
default PolicyExecutor	instantiate(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. use instantiate(io.helidon.config.Config) instead
default PolicyExecutor	instantiate(Config config)	Create a new instance of a PolicyExecutor based on the configuration provider.

Method Details

configKey

String configKey()

Configuration key that is expected by this policy validator service. This is obtained from policy-validator area in configuration. Example:

 security.providers:
  - abac
    policy-validator:
      my-custom-policy-engine:
        some-key: "some value"
        another-key: "another value"
 

Returns:

configuration key (e.g. "my-custom-policy-engine" from example above)

instantiate

@Deprecated(since="4.4.0",
            forRemoval=true)
default PolicyExecutor instantiate(Config config)

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

use instantiate(io.helidon.config.Config) instead

Create a new instance of a PolicyExecutor based on the configuration provider. Another option is to use a builder directly with PolicyValidator.Builder.addExecutor(io.helidon.security.abac.policy.spi.PolicyExecutor)

Parameters:

config - configuration as located on configKey().

Returns:

new executor instance to be used by PolicyValidator to evaluate policy statements

instantiate

default PolicyExecutor instantiate(Config config)

Create a new instance of a PolicyExecutor based on the configuration provider. Another option is to use a builder directly with PolicyValidator.Builder.addExecutor(io.helidon.security.abac.policy.spi.PolicyExecutor)

API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

Parameters:

config - configuration as located on configKey().

Returns:

new executor instance to be used by PolicyValidator to evaluate policy statements

Since:

4.4.0