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 aRemoteStore
- 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RemoteServerConfigurationBuilder
addServer()
Adds a new remote serverExecutorFactoryConfigurationBuilder
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 poolRemoteStoreConfigurationBuilder
connectionTimeout(long connectionTimeout)
This property defines the maximum socket connect timeout before giving up connecting to the server.RemoteStoreConfiguration
create()
Create the configuration beanCustomInterceptorsConfigurationBuilder
customInterceptors()
Deprecated.Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptorsEncodingConfigurationBuilder
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 customMarshaller
implementation to serialize and deserialize user objects.RemoteStoreConfigurationBuilder
marshaller(String marshaller)
Allows you to specify a customMarshaller
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 theRemoteStore
stores values wrapped inInternalCacheEntry
.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 securitySecurityConfigurationBuilder
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 beanRemoteStoreConfigurationBuilder
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
-
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
-
-
-
-
Field Detail
-
builder
protected final ConfigurationBuilder builder
-
-
Constructor Detail
-
RemoteStoreConfigurationBuilder
public RemoteStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)
-
-
Method Detail
-
self
public RemoteStoreConfigurationBuilder self()
- Specified by:
self
in interfaceSelf<RemoteStoreConfigurationBuilder>
-
attributes
public org.infinispan.commons.configuration.attributes.AttributeSet attributes()
- Specified by:
attributes
in interfaceBaseConfigurationInfo
- Overrides:
attributes
in classAbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>
- Returns:
- the
AttributeSet
declared by the configuration.
-
getElementDefinition
public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()
- Specified by:
getElementDefinition
in interfaceBaseConfigurationInfo
- Returns:
- the
ElementDefinition
of the configuration.
-
getChildrenInfo
public Collection<ConfigurationBuilderInfo> getChildrenInfo()
- Specified by:
getChildrenInfo
in interfaceConfigurationBuilderInfo
- Overrides:
getChildrenInfo
in classAbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>
- Returns:
- a collection of
ConfigurationBuilderInfo
for the sub-elements of the builder.
-
getNewBuilderInfo
public ConfigurationBuilderInfo getNewBuilderInfo(String name)
- Specified by:
getNewBuilderInfo
in interfaceConfigurationBuilderInfo
- 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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
connectionPool
public ConnectionPoolConfigurationBuilder connectionPool()
Description copied from interface:RemoteStoreConfigurationChildBuilder
Configures the connection pool- Specified by:
connectionPool
in interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
marshaller
public RemoteStoreConfigurationBuilder marshaller(String marshaller)
Description copied from interface:RemoteStoreConfigurationChildBuilder
Allows you to specify a customMarshaller
implementation to serialize and deserialize user objects.- Specified by:
marshaller
in interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
marshaller
public RemoteStoreConfigurationBuilder marshaller(Class<? extends Marshaller> marshaller)
Description copied from interface:RemoteStoreConfigurationChildBuilder
Allows you to specify a customMarshaller
implementation to serialize and deserialize user objects.- Specified by:
marshaller
in interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
protocolVersion
public RemoteStoreConfigurationBuilder protocolVersion(ProtocolVersion protocolVersion)
Description copied from interface:RemoteStoreConfigurationChildBuilder
This property defines the protocol version that this client should use. Defaults toProtocolVersion.DEFAULT_PROTOCOL_VERSION
- Specified by:
protocolVersion
in interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
rawValues
public RemoteStoreConfigurationBuilder rawValues(boolean rawValues)
Description copied from interface:RemoteStoreConfigurationChildBuilder
Normally theRemoteStore
stores values wrapped inInternalCacheEntry
. Setting this property to true causes the raw values to be stored instead for interoperability with direct access byRemoteCacheManager
s- Specified by:
rawValues
in interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
remoteSecurity
public SecurityConfigurationBuilder remoteSecurity()
Description copied from interface:RemoteStoreConfigurationChildBuilder
Configures connection security- Specified by:
remoteSecurity
in interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<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 interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
addServer
public RemoteServerConfigurationBuilder addServer()
Description copied from interface:RemoteStoreConfigurationChildBuilder
Adds a new remote server- Specified by:
addServer
in interfaceRemoteStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
-
create
public RemoteStoreConfiguration create()
Description copied from interface:Builder
Create the configuration bean- Specified by:
create
in interfaceBuilder<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 interfaceBuilder<RemoteStoreConfiguration>
- Overrides:
read
in classAbstractStoreConfigurationBuilder<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 interfaceStoreConfigurationChildBuilder<RemoteStoreConfigurationBuilder>
- Overrides:
withProperties
in classAbstractStoreConfigurationBuilder<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 interfaceBuilder<RemoteStoreConfiguration>
- Overrides:
validate
in classAbstractStoreConfigurationBuilder<RemoteStoreConfiguration,RemoteStoreConfigurationBuilder>
-
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
-
-