Package 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:

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

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

RemoteStoreConfigurationBuilder. Configures a RemoteStore

Since:

5.2

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationBuilder	builder

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

async, attributes

Constructor Summary

Constructors

Constructor	Description
RemoteStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	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().
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
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()
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()	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
RemoteStoreConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
protected ConfigurationBuilder	getBuilder()
Collection<ConfigurationBuilderInfo>	getChildrenInfo()
org.infinispan.commons.configuration.elements.ElementDefinition	getElementDefinition()
ConfigurationBuilderInfo	getNewBuilderInfo(String name)
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()
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 Marshaller implementation to serialize and deserialize user objects.
RemoteStoreConfigurationBuilder	marshaller(String marshaller)	Allows you to specify a custom Marshaller implementation to serialize and deserialize user objects.
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
RemoteStoreConfigurationBuilder	protocolVersion(ProtocolVersion 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	remoteSecurity()	Configures connection security
SecurityConfigurationBuilder	security()
RemoteStoreConfigurationBuilder	self()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
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.
StatisticsConfigurationBuilder	statistics()
RemoteStoreConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
ConfigurationChildBuilder	template(boolean template)
TransactionConfigurationBuilder	transaction()
RemoteStoreConfigurationBuilder	transportFactory(Class<? extends org.infinispan.client.hotrod.impl.transport.netty.ChannelFactory> 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.
RemoteStoreConfigurationBuilder	withProperties(Properties props)	Properties passed to the cache store or loader

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

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, segmented, shared, toString, transactional, validate, validate, writeOnly

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

getBuilderInfo

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

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

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, writeOnly

Field Detail

builder

protected final ConfigurationBuilder builder

Constructor Detail

RemoteStoreConfigurationBuilder

public RemoteStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

self

public RemoteStoreConfigurationBuilder self()

Specified by:

self in interface Self<RemoteStoreConfigurationBuilder>

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Overrides:

attributes in class AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

Returns:

the AttributeSet declared by the configuration.

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

getChildrenInfo

public Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Overrides:

getChildrenInfo in class AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

getNewBuilderInfo

public ConfigurationBuilderInfo getNewBuilderInfo(String name)

Specified by:

getNewBuilderInfo in interface ConfigurationBuilderInfo

Returns:

same as ConfigurationBuilderInfo.getBuilderInfo(String, String) but will return a new instance of the builder on every call. This is to create unbounded sub-elements in a builder.

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 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 Marshaller implementation to serialize and deserialize user objects.

Specified by:

marshaller in interface RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

protocolVersion

public RemoteStoreConfigurationBuilder protocolVersion(ProtocolVersion protocolVersion)

Description copied from interface: RemoteStoreConfigurationChildBuilder

This property defines the protocol version that this client should use. Defaults to ProtocolVersion.DEFAULT_PROTOCOL_VERSION

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>

remoteSecurity

public SecurityConfigurationBuilder remoteSecurity()

Description copied from interface: RemoteStoreConfigurationChildBuilder

Configures connection security

Specified by:

remoteSecurity 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<? extends org.infinispan.client.hotrod.impl.transport.netty.ChannelFactory> 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.

withProperties

public RemoteStoreConfigurationBuilder withProperties(Properties props)

Description copied from class: AbstractStoreConfigurationBuilder

Properties passed to the cache store or loader

Specified by:

withProperties in interface StoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

Overrides:

withProperties in class AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

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>

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

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 interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics 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

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder