Class NearCacheConfigurationBuilder

java.lang.Object

org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

org.infinispan.client.hotrod.configuration.NearCacheConfigurationBuilder

All Implemented Interfaces:

ConfigurationChildBuilder, Builder<NearCacheConfiguration>

public class NearCacheConfigurationBuilder
extends AbstractConfigurationChildBuilder
implements Builder<NearCacheConfiguration>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NearCacheConfigurationBuilder(ConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
NearCacheConfigurationBuilder	bloomFilter(boolean enable)	Specifies whether bloom filter should be used for near cache to limit the number of write notifications for unrelated keys.
NearCacheConfigurationBuilder	cacheNamePattern(String pattern)	Deprecated, for removal: This API element is subject to removal in a future version. use RemoteCacheConfigurationBuilder.nearCacheMode(NearCacheMode) to enable near-caching per-cache
NearCacheConfigurationBuilder	cacheNamePattern(Pattern pattern)	Deprecated, for removal: This API element is subject to removal in a future version. use RemoteCacheConfigurationBuilder.nearCacheMode(NearCacheMode) to enable near-caching per-cache
NearCacheConfiguration	create()	Create the configuration bean
NearCacheConfigurationBuilder	maxEntries(int maxEntries)	Specifies the maximum number of entries that will be held in the near cache.
NearCacheConfigurationBuilder	mode(NearCacheMode mode)	Specifies the near caching mode.
NearCacheConfigurationBuilder	nearCacheFactory(NearCacheFactory factory)	Specifies a NearCacheFactory which is responsible for creating NearCache instances.
Builder<?>	read(NearCacheConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
void	validate()	Validate the data in this builder before building the configuration bean
ConfigurationBuilder	withProperties(Properties properties)	Configures this builder using the specified properties.

Methods inherited from class org.infinispan.client.hotrod.configuration.AbstractConfigurationChildBuilder

addCluster, addContextInitializer, addContextInitializer, addContextInitializers, addJavaSerialAllowList, addJavaSerialWhiteList, addServer, addServers, asyncExecutorFactory, balancingStrategy, balancingStrategy, balancingStrategy, batchSize, build, clientIntelligence, connectionPool, connectionTimeout, consistentHashImpl, consistentHashImpl, dnsResolverMaxTTL, dnsResolverMinTTL, dnsResolverNegativeTTL, forceReturnValues, keySizeEstimate, marshaller, marshaller, marshaller, maxRetries, remoteCache, security, serverFailureTimeout, socketTimeout, statistics, tcpKeepAlive, tcpNoDelay, transaction, transactionTimeout, transportFactory, uri, uri, valueSizeEstimate, version, withMetricRegistry

Methods inherited from class java.lang.Object

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

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

read, reset

Constructor Details

NearCacheConfigurationBuilder

protected NearCacheConfigurationBuilder(ConfigurationBuilder builder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<NearCacheConfiguration>

maxEntries

public NearCacheConfigurationBuilder maxEntries(int maxEntries)

Specifies the maximum number of entries that will be held in the near cache.

Parameters:

maxEntries - maximum entries in the near cache.

Returns:

an instance of the builder

bloomFilter

public NearCacheConfigurationBuilder bloomFilter(boolean enable)

Specifies whether bloom filter should be used for near cache to limit the number of write notifications for unrelated keys.

Parameters:

enable - whether to enable bloom filter

Returns:

an instance of this builder

mode

public NearCacheConfigurationBuilder mode(NearCacheMode mode)

Specifies the near caching mode. See NearCacheMode for details on the available modes.

Parameters:

mode - one of NearCacheMode

Returns:

an instance of the builder

cacheNamePattern

@Deprecated(forRemoval=true,
            since="11.0")
public NearCacheConfigurationBuilder cacheNamePattern(String pattern)

Deprecated, for removal: This API element is subject to removal in a future version.

use RemoteCacheConfigurationBuilder.nearCacheMode(NearCacheMode) to enable near-caching per-cache

Specifies a cache name pattern (in the form of a regular expression) that matches all cache names for which near caching should be enabled. See the Pattern syntax for details on the format.

Parameters:

pattern - a regular expression.

Returns:

an instance of the builder

cacheNamePattern

@Deprecated(forRemoval=true,
            since="11.0")
public NearCacheConfigurationBuilder cacheNamePattern(Pattern pattern)

Deprecated, for removal: This API element is subject to removal in a future version.

use RemoteCacheConfigurationBuilder.nearCacheMode(NearCacheMode) to enable near-caching per-cache

Specifies a cache name pattern that matches all cache names for which near caching should be enabled.

Parameters:

pattern - a Pattern

Returns:

an instance of the builder

nearCacheFactory

public NearCacheConfigurationBuilder nearCacheFactory(NearCacheFactory factory)

Specifies a NearCacheFactory which is responsible for creating NearCache instances.

Parameters:

factory - a NearCacheFactory

Returns:

an instance of the builder

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

create

public NearCacheConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<NearCacheConfiguration>

Returns:

read

public Builder<?> read(NearCacheConfiguration template,
 Combine combine)

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

Parameters:

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

combine - the way attributes and children of this instance and the template should be combined.

withProperties

public ConfigurationBuilder withProperties(Properties properties)

Description copied from interface: ConfigurationChildBuilder

Configures this builder using the specified properties. See ConfigurationBuilder for a list.

Specified by:

withProperties in interface ConfigurationChildBuilder

Overrides:

withProperties in class AbstractConfigurationChildBuilder