org.infinispan.client.hotrod.configuration

Class RemoteCacheConfigurationBuilder

java.lang.Object

org.infinispan.client.hotrod.configuration.RemoteCacheConfigurationBuilder

All Implemented Interfaces:

Builder<RemoteCacheConfiguration>

public class RemoteCacheConfigurationBuilder
extends Object
implements Builder<RemoteCacheConfiguration>

Per-cache configuration.

Since:

11.0

Author:

Tristan Tarrant <tristan@infinispan.org>

Method Summary

Modifier and Type	Method and Description
RemoteCacheConfigurationBuilder	configuration(String configuration) Specifies the declarative configuration to be used to create the cache if it doesn't already exist on the server.
RemoteCacheConfigurationBuilder	configurationURI(URI uri) Specifies a URI pointing to the declarative configuration to be used to create the cache if it doesn't already exist on the server.
RemoteCacheConfiguration	create() Create the configuration bean
RemoteCacheConfigurationBuilder	forceReturnValues(boolean forceReturnValues) Whether or not to implicitly FORCE_RETURN_VALUE for all calls to this cache.
RemoteCacheConfigurationBuilder	nearCacheFactory(NearCacheFactory factory) Specifies a NearCacheFactory which is responsible for creating NearCache instances.
RemoteCacheConfigurationBuilder	nearCacheMaxEntries(int maxEntries) Specifies the maximum number of entries that will be held in the near cache.
RemoteCacheConfigurationBuilder	nearCacheMode(NearCacheMode mode) Specifies the near caching mode.
Builder<?>	read(RemoteCacheConfiguration template) Reads the configuration from an already created configuration bean into this builder.
RemoteCacheConfigurationBuilder	templateName(DefaultTemplate template) Specifies one of the default templates to be used to create the cache if it doesn't already exist on the server.
RemoteCacheConfigurationBuilder	templateName(String templateName) Specifies the name of a template to be used to create the cache if it doesn't already exist on the server.
RemoteCacheConfigurationBuilder	transactionManager(TransactionManager manager) The TransactionManager to use for the cache
RemoteCacheConfigurationBuilder	transactionMode(TransactionMode mode) The TransactionMode in which a RemoteCache will be enlisted.
void	validate() Validate the data in this builder before building the configuration bean
ConfigurationBuilder	withProperties(Properties properties)

Methods inherited from class java.lang.Object

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

Method Detail

forceReturnValues

public RemoteCacheConfigurationBuilder forceReturnValues(boolean forceReturnValues)

Whether or not to implicitly FORCE_RETURN_VALUE for all calls to this cache.

nearCacheMode

public RemoteCacheConfigurationBuilder nearCacheMode(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

nearCacheMaxEntries

public RemoteCacheConfigurationBuilder nearCacheMaxEntries(int maxEntries)

Specifies the maximum number of entries that will be held in the near cache. Only works when nearCacheMode(NearCacheMode) is not NearCacheMode.DISABLED.

Parameters:

maxEntries - maximum entries in the near cache.

Returns:

an instance of the builder

nearCacheFactory

public RemoteCacheConfigurationBuilder nearCacheFactory(NearCacheFactory factory)

Specifies a NearCacheFactory which is responsible for creating NearCache instances.

Parameters:

factory - a NearCacheFactory

Returns:

an instance of the builder

configuration

public RemoteCacheConfigurationBuilder configuration(String configuration)

Specifies the declarative configuration to be used to create the cache if it doesn't already exist on the server.

Parameters:

configuration - the XML representation of a cache configuration.

Returns:

an instance of the builder

configurationURI

public RemoteCacheConfigurationBuilder configurationURI(URI uri)

Specifies a URI pointing to the declarative configuration to be used to create the cache if it doesn't already exist on the server.

Parameters:

uri - the URI of the configuration.

Returns:

an instance of the builder

templateName

public RemoteCacheConfigurationBuilder templateName(String templateName)

Specifies the name of a template to be used to create the cache if it doesn't already exist on the server.

Parameters:

templateName - the name of the template.

Returns:

an instance of the builder

templateName

public RemoteCacheConfigurationBuilder templateName(DefaultTemplate template)

Specifies one of the default templates to be used to create the cache if it doesn't already exist on the server.

Parameters:

template - the template to use

Returns:

an instance of the builder

transactionMode

public RemoteCacheConfigurationBuilder transactionMode(TransactionMode mode)

The TransactionMode in which a RemoteCache will be enlisted.

Parameters:

mode - the transaction mode

Returns:

an instance of the builder

transactionManager

public RemoteCacheConfigurationBuilder transactionManager(TransactionManager manager)

The TransactionManager to use for the cache

Parameters:

manager - an instance of a TransactionManager

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

create

public RemoteCacheConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<RemoteCacheConfiguration>

Returns:

read

public Builder<?> read(RemoteCacheConfiguration 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<RemoteCacheConfiguration>

Parameters:

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

withProperties

public ConfigurationBuilder withProperties(Properties properties)