AbstractManagerFactoryBuilder (Achilles Core 6.1.0 API)

java.lang.Object
- info.archinnov.achilles.bootstrap.AbstractManagerFactoryBuilder<T>

public abstract class AbstractManagerFactoryBuilder<T extends AbstractManagerFactoryBuilder<T>>
extends Object

Field Summary

Fields
Modifier and Type Field and Description

protected Cluster cluster

protected ConfigMap configMap

Fields
Modifier and Type	Field and Description
`protected Cluster`	`cluster`
`protected ConfigMap`	`configMap`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractManagerFactoryBuilder(Cluster cluster)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractManagerFactoryBuilder(Cluster cluster)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract <M extends AbstractManagerFactory> M`	`build()`
`protected static ConfigurationContext`	`buildConfigContext(Cluster cluster, ConfigMap configMap)`
`T`	`doForceSchemaCreation(boolean forceSchemaCreation)` Whether Achilles should force table creation if they do not already exist in the keyspace This flag is useful for dev only.
`protected abstract T`	`getThis()`
`T`	`validateSchema(boolean validateSchema)` Whether Achilles should validate the schema generated by the java classes/annotations with the live schema of the cluster.
`T`	`withBeanValidation(boolean enableBeanValidation)` Activate Bean Validation (JSR303)
`T`	`withBeanValidator(javax.validation.Validator validator)` Provide custom validator for Bean Validation (JSR303)
`T`	`withDefaultExecutorService(ExecutorService executorService)` Pass an ExecutorService (ThreadPool) to Achilles to be used internally for asynchronous operations.
`T`	`withDefaultKeyspaceName(String defaultKeyspaceName)` Define the keyspace name to be used by Achilles.
`T`	`withDefaultReadConsistency(ConsistencyLevel defaultReadConsistency)` Define the default Consistency level to be used for all READ operations
`T`	`withDefaultReadConsistencyMap(Map<String,ConsistencyLevel> readConsistencyMap)` Define the default Consistency level map to be used for all READ operations The map keys represent table names and values represent the corresponding consistency level
`T`	`withDefaultSerialConsistency(ConsistencyLevel defaultSerialConsistency)` Define the default Consistency level to be used for all LightWeightTransaction operations operations
`T`	`withDefaultSerialConsistencyMap(Map<String,ConsistencyLevel> serialConsistencyMap)` Define the default Consistency level map to be used for all LightWeightTransaction operations operations The map keys represent table names and values represent the corresponding consistency level
`T`	`withDefaultWriteConsistency(ConsistencyLevel defaultWriteConsistency)` Define the default Consistency level to be used for all WRITE operations
`T`	`withDefaultWriteConsistencyMap(Map<String,ConsistencyLevel> writeConsistencyMap)` Define the default Consistency level map to be used for all WRITE operations The map keys represent table names and values represent the corresponding consistency level
`T`	`withEventInterceptors(List<info.archinnov.achilles.type.interceptor.Interceptor<?>> interceptors)` Provide a list of event interceptors
`T`	`withExecutorServiceMaxThreadCount(int maxThreadCount)` Define the max thread count for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
`T`	`withExecutorServiceMinThreadCount(int minThreadCount)` Define the min thread count for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
`T`	`withExecutorServiceThreadFactory(ThreadFactory factory)` Define the Thread Factory for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
`T`	`withExecutorServiceThreadKeepAliveDuration(int keepAliveDuration)` Define the thread keep-alive duration in second for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
`T`	`withExecutorServiceThreadQueueSize(int threadQueueSize)` Define the LinkedBlockingQueue size for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
`T`	`withGlobalInsertStrategy(info.archinnov.achilles.type.strategy.InsertStrategy globalInsertStrategy)` Define the global insert strategy
`T`	`withJacksonMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Define a pre-configured Jackson Object Mapper for serialization of non-primitive types
`T`	`withJacksonMapperFactory(JacksonMapperFactory jacksonMapperFactory)` Define a pre-configured map of Jackson Object Mapper for serialization of non-primitive types
`T`	`withManagedEntityClasses(Class<?>... entityClasses)` Define a list of entities to be managed by Achilles.
`T`	`withManagedEntityClasses(List<Class<?>> entityClasses)` Define a list of entities to be managed by Achilles.
`T`	`withMaxDMLResultsDisplayed(int maxDMLResultsDisplayed)` Specify how many returned rows to be displayed if ACHILLES_DML_STATEMENT logger or entity logger is debug-enabled.
`T`	`withMaxPreparedStatementCacheSize(int maxPreparedStatementCacheSize)` Specify maximum size for the internal prepared statements LRU cache.
`T`	`withNativeSession(Session nativeSession)` Define the pre-configured `com.datastax.driver.core.Session` object to be used instead of creating a new one
`T`	`withParameter(ConfigurationParameters parameter, Object value)` Pass an arbitrary parameter to configure Achilles
`T`	`withPostLoadBeanValidation(boolean enablePostLoadBeanValidation)` Activate Bean Validation (JSR303)
`<FROM,TO> T`	`withRuntimeCodec(info.archinnov.achilles.type.codec.CodecSignature<FROM,TO> codecSignature, info.archinnov.achilles.type.codec.Codec<FROM,TO> codec)` Specify a runtime codec to register with Achilles `final Codec<MyBean, String> beanCodec = new ....`
`T`	`withRuntimeCodecs(Map<info.archinnov.achilles.type.codec.CodecSignature<?,?>,info.archinnov.achilles.type.codec.Codec<?,?>> runtimeCodecs)` Specify runtime codecs to register with Achilles `final Codec<MyBean, String> beanCodec = new ....`
`T`	`withSchemaNameProvider(info.archinnov.achilles.type.SchemaNameProvider schemaNameProvider)` Define the schema name provider to be used instead of default keyspace/table names
`T`	`withStatementsCache(StatementsCache statementsCache)` Define the statements cache object to be used for prepared statements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configMap
```
protected ConfigMap configMap
```
  - cluster
```
protected Cluster cluster
```
- Constructor Detail
  - AbstractManagerFactoryBuilder
```
protected AbstractManagerFactoryBuilder(Cluster cluster)
```
- Method Detail
  - buildConfigContext
```
protected static ConfigurationContext buildConfigContext(Cluster cluster,
                                                         ConfigMap configMap)
```
  - getThis
```
protected abstract T getThis()
```
  - build
```
public abstract <M extends AbstractManagerFactory> M build()
```
  - withJacksonMapper
```
public T withJacksonMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Define a pre-configured Jackson Object Mapper for serialization of non-primitive types
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    JSON serialization
  - withJacksonMapperFactory
```
public T withJacksonMapperFactory(JacksonMapperFactory jacksonMapperFactory)
```
    Define a pre-configured map of Jackson Object Mapper for serialization of non-primitive types
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    JSON serialization
  - withDefaultReadConsistency
```
public T withDefaultReadConsistency(ConsistencyLevel defaultReadConsistency)
```
    Define the default Consistency level to be used for all READ operations
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - withDefaultWriteConsistency
```
public T withDefaultWriteConsistency(ConsistencyLevel defaultWriteConsistency)
```
    Define the default Consistency level to be used for all WRITE operations
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - withDefaultSerialConsistency
```
public T withDefaultSerialConsistency(ConsistencyLevel defaultSerialConsistency)
```
    Define the default Consistency level to be used for all LightWeightTransaction operations operations
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - withDefaultReadConsistencyMap
```
public T withDefaultReadConsistencyMap(Map<String,ConsistencyLevel> readConsistencyMap)
```
    Define the default Consistency level map to be used for all READ operations The map keys represent table names and values represent the corresponding consistency level
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - withDefaultWriteConsistencyMap
```
public T withDefaultWriteConsistencyMap(Map<String,ConsistencyLevel> writeConsistencyMap)
```
    Define the default Consistency level map to be used for all WRITE operations The map keys represent table names and values represent the corresponding consistency level
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - withDefaultSerialConsistencyMap
```
public T withDefaultSerialConsistencyMap(Map<String,ConsistencyLevel> serialConsistencyMap)
```
    Define the default Consistency level map to be used for all LightWeightTransaction operations operations The map keys represent table names and values represent the corresponding consistency level
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Consistency configuration
  - doForceSchemaCreation
```
public T doForceSchemaCreation(boolean forceSchemaCreation)
```
    Whether Achilles should force table creation if they do not already exist in the keyspace This flag is useful for dev only. It should be disabled in production
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Table generation
  - validateSchema
```
public T validateSchema(boolean validateSchema)
```
    Whether Achilles should validate the schema generated by the java classes/annotations with the live schema of the cluster. Defaults to true.
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Table generation
  - withNativeSession
```
public T withNativeSession(Session nativeSession)
```
    Define the pre-configured com.datastax.driver.core.Session object to be used instead of creating a new one
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Native Session
  - withDefaultKeyspaceName
```
public T withDefaultKeyspaceName(String defaultKeyspaceName)
```
    Define the keyspace name to be used by Achilles. It is mandatory if you do not define the keyspace name statically on your entity with the annotation @Table
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Keyspace
  - withEventInterceptors
```
public T withEventInterceptors(List<info.archinnov.achilles.type.interceptor.Interceptor<?>> interceptors)
```
    Provide a list of event interceptors
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Event interceptors
  - withBeanValidation
```
public T withBeanValidation(boolean enableBeanValidation)
```
    Activate Bean Validation (JSR303)
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Bean validation
  - withPostLoadBeanValidation
```
public T withPostLoadBeanValidation(boolean enablePostLoadBeanValidation)
```
    Activate Bean Validation (JSR303)
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Bean validation
  - withBeanValidator
```
public T withBeanValidator(javax.validation.Validator validator)
```
    Provide custom validator for Bean Validation (JSR303)
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Bean validation
  - withMaxPreparedStatementCacheSize
```
public T withMaxPreparedStatementCacheSize(int maxPreparedStatementCacheSize)
```
    Specify maximum size for the internal prepared statements LRU cache. If the cache is full, oldest prepared statements will be dropped, leading to unexpected behavior.
    
    Default value is 5000, which is a pretty safe limit.
    
    For information, only selects on counter fields and updates are put into the cache because they cannot be prepared before hand since the updated properties are not known in advance.
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Prepared statements cache
  - withGlobalInsertStrategy
```
public T withGlobalInsertStrategy(info.archinnov.achilles.type.strategy.InsertStrategy globalInsertStrategy)
```
    Define the global insert strategy
    
    Parameters:
    
    globalInsertStrategy -
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Insert Strategy
  - withSchemaNameProvider
```
public T withSchemaNameProvider(info.archinnov.achilles.type.SchemaNameProvider schemaNameProvider)
```
    Define the schema name provider to be used instead of default keyspace/table names
    
    Parameters:
    
    schemaNameProvider -
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Insert Strategy
  - withDefaultExecutorService
```
public T withDefaultExecutorService(ExecutorService executorService)
```
    Pass an ExecutorService (ThreadPool) to Achilles to be used internally for asynchronous operations.
    If omitted, the default ExecutorService is configured as below:
```
 new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
 new LinkedBlockingQueue(1000),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    executorService - an executor service (thread pool) to be used by Achilles for internal for asynchronous operations
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withExecutorServiceMinThreadCount
```
public T withExecutorServiceMinThreadCount(int minThreadCount)
```
    Define the min thread count for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
    The default ExecutorService is configured as below:
```
 // Create proxy
 new ThreadPoolExecutor(minThreadCount, 20, 60, TimeUnit.SECONDS,
 new LinkedBlockingQueue(1000),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    minThreadCount - min thread count for the executor service
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withExecutorServiceMaxThreadCount
```
public T withExecutorServiceMaxThreadCount(int maxThreadCount)
```
    Define the max thread count for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
    The default ExecutorService is configured as below:
```
 // Create proxy
 new ThreadPoolExecutor(5, maxThreadCount, 60, TimeUnit.SECONDS,
 new LinkedBlockingQueue(1000),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    maxThreadCount - max thread count for the executor service
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withExecutorServiceThreadKeepAliveDuration
```
public T withExecutorServiceThreadKeepAliveDuration(int keepAliveDuration)
```
    Define the thread keep-alive duration in second for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
    The default ExecutorService is configured as below:
```
 // Create proxy
 new ThreadPoolExecutor(5, 20, keepAliveDuration, TimeUnit.SECONDS,
 new LinkedBlockingQueue(1000),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    keepAliveDuration - thread keep-alive duration in second for the executor service
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withExecutorServiceThreadQueueSize
```
public T withExecutorServiceThreadQueueSize(int threadQueueSize)
```
    Define the LinkedBlockingQueue size for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
    The default ExecutorService is configured as below:
```
 // Create proxy
 new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
 new LinkedBlockingQueue(threadQueueSize),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    threadQueueSize - the LinkedBlockingQueue size for the executor service
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withExecutorServiceThreadFactory
```
public T withExecutorServiceThreadFactory(ThreadFactory factory)
```
    Define the Thread Factory for the ExecutorService (ThreadPool) to be used internally for asynchronous operations.
    The default ExecutorService is configured as below:
```
 // Create proxy
 new ThreadPoolExecutor(5, 20, 60, TimeUnit.SECONDS,
 new LinkedBlockingQueue(threadQueueSize),
 new DefaultExecutorThreadFactory())
 
```
    Parameters:
    
    factory - the thread factory
    
    Returns:
    
    ManagerFactoryBuilder
    
    See Also:
    
    Asynchronous Operations
  - withManagedEntityClasses
```
public T withManagedEntityClasses(List<Class<?>> entityClasses)
```
    Define a list of entities to be managed by Achilles. Specifically, schema validation will be performed at bootstrap for those entities
    
    Parameters:
    
    entityClasses - entities to be managed by Achilles
    
    Returns:
    
    ManagerFactoryBuilder
  - withManagedEntityClasses
```
public T withManagedEntityClasses(Class<?>... entityClasses)
```
    Define a list of entities to be managed by Achilles. Specifically, schema validation will be performed at bootstrap for those entities
    
    Parameters:
    
    entityClasses - entities to be managed by Achilles
    
    Returns:
    
    ManagerFactoryBuilder
  - withStatementsCache
```
public T withStatementsCache(StatementsCache statementsCache)
```
    Define the statements cache object to be used for prepared statements. This object is an instance of StatementsCache
    
    Parameters:
    
    statementsCache - cache object for the prepared statements
    
    Returns:
    
    ManagerFactoryBuilder
  - withParameter
```
public T withParameter(ConfigurationParameters parameter,
                       Object value)
```
    Pass an arbitrary parameter to configure Achilles
    
    Parameters:
    
    parameter - an instance of the ConfigurationParameters enum
    
    value - the value of the parameter
    
    Returns:
    
    ManagerFactoryBuilder
  - withRuntimeCodec
```
public <FROM,TO> T withRuntimeCodec(info.archinnov.achilles.type.codec.CodecSignature<FROM,TO> codecSignature,
                                    info.archinnov.achilles.type.codec.Codec<FROM,TO> codec)
```
    Specify a runtime codec to register with Achilles
```
  final Codec<MyBean, String> beanCodec = new .... // Create your codec with initialization logic here
  final Codec<MyEnum, String> enumCodec = new .... // Create your codec with initialization logic here

  final CodecSignature<MyBean, String> codecSignature1 = new CodecSignature(MyBean.class, String.class);
  final CodecSignature<MyBean, String> codecSignature2 = new CodecSignature(MyEnum.class, String.class);

  final Map<CodecSignature<?, ?>, Codec<?, ?>> runtimeCodecs = new HashMap<>();
  runtimeCodecs.put(codecSignature1, beanCodec);
  runtimeCodecs.put(codecSignature2, enumCodec);


  ManagerFactory factory = ManagerFactoryBuilder
                               .builder(cluster)
                               ...
                               .withRuntimeCodec(codecSignature1, beanCodec)
                               .withRuntimeCodec(codecSignature2, enumCodec)
                               .build();
 
```
    Remark: you can call this method as many time as there are runtime codecs to be registered
    Parameters:
    
    codecSignature - codec signature, defined by sourceType,targetType and optionally codecName
    
    codec - runtime codec
    
    Returns:
    
    ManagerFactoryBuilder
  - withRuntimeCodecs
```
public T withRuntimeCodecs(Map<info.archinnov.achilles.type.codec.CodecSignature<?,?>,info.archinnov.achilles.type.codec.Codec<?,?>> runtimeCodecs)
```
    Specify runtime codecs to register with Achilles
```
  final Codec<MyBean, String> beanCodec = new .... // Create your codec with initialization logic here
  final Codec<MyEnum, String> enumCodec = new .... // Create your codec with initialization logic here

  final CodecSignature<MyBean, String> codecSignature1 = new CodecSignature(MyBean.class, String.class);
  final CodecSignature<MyBean, String> codecSignature2 = new CodecSignature(MyEnum.class, String.class);

  final Map<CodecSignature<?, ?>, Codec<?, ?>> runtimeCodecs = new HashMap<>();
  runtimeCodecs.put(codecSignature1, beanCodec);
  runtimeCodecs.put(codecSignature2, enumCodec);

  ManagerFactory factory = ManagerFactoryBuilder
                               .builder(cluster)
                               ...
                               .withRuntimeCodecs(runtimeCodecs)
                               .build();
 
```
    Remark: you can call this method as many time as there are runtime codecs to be registered
    Parameters:
    
    runtimeCodecs - a map of codec signature and its corresponding codec
    
    Returns:
    
    ManagerFactoryBuilder
  - withMaxDMLResultsDisplayed
```
public T withMaxDMLResultsDisplayed(int maxDMLResultsDisplayed)
```
    Specify how many 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)
    
    Parameters:
    
    maxDMLResultsDisplayed - max returned rows to be displayed
    
    Returns:
    
    ManagerFactoryBuilder

Class AbstractManagerFactoryBuilder<T extends AbstractManagerFactoryBuilder<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

configMap

cluster

Constructor Detail

AbstractManagerFactoryBuilder

Method Detail

buildConfigContext

getThis

build

withJacksonMapper

withJacksonMapperFactory

withDefaultReadConsistency

withDefaultWriteConsistency

withDefaultSerialConsistency

withDefaultReadConsistencyMap

withDefaultWriteConsistencyMap

withDefaultSerialConsistencyMap

doForceSchemaCreation

validateSchema

withNativeSession

withDefaultKeyspaceName

withEventInterceptors

withBeanValidation

withPostLoadBeanValidation

withBeanValidator

withMaxPreparedStatementCacheSize

withGlobalInsertStrategy

withSchemaNameProvider

withDefaultExecutorService

withExecutorServiceMinThreadCount

withExecutorServiceMaxThreadCount

withExecutorServiceThreadKeepAliveDuration

withExecutorServiceThreadQueueSize

withExecutorServiceThreadFactory

withManagedEntityClasses

withManagedEntityClasses

withStatementsCache

withParameter

withRuntimeCodec

withRuntimeCodecs

withMaxDMLResultsDisplayed