info.archinnov.achilles.configuration

Enum ConfigurationParameters

java.lang.Object

java.lang.Enum<ConfigurationParameters>

info.archinnov.achilles.configuration.ConfigurationParameters

All Implemented Interfaces:

Serializable, Comparable<ConfigurationParameters>

public enum ConfigurationParameters
extends Enum<ConfigurationParameters>

Enum listing all configuration parameters

Entity Management

• MANAGED_ENTITIES (OPTIONAL): list of entities to be managed by Achilles.
  Example: my.project.entity,another.project.entity

DDL

• FORCE_SCHEMA_GENERATION (OPTIONAL): create missing column families for entities if they are not found. Default = 'false' If set to false and no column family is found for any entity, Achilles will raise an AchillesInvalidColumnFamilyException

• VALIDATE_SCHEMA (OPTIONAL): enable or disable schema validation at start-up. Default = 'true'

DML

• DML_RESULTS_DISPLAY_SIZE (OPTIONAL): set the max number of returned rows to be displayed if ACHILLES_DML_STATEMENT logger or entity logger is debug-enabled .There is a hard-coded limit of 100 rows so if you provide a greater value it will be capped to 100 and floor to 0 (e.g. disable returned results display)

JSON Serialization

• JACKSON_MAPPER_FACTORY (OPTIONAL): an implementation of the info.archinnov.achilles.json.JacksonMapperFactory interface to build custom Jackson ObjectMapper based on entity class
• JACKSON_MAPPER (OPTIONAL): default Jackson ObjectMapper to use for serializing entities

If both JACKSON_MAPPER_FACTORY and JACKSON_MAPPER parameters are provided, Achilles will ignore the JACKSON_MAPPER parameter and use JACKSON_MAPPER_FACTORY

If none is provided, Achilles will use a default Jackson ObjectMapper with the following configuration:

1. MapperFeature.SORT_PROPERTIES_ALPHABETICALLY = true
2. SerializationInclusion = JsonInclude.Include.NON_NULL
3. DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES = false
4. AnnotationIntrospector pair : primary = JacksonAnnotationIntrospector, secondary = JaxbAnnotationIntrospector

Consistency Level

• CONSISTENCY_LEVEL_READ_DEFAULT (OPTIONAL): default read consistency level for all entities
• CONSISTENCY_LEVEL_WRITE_DEFAULT (OPTIONAL): default write consistency level for all entities
• CONSISTENCY_LEVEL_SERIAL_DEFAULT (OPTIONAL): default serial consistency level for all entities
• CONSISTENCY_LEVEL_READ_MAP (OPTIONAL): map(String,String) of read consistency levels for column families/tables
  
  Example: "columnFamily1" -> "ONE"
  "columnFamily2" -> "QUORUM" ...

• CONSISTENCY_LEVEL_WRITE_MAP (OPTIONAL): map(String,String) of write consistency levels for column families Example: "columnFamily1" -> "ALL"
  "columnFamily2" -> "EACH_QUORUM" ...

• CONSISTENCY_LEVEL_SERIAL_MAP (OPTIONAL): map(String,String) of write consistency levels for column families Example: "columnFamily1" -> "SERIAL"
  "columnFamily2" -> "LOCAL_SERIAL" ...

Events Interceptors

• EVENT_INTERCEPTORS (OPTIONAL): list of events interceptors.

Bean Validation

• BEAN_VALIDATION_ENABLE (OPTIONAL): whether to enable Bean Validation for PRE_INSERT/PRE_UPDATE events.
• POST_LOAD_BEAN_VALIDATION_ENABLE (OPTIONAL): whether to enable Bean Validation for POST_LOAD event. Please note that this flag is taken into account only if BEAN_VALIDATION_ENABLE is true
• BEAN_VALIDATION_VALIDATOR (OPTIONAL): custom validator to be used. If no validator is provided, Achilles will get the default validator provided by the default Validation provider. If Bean Validation is enabled at runtime but no default Validation provider can be found, an exception will be raised and the bootstrap is aborted

Prepared Statements Cache

• PREPARED_STATEMENTS_CACHE_SIZE (OPTIONAL): define the LRU cache size for prepared statements cache. By default, common operations like insert, find and delete are prepared before-hand for each entity class. For update and all operations with timestamp, since the updated fields and timestamp value are only known at runtime, Achilless will prepare the statements only on the fly and save them into a Guava LRU cache.
  The default size is 10000 entries. Once the limit is reached, oldest prepared statements are evicted, causing Achilles to re-prepare them and get warnings from the Java Driver.
  You can get details on the LRU cache state by putting the logger info.archinnov.achilles.internal.statement.cache.CacheManager on DEBUG

• STATEMENTS_CACHE (OPTIONAL): provide an instance of the class StatementsCache to store all prepared statements. This option is useful for unit testing to avoid re-preparing many times the same prepared statements
  
  Remark: if your provide the statement cache object yourself, the parameter PREPARED_STATEMENTS_CACHE_SIZE will be ignored

Strategies

• GLOBAL_INSERT_STRATEGY (OPTIONAL): choose between InsertStrategy.ALL_FIELDS and InsertStrategy.NOT_NULL_FIELDS. Default value is ConfigurationParameters.InsertStrategy.ALL_FIELDS.
  For more details, please check Insert Strategy

• GLOBAL_NAMING_STRATEGY (OPTIONAL): choose between NamingStrategy.LOWER_CASE, NamingStrategy.SNAKE_CASE and NamingStrategy.CASE_SENSITIVE. Default value is NamingStrategy.LOWER_CASE.
  For more details, please check Naming Strategy

Bean Factory

• DEFAULT_BEAN_FACTORY (OPTIONAL): inject the default bean factory to instantiate new entities and UDT classes. The implementation class should implement the interface BeanFactory The default implementation is straightforward

  
   @Override
   public  T newInstance(Class clazz) {
   try{
   return clazz.newInstance();
   } catch (InstantiationException | IllegalAccessException e) {
   ....
   }
   }
   

Schema Name Provider

• SCHEMA_NAME_PROVIDER (OPTIONAL): define a schema name provider to bind dynamically an entity to a keyspace/table name at runtime. This feature is useful mostly in a multi-tenant context

Asynchronous Operations

• EXECUTOR_SERVICE (OPTIONAL): define the executor service (thread pool) to be used by Achilles for its internal asynchronous operations. By default, the thread pool is configured as follow:

  
   new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
   new LinkedBlockingQueue(1000),
   new DefaultExecutorThreadFactory())
   

• DEFAULT_EXECUTOR_SERVICE_MIN_THREAD (OPTIONAL): define the minimum thread count for the executor service used by Achilles for its internal asynchronous operations. The thread pool will configured as follow:

  
   new ThreadPoolExecutor(DEFAULT_EXECUTOR_SERVICE_MIN_THREAD, 20, 60, TimeUnit.SECONDS,
   new LinkedBlockingQueue(1000),
   new DefaultExecutorThreadFactory())
   

• DEFAULT_EXECUTOR_SERVICE_MAX_THREAD (OPTIONAL): define the maximum thread count for the executor service used by Achilles for its internal asynchronous operations. The thread pool will configured as follow:

  
   new ThreadPoolExecutor(5, DEFAULT_EXECUTOR_SERVICE_MAX_THREAD, 60, TimeUnit.SECONDS,
   new LinkedBlockingQueue(1000),
   new DefaultExecutorThreadFactory())
   

• DEFAULT_EXECUTOR_SERVICE_THREAD_KEEPALIVE (OPTIONAL): define the duration in seconds during which a thread is kept alive before being destroyed, on the executor service used by Achilles for its internal asynchronous operations. The thread pool will configured as follow:

  
   new ThreadPoolExecutor(5, 20, DEFAULT_EXECUTOR_SERVICE_THREAD_KEEPALIVE, TimeUnit.SECONDS,
   new LinkedBlockingQueue(1000),
   new DefaultExecutorThreadFactory())
   

• DEFAULT_EXECUTOR_SERVICE_QUEUE_SIZE (OPTIONAL): define the size of the LinkedBlockingQueue used by the executor service used by Achilles for its internal asynchronous operations. The thread pool will configured as follow:

  
   new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
   new LinkedBlockingQueue(DEFAULT_EXECUTOR_SERVICE_QUEUE_SIZE),
   new DefaultExecutorThreadFactory())
   

• DEFAULT_EXECUTOR_SERVICE_THREAD_FACTORY (OPTIONAL): define the thread factory used by Achilles for its internal asynchronous operations. The thread pool will configured as follow:

  
   new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
   new LinkedBlockingQueue(1000),
   DEFAULT_EXECUTOR_SERVICE_THREAD_FACTORY)
   

  For more details, please check Asynchronous Operations

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEAN_VALIDATION_ENABLE
BEAN_VALIDATION_VALIDATOR
CONSISTENCY_LEVEL_READ_DEFAULT
CONSISTENCY_LEVEL_READ_MAP
CONSISTENCY_LEVEL_SERIAL_DEFAULT
CONSISTENCY_LEVEL_SERIAL_MAP
CONSISTENCY_LEVEL_WRITE_DEFAULT
CONSISTENCY_LEVEL_WRITE_MAP
DEFAULT_BEAN_FACTORY
DEFAULT_EXECUTOR_SERVICE_MAX_THREAD
DEFAULT_EXECUTOR_SERVICE_MIN_THREAD
DEFAULT_EXECUTOR_SERVICE_QUEUE_SIZE
DEFAULT_EXECUTOR_SERVICE_THREAD_FACTORY
DEFAULT_EXECUTOR_SERVICE_THREAD_KEEPALIVE
DML_RESULTS_DISPLAY_SIZE
EVENT_INTERCEPTORS
EXECUTOR_SERVICE
FORCE_SCHEMA_GENERATION
GLOBAL_INSERT_STRATEGY
GLOBAL_NAMING_STRATEGY
JACKSON_MAPPER
JACKSON_MAPPER_FACTORY
KEYSPACE_NAME
MANAGED_ENTITIES
NATIVE_SESSION
POST_LOAD_BEAN_VALIDATION_ENABLE
PREPARED_STATEMENTS_CACHE_SIZE
RUNTIME_CODECS
SCHEMA_NAME_PROVIDER
STATEMENTS_CACHE
VALIDATE_SCHEMA

Method Summary

Modifier and Type	Method and Description
static ConfigurationParameters	fromLabel(String label) Small utility method that resolves a configuration based on its label.
static ConfigurationParameters	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConfigurationParameters[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NATIVE_SESSION

public static final ConfigurationParameters NATIVE_SESSION

KEYSPACE_NAME

public static final ConfigurationParameters KEYSPACE_NAME

JACKSON_MAPPER_FACTORY

public static final ConfigurationParameters JACKSON_MAPPER_FACTORY

JACKSON_MAPPER

public static final ConfigurationParameters JACKSON_MAPPER

CONSISTENCY_LEVEL_READ_DEFAULT

public static final ConfigurationParameters CONSISTENCY_LEVEL_READ_DEFAULT

CONSISTENCY_LEVEL_WRITE_DEFAULT

public static final ConfigurationParameters CONSISTENCY_LEVEL_WRITE_DEFAULT

CONSISTENCY_LEVEL_SERIAL_DEFAULT

public static final ConfigurationParameters CONSISTENCY_LEVEL_SERIAL_DEFAULT

CONSISTENCY_LEVEL_READ_MAP

public static final ConfigurationParameters CONSISTENCY_LEVEL_READ_MAP

CONSISTENCY_LEVEL_WRITE_MAP

public static final ConfigurationParameters CONSISTENCY_LEVEL_WRITE_MAP

CONSISTENCY_LEVEL_SERIAL_MAP

public static final ConfigurationParameters CONSISTENCY_LEVEL_SERIAL_MAP

EVENT_INTERCEPTORS

public static final ConfigurationParameters EVENT_INTERCEPTORS

FORCE_SCHEMA_GENERATION

public static final ConfigurationParameters FORCE_SCHEMA_GENERATION

VALIDATE_SCHEMA

public static final ConfigurationParameters VALIDATE_SCHEMA

MANAGED_ENTITIES

public static final ConfigurationParameters MANAGED_ENTITIES

BEAN_VALIDATION_ENABLE

public static final ConfigurationParameters BEAN_VALIDATION_ENABLE

POST_LOAD_BEAN_VALIDATION_ENABLE

public static final ConfigurationParameters POST_LOAD_BEAN_VALIDATION_ENABLE

BEAN_VALIDATION_VALIDATOR

public static final ConfigurationParameters BEAN_VALIDATION_VALIDATOR

PREPARED_STATEMENTS_CACHE_SIZE

public static final ConfigurationParameters PREPARED_STATEMENTS_CACHE_SIZE

DEFAULT_BEAN_FACTORY

public static final ConfigurationParameters DEFAULT_BEAN_FACTORY

GLOBAL_INSERT_STRATEGY

public static final ConfigurationParameters GLOBAL_INSERT_STRATEGY

GLOBAL_NAMING_STRATEGY

public static final ConfigurationParameters GLOBAL_NAMING_STRATEGY

SCHEMA_NAME_PROVIDER

public static final ConfigurationParameters SCHEMA_NAME_PROVIDER

EXECUTOR_SERVICE

public static final ConfigurationParameters EXECUTOR_SERVICE

STATEMENTS_CACHE

public static final ConfigurationParameters STATEMENTS_CACHE

RUNTIME_CODECS

public static final ConfigurationParameters RUNTIME_CODECS

DEFAULT_EXECUTOR_SERVICE_MIN_THREAD

public static final ConfigurationParameters DEFAULT_EXECUTOR_SERVICE_MIN_THREAD

DEFAULT_EXECUTOR_SERVICE_MAX_THREAD

public static final ConfigurationParameters DEFAULT_EXECUTOR_SERVICE_MAX_THREAD

DEFAULT_EXECUTOR_SERVICE_THREAD_KEEPALIVE

public static final ConfigurationParameters DEFAULT_EXECUTOR_SERVICE_THREAD_KEEPALIVE

DEFAULT_EXECUTOR_SERVICE_QUEUE_SIZE

public static final ConfigurationParameters DEFAULT_EXECUTOR_SERVICE_QUEUE_SIZE

DEFAULT_EXECUTOR_SERVICE_THREAD_FACTORY

public static final ConfigurationParameters DEFAULT_EXECUTOR_SERVICE_THREAD_FACTORY

DML_RESULTS_DISPLAY_SIZE

public static final ConfigurationParameters DML_RESULTS_DISPLAY_SIZE

Method Detail

values

public static ConfigurationParameters[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConfigurationParameters c : ConfigurationParameters.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfigurationParameters valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromLabel

public static ConfigurationParameters fromLabel(String label)

Small utility method that resolves a configuration based on its label.

Parameters:

label - the configuration label that would be populated in the map.

Returns:

the label in ConfigurationParameters format, or null if no match found.