org.infinispan.loaders.remote.configuration

Class RemoteCacheStoreConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteCacheStoreConfiguration,RemoteCacheStoreConfigurationBuilder>

org.infinispan.loaders.remote.configuration.RemoteCacheStoreConfigurationBuilder

All Implemented Interfaces:

Builder<RemoteCacheStoreConfiguration>, Self<RemoteCacheStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<RemoteCacheStoreConfiguration,RemoteCacheStoreConfigurationBuilder>, StoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>, RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

public class RemoteCacheStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<RemoteCacheStoreConfiguration,RemoteCacheStoreConfigurationBuilder>
implements RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

RemoteCacheStoreConfigurationBuilder. Configures a RemoteStore

Since:

5.2

Author:

Tristan Tarrant

Field Summary

Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

async, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singletonStore

Constructor Summary

Constructors

Constructor and Description
RemoteCacheStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
RemoteServerConfigurationBuilder	addServer() Adds a new remote server
ExecutorFactoryConfigurationBuilder	asyncExecutorFactory() Configuration for the executor service used for asynchronous work on the Transport, including asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().
RemoteCacheStoreConfigurationBuilder	balancingStrategy(String balancingStrategy) For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.
Configuration	build()
ClusteringConfigurationBuilder	clustering()
CompatibilityModeConfigurationBuilder	compatibility()
ConnectionPoolConfigurationBuilder	connectionPool() Configures the connection pool
RemoteCacheStoreConfigurationBuilder	connectionTimeout(long connectionTimeout) This property defines the maximum socket connect timeout before giving up connecting to the server.
RemoteCacheStoreConfiguration	create() Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()
DataContainerConfigurationBuilder	dataContainer()
DeadlockDetectionConfigurationBuilder	deadlockDetection()
RemoteCacheStoreConfigurationBuilder	entryWrapper(EntryWrapper<?,?> entryWrapper) Allows you to specify a custom EntryWrapper implementation to wrap cache entries
EvictionConfigurationBuilder	eviction()
ExpirationConfigurationBuilder	expiration()
RemoteCacheStoreConfigurationBuilder	forceReturnValues(boolean forceReturnValues) Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
protected ConfigurationBuilder	getBuilder()
RemoteCacheStoreConfigurationBuilder	hotRodWrapping(boolean hotRodWrapping) Configures this RemoteStore so that it enables all settings needed to create entries to be served by a HotRod endpoint, for example when performing rolling upgrades.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
RemoteCacheStoreConfigurationBuilder	keySizeEstimate(int keySizeEstimate) The class name of the driver used for connecting to the database.
LockingConfigurationBuilder	locking()
RemoteCacheStoreConfigurationBuilder	marshaller(Class<? extends Marshaller> marshaller) Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
RemoteCacheStoreConfigurationBuilder	marshaller(String marshaller) Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
PersistenceConfigurationBuilder	persistence()
RemoteCacheStoreConfigurationBuilder	pingOnStartup(boolean pingOnStartup) If true, a ping request is sent to a back end server in order to fetch cluster's topology.
RemoteCacheStoreConfigurationBuilder	protocolVersion(String protocolVersion) This property defines the protocol version that this client should use.
RemoteCacheStoreConfigurationBuilder	rawValues(boolean rawValues) Normally the RemoteStore stores values wrapped in InternalCacheEntry.
RemoteCacheStoreConfigurationBuilder	read(RemoteCacheStoreConfiguration template) Reads the configuration from an already created configuration bean into this builder.
RemoteCacheStoreConfigurationBuilder	remoteCacheName(String remoteCacheName) The name of the remote cache in the remote infinispan cluster, to which to connect to.
RemoteCacheStoreConfigurationBuilder	self()
SitesConfigurationBuilder	sites()
RemoteCacheStoreConfigurationBuilder	socketTimeout(long socketTimeout) This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server.
StoreAsBinaryConfigurationBuilder	storeAsBinary()
RemoteCacheStoreConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay) Affects TCP NODELAY on the TCP stack.
TransactionConfigurationBuilder	transaction()
RemoteCacheStoreConfigurationBuilder	transportFactory(Class<? extends TransportFactory> transportFactory) Controls which transport to use.
RemoteCacheStoreConfigurationBuilder	transportFactory(String transportFactory) Controls which transport to use.
UnsafeConfigurationBuilder	unsafe()
void	validate() Validate the data in this builder before building the configuration bean
RemoteCacheStoreConfigurationBuilder	valueSizeEstimate(int valueSizeEstimate) This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.
VersioningConfigurationBuilder	versioning()

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder

addProperty, async, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singleton, withProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

addProperty, async, fetchPersistentState, ignoreModifications, preload, purgeOnStartup, shared, singleton, withProperties

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, sites, storeAsBinary, transaction, unsafe, versioning

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder

persistence

Constructor Detail

RemoteCacheStoreConfigurationBuilder

public RemoteCacheStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

self

public RemoteCacheStoreConfigurationBuilder self()

Specified by:

self in interface Self<RemoteCacheStoreConfigurationBuilder>

asyncExecutorFactory

public ExecutorFactoryConfigurationBuilder asyncExecutorFactory()

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Configuration for the executor service used for asynchronous work on the Transport, including asynchronous marshalling and Cache 'async operations' such as Cache.putAsync().

Specified by:

asyncExecutorFactory in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

balancingStrategy

public RemoteCacheStoreConfigurationBuilder balancingStrategy(String balancingStrategy)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

For replicated (vs distributed) Hot Rod server clusters, the client balances requests to the servers according to this strategy.

Specified by:

balancingStrategy in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

connectionPool

public ConnectionPoolConfigurationBuilder connectionPool()

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Configures the connection pool

Specified by:

connectionPool in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

connectionTimeout

public RemoteCacheStoreConfigurationBuilder connectionTimeout(long connectionTimeout)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

This property defines the maximum socket connect timeout before giving up connecting to the server.

Specified by:

connectionTimeout in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

entryWrapper

public RemoteCacheStoreConfigurationBuilder entryWrapper(EntryWrapper<?,?> entryWrapper)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Allows you to specify a custom EntryWrapper implementation to wrap cache entries

Specified by:

entryWrapper in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

forceReturnValues

public RemoteCacheStoreConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

Specified by:

forceReturnValues in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

hotRodWrapping

public RemoteCacheStoreConfigurationBuilder hotRodWrapping(boolean hotRodWrapping)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Configures this RemoteStore so that it enables all settings needed to create entries to be served by a HotRod endpoint, for example when performing rolling upgrades.

Specified by:

hotRodWrapping in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

keySizeEstimate

public RemoteCacheStoreConfigurationBuilder keySizeEstimate(int keySizeEstimate)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

The class name of the driver used for connecting to the database.

Specified by:

keySizeEstimate in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

marshaller

public RemoteCacheStoreConfigurationBuilder marshaller(String marshaller)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.

Specified by:

marshaller in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

marshaller

public RemoteCacheStoreConfigurationBuilder marshaller(Class<? extends Marshaller> marshaller)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.

Specified by:

marshaller in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

pingOnStartup

public RemoteCacheStoreConfigurationBuilder pingOnStartup(boolean pingOnStartup)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

If true, a ping request is sent to a back end server in order to fetch cluster's topology.

Specified by:

pingOnStartup in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

protocolVersion

public RemoteCacheStoreConfigurationBuilder protocolVersion(String protocolVersion)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

This property defines the protocol version that this client should use. Defaults to 1.1. Other valid values include 1.0.

Specified by:

protocolVersion in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

rawValues

public RemoteCacheStoreConfigurationBuilder rawValues(boolean rawValues)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Normally the RemoteStore stores values wrapped in InternalCacheEntry. Setting this property to true causes the raw values to be stored instead for interoperability with direct access by RemoteCacheManagers

Specified by:

rawValues in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

remoteCacheName

public RemoteCacheStoreConfigurationBuilder remoteCacheName(String remoteCacheName)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

The name of the remote cache in the remote infinispan cluster, to which to connect to. If unspecified, the default cache will be used

Specified by:

remoteCacheName in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

socketTimeout

public RemoteCacheStoreConfigurationBuilder socketTimeout(long socketTimeout)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server. Defaults to 60000 (1 minute)

Specified by:

socketTimeout in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

tcpNoDelay

public RemoteCacheStoreConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

transportFactory

public RemoteCacheStoreConfigurationBuilder transportFactory(String transportFactory)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Controls which transport to use. Currently only the TcpTransport is supported.

Specified by:

transportFactory in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

transportFactory

public RemoteCacheStoreConfigurationBuilder transportFactory(Class<? extends TransportFactory> transportFactory)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Controls which transport to use. Currently only the TcpTransport is supported.

Specified by:

transportFactory in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

valueSizeEstimate

public RemoteCacheStoreConfigurationBuilder valueSizeEstimate(int valueSizeEstimate)

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.

Specified by:

valueSizeEstimate in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

addServer

public RemoteServerConfigurationBuilder addServer()

Description copied from interface: RemoteCacheStoreConfigurationChildBuilder

Adds a new remote server

Specified by:

addServer in interface RemoteCacheStoreConfigurationChildBuilder<RemoteCacheStoreConfigurationBuilder>

create

public RemoteCacheStoreConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<RemoteCacheStoreConfiguration>

Returns:

read

public RemoteCacheStoreConfigurationBuilder read(RemoteCacheStoreConfiguration template)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<RemoteCacheStoreConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<RemoteCacheStoreConfiguration>

Overrides:

validate in class AbstractStoreConfigurationBuilder<RemoteCacheStoreConfiguration,RemoteCacheStoreConfigurationBuilder>

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

public CustomInterceptorsConfigurationBuilder customInterceptors()

Specified by:

customInterceptors in interface ConfigurationChildBuilder

dataContainer

public DataContainerConfigurationBuilder dataContainer()

Specified by:

dataContainer in interface ConfigurationChildBuilder

deadlockDetection

public DeadlockDetectionConfigurationBuilder deadlockDetection()

Specified by:

deadlockDetection in interface ConfigurationChildBuilder

eviction

public EvictionConfigurationBuilder eviction()

Specified by:

eviction in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

jmxStatistics

public JMXStatisticsConfigurationBuilder jmxStatistics()

Specified by:

jmxStatistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

storeAsBinary

public StoreAsBinaryConfigurationBuilder storeAsBinary()

Specified by:

storeAsBinary in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

versioning

public VersioningConfigurationBuilder versioning()

Specified by:

versioning in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

compatibility

public CompatibilityModeConfigurationBuilder compatibility()

Specified by:

compatibility in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder