org.infinispan.persistence.remote.configuration

Class RemoteStoreConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

org.infinispan.persistence.remote.configuration.RemoteStoreConfigurationBuilder

All Implemented Interfaces:

Builder<RemoteStoreConfiguration>, Self<RemoteStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>, StoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>, RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

public class RemoteStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>
implements RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

RemoteStoreConfigurationBuilder. 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
RemoteStoreConfigurationBuilder(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().
RemoteStoreConfigurationBuilder	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
RemoteStoreConfigurationBuilder	connectionTimeout(long connectionTimeout) This property defines the maximum socket connect timeout before giving up connecting to the server.
RemoteStoreConfiguration	create() Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()
DataContainerConfigurationBuilder	dataContainer()
DeadlockDetectionConfigurationBuilder	deadlockDetection()
EvictionConfigurationBuilder	eviction()
ExpirationConfigurationBuilder	expiration()
RemoteStoreConfigurationBuilder	forceReturnValues(boolean forceReturnValues) Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
protected ConfigurationBuilder	getBuilder()
RemoteStoreConfigurationBuilder	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()
RemoteStoreConfigurationBuilder	keySizeEstimate(int keySizeEstimate) The class name of the driver used for connecting to the database.
LockingConfigurationBuilder	locking()
RemoteStoreConfigurationBuilder	marshaller(Class<? extends Marshaller> marshaller) Allows you to specify a custom org.infinispan.marshall.Marshaller implementation to serialize and deserialize user objects.
RemoteStoreConfigurationBuilder	marshaller(String marshaller) Allows you to specify a custom org.infinispan.marshall.Marshaller implementation to serialize and deserialize user objects.
PersistenceConfigurationBuilder	persistence()
RemoteStoreConfigurationBuilder	pingOnStartup(boolean pingOnStartup) If true, a ping request is sent to a back end server in order to fetch cluster's topology.
RemoteStoreConfigurationBuilder	protocolVersion(String protocolVersion) This property defines the protocol version that this client should use.
RemoteStoreConfigurationBuilder	rawValues(boolean rawValues) Normally the RemoteStore stores values wrapped in InternalCacheEntry.
RemoteStoreConfigurationBuilder	read(RemoteStoreConfiguration template) Reads the configuration from an already created configuration bean into this builder.
RemoteStoreConfigurationBuilder	remoteCacheName(String remoteCacheName) The name of the remote cache in the remote infinispan cluster, to which to connect to.
SecurityConfigurationBuilder	security()
RemoteStoreConfigurationBuilder	self()
SitesConfigurationBuilder	sites()
RemoteStoreConfigurationBuilder	socketTimeout(long socketTimeout) This property defines the maximum socket read timeout in milliseconds before giving up waiting for bytes from the server.
StoreAsBinaryConfigurationBuilder	storeAsBinary()
RemoteStoreConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay) Affects TCP NODELAY on the TCP stack.
TransactionConfigurationBuilder	transaction()
RemoteStoreConfigurationBuilder	transportFactory(Class<?> transportFactory) Controls which transport to use.
RemoteStoreConfigurationBuilder	transportFactory(String transportFactory) Controls which transport to use.
UnsafeConfigurationBuilder	unsafe()
void	validate() Validate the data in this builder before building the configuration bean
RemoteStoreConfigurationBuilder	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, validate, withProperties

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, security, sites, storeAsBinary, transaction, unsafe, validate, versioning

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

persistence

Constructor Detail

RemoteStoreConfigurationBuilder

public RemoteStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

self

public RemoteStoreConfigurationBuilder self()

Specified by:

self in interface Self<RemoteStoreConfigurationBuilder>

asyncExecutorFactory

public ExecutorFactoryConfigurationBuilder asyncExecutorFactory()

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

balancingStrategy

public RemoteStoreConfigurationBuilder balancingStrategy(String balancingStrategy)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

balancingStrategy in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

connectionPool

public ConnectionPoolConfigurationBuilder connectionPool()

Description copied from interface: RemoteStoreConfigurationChildBuilder

Configures the connection pool

Specified by:

connectionPool in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

connectionTimeout

public RemoteStoreConfigurationBuilder connectionTimeout(long connectionTimeout)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

connectionTimeout in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

forceReturnValues

public RemoteStoreConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Description copied from interface: RemoteStoreConfigurationChildBuilder

Whether or not to implicitly FORCE_RETURN_VALUE for all calls.

Specified by:

forceReturnValues in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

hotRodWrapping

public RemoteStoreConfigurationBuilder hotRodWrapping(boolean hotRodWrapping)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

keySizeEstimate

public RemoteStoreConfigurationBuilder keySizeEstimate(int keySizeEstimate)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

keySizeEstimate in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

marshaller

public RemoteStoreConfigurationBuilder marshaller(String marshaller)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

marshaller in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

marshaller

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

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

marshaller in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

pingOnStartup

public RemoteStoreConfigurationBuilder pingOnStartup(boolean pingOnStartup)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

pingOnStartup in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

protocolVersion

public RemoteStoreConfigurationBuilder protocolVersion(String protocolVersion)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

rawValues

public RemoteStoreConfigurationBuilder rawValues(boolean rawValues)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

remoteCacheName

public RemoteStoreConfigurationBuilder remoteCacheName(String remoteCacheName)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

socketTimeout

public RemoteStoreConfigurationBuilder socketTimeout(long socketTimeout)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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 RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

tcpNoDelay

public RemoteStoreConfigurationBuilder tcpNoDelay(boolean tcpNoDelay)

Description copied from interface: RemoteStoreConfigurationChildBuilder

Affects TCP NODELAY on the TCP stack. Defaults to enabled

Specified by:

tcpNoDelay in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

transportFactory

public RemoteStoreConfigurationBuilder transportFactory(String transportFactory)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

transportFactory in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

transportFactory

public RemoteStoreConfigurationBuilder transportFactory(Class<?> transportFactory)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

transportFactory in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

valueSizeEstimate

public RemoteStoreConfigurationBuilder valueSizeEstimate(int valueSizeEstimate)

Description copied from interface: RemoteStoreConfigurationChildBuilder

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

Specified by:

valueSizeEstimate in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

addServer

public RemoteServerConfigurationBuilder addServer()

Description copied from interface: RemoteStoreConfigurationChildBuilder

Adds a new remote server

Specified by:

addServer in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

create

public RemoteStoreConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<RemoteStoreConfiguration>

Returns:

read

public RemoteStoreConfigurationBuilder read(RemoteStoreConfiguration 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<RemoteStoreConfiguration>

Overrides:

read in class AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

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<RemoteStoreConfiguration>

Overrides:

validate in class AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

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

security

public SecurityConfigurationBuilder security()

Specified by:

security 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