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:

org.infinispan.commons.configuration.Builder<RemoteStoreConfiguration>, org.infinispan.commons.configuration.Self<RemoteStoreConfigurationBuilder>, org.infinispan.configuration.cache.ConfigurationChildBuilder, org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder, org.infinispan.configuration.cache.StoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>, org.infinispan.configuration.cache.StoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>, RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

public class RemoteStoreConfigurationBuilder
extends org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>
implements RemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

RemoteStoreConfigurationBuilder. Configures a RemoteStore

Since:

5.2

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
protected org.infinispan.configuration.cache.ConfigurationBuilder	builder

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

async, attributes

Constructor Summary

Constructors

Constructor	Description
RemoteStoreConfigurationBuilder(org.infinispan.configuration.cache.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.
org.infinispan.configuration.cache.Configuration	build()
org.infinispan.configuration.cache.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()
org.infinispan.configuration.cache.CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated.
org.infinispan.configuration.cache.EncodingConfigurationBuilder	encoding()
org.infinispan.configuration.cache.ExpirationConfigurationBuilder	expiration()
RemoteStoreConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls.
protected org.infinispan.configuration.cache.ConfigurationBuilder	getBuilder()
RemoteStoreConfigurationBuilder	hotRodWrapping(boolean hotRodWrapping)	Deprecated.
org.infinispan.configuration.cache.IndexingConfigurationBuilder	indexing()
org.infinispan.configuration.cache.InvocationBatchingConfigurationBuilder	invocationBatching()
RemoteStoreConfigurationBuilder	keySizeEstimate(int keySizeEstimate)	Deprecated. Since 12.0, does nothing and will be removed in 15.0
org.infinispan.configuration.cache.LockingConfigurationBuilder	locking()
RemoteStoreConfigurationBuilder	marshaller(Class<? extends org.infinispan.commons.marshall.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.
org.infinispan.configuration.cache.MemoryConfigurationBuilder	memory()
org.infinispan.configuration.cache.PersistenceConfigurationBuilder	persistence()
RemoteStoreConfigurationBuilder	protocolVersion(org.infinispan.client.hotrod.ProtocolVersion protocolVersion)	This property defines the protocol version that this client should use.
RemoteStoreConfigurationBuilder	rawValues(boolean rawValues)	Deprecated.
RemoteStoreConfigurationBuilder	read(RemoteStoreConfiguration template)
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
org.infinispan.configuration.cache.SecurityConfigurationBuilder	security()
RemoteStoreConfigurationBuilder	self()
boolean	simpleCache()
org.infinispan.configuration.cache.ConfigurationChildBuilder	simpleCache(boolean arg0)
org.infinispan.configuration.cache.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.
org.infinispan.configuration.cache.StatisticsConfigurationBuilder	statistics()
RemoteStoreConfigurationBuilder	tcpNoDelay(boolean tcpNoDelay)	Affects TCP NODELAY on the TCP stack.
org.infinispan.configuration.cache.ConfigurationChildBuilder	template(boolean arg0)
org.infinispan.configuration.cache.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.
org.infinispan.configuration.cache.UnsafeConfigurationBuilder	unsafe()
RemoteStoreConfigurationBuilder	uri(String uri)
void	validate()
RemoteStoreConfigurationBuilder	valueSizeEstimate(int valueSizeEstimate)	Deprecated. Since 12.0, does nothing and will be removed in 15.0
RemoteStoreConfigurationBuilder	withProperties(Properties props)

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 class java.lang.Object

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

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 org.infinispan.configuration.cache.ConfigurationBuilder builder

Constructor Detail

RemoteStoreConfigurationBuilder

public RemoteStoreConfigurationBuilder(org.infinispan.configuration.cache.PersistenceConfigurationBuilder builder)

Method Detail

self

public RemoteStoreConfigurationBuilder self()

Specified by:

self in interface org.infinispan.commons.configuration.Self<RemoteStoreConfigurationBuilder>

attributes

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

Overrides:

attributes in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,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

@Deprecated
public RemoteStoreConfigurationBuilder hotRodWrapping(boolean hotRodWrapping)

Deprecated.

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

@Deprecated
public RemoteStoreConfigurationBuilder keySizeEstimate(int keySizeEstimate)

Deprecated.

Since 12.0, does nothing and will be removed in 15.0

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 org.infinispan.commons.marshall.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(org.infinispan.client.hotrod.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

@Deprecated
public RemoteStoreConfigurationBuilder rawValues(boolean rawValues)

Deprecated.

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>

uri

public RemoteStoreConfigurationBuilder uri(String uri)

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

@Deprecated
public RemoteStoreConfigurationBuilder valueSizeEstimate(int valueSizeEstimate)

Deprecated.

Since 12.0, does nothing and will be removed in 15.0

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()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<RemoteStoreConfiguration>

read

public RemoteStoreConfigurationBuilder read(RemoteStoreConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<RemoteStoreConfiguration>

Overrides:

read in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

withProperties

public RemoteStoreConfigurationBuilder withProperties(Properties props)

Specified by:

withProperties in interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>

Overrides:

withProperties in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<RemoteStoreConfiguration>

Overrides:

validate in class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>

template

public org.infinispan.configuration.cache.ConfigurationChildBuilder template(boolean arg0)

Specified by:

template in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

simpleCache

public org.infinispan.configuration.cache.ConfigurationChildBuilder simpleCache(boolean arg0)

Specified by:

simpleCache in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

clustering

public org.infinispan.configuration.cache.ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

customInterceptors

@Deprecated
public org.infinispan.configuration.cache.CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated.

Specified by:

customInterceptors in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

encoding

public org.infinispan.configuration.cache.EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

expiration

public org.infinispan.configuration.cache.ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

indexing

public org.infinispan.configuration.cache.IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

invocationBatching

public org.infinispan.configuration.cache.InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

statistics

public org.infinispan.configuration.cache.StatisticsConfigurationBuilder statistics()

Specified by:

statistics in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

persistence

public org.infinispan.configuration.cache.PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

locking

public org.infinispan.configuration.cache.LockingConfigurationBuilder locking()

Specified by:

locking in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

security

public org.infinispan.configuration.cache.SecurityConfigurationBuilder security()

Specified by:

security in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

transaction

public org.infinispan.configuration.cache.TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

unsafe

public org.infinispan.configuration.cache.UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

sites

public org.infinispan.configuration.cache.SitesConfigurationBuilder sites()

Specified by:

sites in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

memory

public org.infinispan.configuration.cache.MemoryConfigurationBuilder memory()

Specified by:

memory in interface org.infinispan.configuration.cache.ConfigurationChildBuilder

getBuilder

protected org.infinispan.configuration.cache.ConfigurationBuilder getBuilder()

build

public org.infinispan.configuration.cache.Configuration build()

Specified by:

build in interface org.infinispan.configuration.cache.ConfigurationChildBuilder