Class AbstractStoreConfigurationChildBuilder<S>
- java.lang.Object
-
- org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
-
- org.infinispan.configuration.cache.AbstractStoreConfigurationChildBuilder<S>
-
- All Implemented Interfaces:
ConfigurationChildBuilder
,PersistenceConfigurationChildBuilder
,StoreConfigurationChildBuilder<S>
- Direct Known Subclasses:
AbstractJdbcStoreConfigurationChildBuilder
,AbstractRemoteStoreConfigurationChildBuilder
,AbstractRestStoreConfigurationChildBuilder
,AsyncStoreConfigurationBuilder
public abstract class AbstractStoreConfigurationChildBuilder<S> extends AbstractPersistenceConfigurationChildBuilder implements StoreConfigurationChildBuilder<S>
- Since:
- 6.0
- Author:
- Mircea Markus
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractStoreConfigurationChildBuilder(StoreConfigurationBuilder<? extends AbstractStoreConfiguration,? extends StoreConfigurationBuilder<?,?>> builder)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description S
addProperty(String key, String value)
Defines a single property.AsyncStoreConfigurationBuilder<S>
async()
Configuration for the async cache store.Configuration
build()
ClusteringConfigurationBuilder
clustering()
CustomInterceptorsConfigurationBuilder
customInterceptors()
Deprecated.Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptorsEncodingConfigurationBuilder
encoding()
ExpirationConfigurationBuilder
expiration()
S
fetchPersistentState(boolean b)
If true, fetch persistent state when joining a cluster.protected ConfigurationBuilder
getBuilder()
S
ignoreModifications(boolean b)
If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store.IndexingConfigurationBuilder
indexing()
InvocationBatchingConfigurationBuilder
invocationBatching()
LockingConfigurationBuilder
locking()
S
maxBatchSize(int maxBatchSize)
The maximum size of a batch to be inserted/deleted from the store.MemoryConfigurationBuilder
memory()
PersistenceConfigurationBuilder
persistence()
S
preload(boolean b)
If true, when the cache starts, data stored in the cache store will be pre-loaded into memory.S
purgeOnStartup(boolean b)
If true, purges this cache store when it starts up.SecurityConfigurationBuilder
security()
S
segmented(boolean b)
If true this store should either be non shared (segmenting can be done automatically for non shared stores) or the shared store must implement theSegmentedAdvancedLoadWriteStore
interface.S
shared(boolean b)
This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times.boolean
simpleCache()
ConfigurationChildBuilder
simpleCache(boolean simpleCache)
SitesConfigurationBuilder
sites()
StatisticsConfigurationBuilder
statistics()
ConfigurationChildBuilder
template(boolean template)
TransactionConfigurationBuilder
transaction()
S
transactional(boolean b)
This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized.UnsafeConfigurationBuilder
unsafe()
S
withProperties(Properties p)
Properties passed to the cache store or loaderS
writeOnly(boolean b)
If true, this cache store will be only used to write entries.-
Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe, validate
-
Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence
-
-
-
-
Constructor Detail
-
AbstractStoreConfigurationChildBuilder
protected AbstractStoreConfigurationChildBuilder(StoreConfigurationBuilder<? extends AbstractStoreConfiguration,? extends StoreConfigurationBuilder<?,?>> builder)
-
-
Method Detail
-
async
public AsyncStoreConfigurationBuilder<S> async()
Description copied from interface:StoreConfigurationChildBuilder
Configuration for the async cache store. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.- Specified by:
async
in interfaceStoreConfigurationChildBuilder<S>
-
fetchPersistentState
public S fetchPersistentState(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. Persistent state transfer with a shared cache store does not make sense, as the same persistent store that provides the data will just end up receiving it. Therefore, if a shared cache store is used, the cache will not allow a persistent state transfer even if a cache store has this property set to true. Finally, setting it to true only makes sense if in a clustered environment.- Specified by:
fetchPersistentState
in interfaceStoreConfigurationChildBuilder<S>
-
ignoreModifications
public S ignoreModifications(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache.- Specified by:
ignoreModifications
in interfaceStoreConfigurationChildBuilder<S>
-
purgeOnStartup
public S purgeOnStartup(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true, purges this cache store when it starts up.- Specified by:
purgeOnStartup
in interfaceStoreConfigurationChildBuilder<S>
-
writeOnly
public S writeOnly(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true, this cache store will be only used to write entries.- Specified by:
writeOnly
in interfaceStoreConfigurationChildBuilder<S>
-
preload
public S preload(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. If multiple cache stores are chained, only one of them can have this property enabled. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.- Specified by:
preload
in interfaceStoreConfigurationChildBuilder<S>
-
shared
public S shared(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store. Note that this could be useful if each individual node has its own cache store - perhaps local on-disk.- Specified by:
shared
in interfaceStoreConfigurationChildBuilder<S>
-
transactional
public S transactional(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
This setting should be set to true when the underlying cache store supports transactions and it is desirable for the underlying store and the cache to remain synchronized. With this enabled any Exceptions thrown whilst writing to the underlying store will result in both the store's and the cache's transaction rollingback. If enabled and this store is shared, then writes to this store will be performed at prepare time of the Infinispan Tx. If an exception is encountered by the store during prepare time, then this will result in the global Tx being rolledback along with this stores writes, otherwise writes to this store will be committed during the commit phase of 2PC. If this is not enabled, then writes to the cache store are performed during the commit phase of a Tx. Note that this requiresStoreConfigurationChildBuilder.shared(boolean)
to be set to true.- Specified by:
transactional
in interfaceStoreConfigurationChildBuilder<S>
-
maxBatchSize
public S maxBatchSize(int maxBatchSize)
Description copied from interface:StoreConfigurationChildBuilder
The maximum size of a batch to be inserted/deleted from the store. If the value is less than one, then no upper limit is placed on the number of operations in a batch.- Specified by:
maxBatchSize
in interfaceStoreConfigurationChildBuilder<S>
-
segmented
public S segmented(boolean b)
Description copied from interface:StoreConfigurationChildBuilder
If true this store should either be non shared (segmenting can be done automatically for non shared stores) or the shared store must implement theSegmentedAdvancedLoadWriteStore
interface. Segmented stores help performance for things that require viewing the entire contents of the store (eg. iteration, stream processing, state transfer, mass indexer). If the store doesn't provide constant time operations for methods such asCacheLoader.loadEntry(Object)
orCacheWriter.write(MarshallableEntry)
than segmenting this store could also improve performance of those operations.- Specified by:
segmented
in interfaceStoreConfigurationChildBuilder<S>
- Parameters:
b
- whether this store should be segmented- Returns:
- this
-
addProperty
public S addProperty(String key, String value)
Description copied from interface:StoreConfigurationChildBuilder
Defines a single property. Can be used multiple times to define all needed properties, but the full set is overridden by
StoreConfigurationChildBuilder.withProperties(java.util.Properties)
.These properties are passed directly to the cache store.
- Specified by:
addProperty
in interfaceStoreConfigurationChildBuilder<S>
-
withProperties
public S withProperties(Properties p)
Description copied from interface:StoreConfigurationChildBuilder
Properties passed to the cache store or loader- Specified by:
withProperties
in interfaceStoreConfigurationChildBuilder<S>
-
template
public ConfigurationChildBuilder template(boolean template)
- Specified by:
template
in interfaceConfigurationChildBuilder
-
simpleCache
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
- Specified by:
simpleCache
in interfaceConfigurationChildBuilder
-
simpleCache
public boolean simpleCache()
- Specified by:
simpleCache
in interfaceConfigurationChildBuilder
-
clustering
public ClusteringConfigurationBuilder clustering()
- Specified by:
clustering
in interfaceConfigurationChildBuilder
-
customInterceptors
@Deprecated public CustomInterceptorsConfigurationBuilder customInterceptors()
Deprecated.Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors- Specified by:
customInterceptors
in interfaceConfigurationChildBuilder
-
encoding
public EncodingConfigurationBuilder encoding()
- Specified by:
encoding
in interfaceConfigurationChildBuilder
-
expiration
public ExpirationConfigurationBuilder expiration()
- Specified by:
expiration
in interfaceConfigurationChildBuilder
-
indexing
public IndexingConfigurationBuilder indexing()
- Specified by:
indexing
in interfaceConfigurationChildBuilder
-
invocationBatching
public InvocationBatchingConfigurationBuilder invocationBatching()
- Specified by:
invocationBatching
in interfaceConfigurationChildBuilder
-
statistics
public StatisticsConfigurationBuilder statistics()
- Specified by:
statistics
in interfaceConfigurationChildBuilder
-
persistence
public PersistenceConfigurationBuilder persistence()
- Specified by:
persistence
in interfaceConfigurationChildBuilder
-
locking
public LockingConfigurationBuilder locking()
- Specified by:
locking
in interfaceConfigurationChildBuilder
-
security
public SecurityConfigurationBuilder security()
- Specified by:
security
in interfaceConfigurationChildBuilder
-
transaction
public TransactionConfigurationBuilder transaction()
- Specified by:
transaction
in interfaceConfigurationChildBuilder
-
unsafe
public UnsafeConfigurationBuilder unsafe()
- Specified by:
unsafe
in interfaceConfigurationChildBuilder
-
sites
public SitesConfigurationBuilder sites()
- Specified by:
sites
in interfaceConfigurationChildBuilder
-
memory
public MemoryConfigurationBuilder memory()
- Specified by:
memory
in interfaceConfigurationChildBuilder
-
getBuilder
protected ConfigurationBuilder getBuilder()
-
build
public Configuration build()
- Specified by:
build
in interfaceConfigurationChildBuilder
-
-