org.apache.cassandra.db.guardrails

Interface GuardrailsConfigProvider

All Known Implementing Classes:

GuardrailsConfigProvider.Default

public interface GuardrailsConfigProvider

Provider of GuardrailsConfigs for a ClientState.

The GuardrailsConfigProvider.Default implementation always retuns the GuardrailsConfig parsed from cassandra.yaml, but different implementations can return different configurations based on the specified ClientState.

Custom implementations can be specified at runtime with the system property CUSTOM_IMPLEMENTATION_PROPERTY. These configurations can be used to read the guardrails configuration from some other source, and provide different configurations depending on the ClientState or some other factors. However, this mechanism for pluggability and the related GuardrailsConfig interface are not officially supported and may change in a minor release.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GuardrailsConfigProvider.Default Default implementation of GuardrailsConfigProvider that always returns the GuardrailsConfig parsed from cassandra.yaml, independently of the ClientState.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_IMPLEMENTATION_PROPERTY
static GuardrailsConfigProvider	instance

Method Summary

Modifier and Type	Method and Description
static GuardrailsConfigProvider	build(java.lang.String customImpl) Creates an instance of the custom guardrails config provider of the given class.
GuardrailsConfig	getOrCreate(ClientState state) Returns the GuardrailsConfig to be used for the specified ClientState.

Field Detail

CUSTOM_IMPLEMENTATION_PROPERTY

static final java.lang.String CUSTOM_IMPLEMENTATION_PROPERTY

See Also:

Constant Field Values

instance

static final GuardrailsConfigProvider instance

Method Detail

getOrCreate

GuardrailsConfig getOrCreate(@Nullable
                             ClientState state)

Returns the GuardrailsConfig to be used for the specified ClientState.

Parameters:

state - a client state, maybe null if the guardrails check for which we are getting the config is for a background process that is not associated to a user query.

Returns:

the configuration to be used for state

build

static GuardrailsConfigProvider build(java.lang.String customImpl)

Creates an instance of the custom guardrails config provider of the given class.

Parameters:

customImpl - the fully qualified classname of the guardrails config provider to be instantiated

Returns:

a new instance of the specified custom guardrails config provider of the given class.