Package org.infinispan.hotrod.configuration

Class RemoteCacheConfigurationBuilder

java.lang.Object

org.infinispan.hotrod.configuration.RemoteCacheConfigurationBuilder

All Implemented Interfaces:

org.infinispan.commons.configuration.Builder<RemoteCacheConfiguration>

public class RemoteCacheConfigurationBuilder
extends Object
implements org.infinispan.commons.configuration.Builder<RemoteCacheConfiguration>

Per-cache configuration.

Since:

14.0

Method Summary

Modifier and Type	Method	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()
RemoteCacheConfigurationBuilder	forceReturnValues(boolean forceReturnValues)	Whether or not to implicitly FORCE_RETURN_VALUE for all calls to this cache.
RemoteCacheConfigurationBuilder	marshaller(Class<? extends org.infinispan.commons.marshall.Marshaller> marshallerClass)	Specifies a custom Marshaller implementation.
RemoteCacheConfigurationBuilder	marshaller(String className)	Specifies a custom Marshaller implementation.
RemoteCacheConfigurationBuilder	marshaller(org.infinispan.commons.marshall.Marshaller marshaller)	Specifies a custom Marshaller implementation to serialize and deserialize user objects.
NearCacheConfigurationBuilder	nearCache()
org.infinispan.commons.configuration.Builder<?>	read(RemoteCacheConfiguration template)
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	transactionManagerLookup(org.infinispan.commons.tx.lookup.TransactionManagerLookup lookup)	The TransactionManagerLookup to lookup for the transaction manager to interact with.
RemoteCacheConfigurationBuilder	transactionMode(TransactionMode mode)	The TransactionMode in which a resource will be enlisted.
void	validate()
HotRodConfigurationBuilder	withProperties(Properties properties)

Methods inherited from class java.lang.Object

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

Method Detail

nearCache

public NearCacheConfigurationBuilder nearCache()

forceReturnValues

public RemoteCacheConfigurationBuilder forceReturnValues(boolean forceReturnValues)

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

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

transactionMode

public RemoteCacheConfigurationBuilder transactionMode(TransactionMode mode)

The TransactionMode in which a resource will be enlisted.

Parameters:

mode - the transaction mode

Returns:

an instance of the builder

marshaller

public RemoteCacheConfigurationBuilder marshaller(String className)

Specifies a custom Marshaller implementation. See marshaller(Marshaller).

Parameters:

className - Fully qualifies class name of the marshaller implementation.

marshaller

public RemoteCacheConfigurationBuilder marshaller(Class<? extends org.infinispan.commons.marshall.Marshaller> marshallerClass)

Specifies a custom Marshaller implementation. See marshaller(Marshaller).

Parameters:

marshallerClass - the marshaller class.

marshaller

public RemoteCacheConfigurationBuilder marshaller(org.infinispan.commons.marshall.Marshaller marshaller)

Specifies a custom Marshaller implementation to serialize and deserialize user objects. Has precedence over marshaller(Class) and marshaller(String). If not configured, the global marshaller will be used for the cache operations.

Parameters:

marshaller - the marshaller instance

transactionManagerLookup

public RemoteCacheConfigurationBuilder transactionManagerLookup(org.infinispan.commons.tx.lookup.TransactionManagerLookup lookup)

The TransactionManagerLookup to lookup for the transaction manager to interact with.

Parameters:

lookup - A TransactionManagerLookup instance.

Returns:

An instance of the builder.

validate

public void validate()

Specified by:

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

create

public RemoteCacheConfiguration create()

Specified by:

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

read

public org.infinispan.commons.configuration.Builder<?> read(RemoteCacheConfiguration template)

Specified by:

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

withProperties

public HotRodConfigurationBuilder withProperties(Properties properties)