Package org.infinispan.persistence.rest.configuration

Class RestStoreConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder

org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>

org.infinispan.persistence.rest.configuration.RestStoreConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<RestStoreConfiguration>, ConfigurationBuilderInfo, Self<RestStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>, StoreConfigurationChildBuilder<RestStoreConfigurationBuilder>, RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

public class RestStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>
implements RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>, ConfigurationBuilderInfo

RestStoreConfigurationBuilder. Configures a RestStore

Since:

6.0

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
RestStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
RestStoreConfigurationBuilder	appendCacheNameToPath(boolean appendCacheNameToPath)	Determines whether to append the cache name to the path URI.
AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
ConnectionPoolConfigurationBuilder	connectionPool()	Configures the connection pool
RestStoreConfiguration	create()	Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
java.util.Collection<ConfigurationBuilderInfo>	getChildrenInfo()
ElementDefinition	getElementDefinition()
RestStoreConfigurationBuilder	host(java.lang.String host)	The host to connect to
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
RestStoreConfigurationBuilder	key2StringMapper(java.lang.Class<? extends MarshallingTwoWayKey2StringMapper> klass)	The class of a Key2StringMapper to use for mapping keys to strings suitable for RESTful retrieval/storage.
RestStoreConfigurationBuilder	key2StringMapper(java.lang.String key2StringMapper)	The class name of a Key2StringMapper to use for mapping keys to strings suitable for RESTful retrieval/storage.
LockingConfigurationBuilder	locking()
RestStoreConfigurationBuilder	maxContentLength(int maxContentLength)	Sets the maximum content length.
MemoryConfigurationBuilder	memory()
RestStoreConfigurationBuilder	metadataHelper(java.lang.Class<? extends MetadataHelper> metadataHelper)	The class of a MetadataHelper to use for managing appropriate metadata for the entries Defaults to EmbeddedMetadataHelper
RestStoreConfigurationBuilder	metadataHelper(java.lang.String metadataHelper)	The class name of a MetadataHelper to use for managing appropriate metadata for the entries Defaults to EmbeddedMetadataHelper
RestStoreConfigurationBuilder	path(java.lang.String path)	The path portion of the RESTful service.
PersistenceConfigurationBuilder	persistence()
RestStoreConfigurationBuilder	port(int port)	The port to connect to.
RestStoreConfigurationBuilder	rawValues(boolean rawValues)	Reads/writes "raw" values to the REST server instead of marshalling (used by the rolling upgrades feature)
RestStoreConfigurationBuilder	read(RestStoreConfiguration template)	Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
RestStoreConfigurationBuilder	self()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
ConfigurationChildBuilder	template(boolean template)
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Validate the data in this builder before building the configuration bean

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

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, properties, purgeOnStartup, segmented, shared, toString, transactional, validate, validate, withProperties

Methods inherited from class java.lang.Object

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

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

getBuilderInfo, getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, security, simpleCache, simpleCache, sites, 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, withProperties

Field Detail

builder

protected final ConfigurationBuilder builder

Constructor Detail

RestStoreConfigurationBuilder

public RestStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Method Detail

getElementDefinition

public ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Overrides:

attributes in class AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>

Returns:

the AttributeSet declared by the configuration.

getChildrenInfo

public java.util.Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Overrides:

getChildrenInfo in class AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

self

public RestStoreConfigurationBuilder self()

Specified by:

self in interface Self<RestStoreConfigurationBuilder>

connectionPool

public ConnectionPoolConfigurationBuilder connectionPool()

Description copied from interface: RestStoreConfigurationChildBuilder

Configures the connection pool

Specified by:

connectionPool in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

host

public RestStoreConfigurationBuilder host(java.lang.String host)

Description copied from interface: RestStoreConfigurationChildBuilder

The host to connect to

Specified by:

host in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

key2StringMapper

public RestStoreConfigurationBuilder key2StringMapper(java.lang.String key2StringMapper)

Description copied from interface: RestStoreConfigurationChildBuilder

The class name of a Key2StringMapper to use for mapping keys to strings suitable for RESTful retrieval/storage. Defaults to WrappedByteArrayOrPrimitiveMapper

Specified by:

key2StringMapper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

key2StringMapper

public RestStoreConfigurationBuilder key2StringMapper(java.lang.Class<? extends MarshallingTwoWayKey2StringMapper> klass)

Description copied from interface: RestStoreConfigurationChildBuilder

The class of a Key2StringMapper to use for mapping keys to strings suitable for RESTful retrieval/storage. Defaults to WrappedByteArrayOrPrimitiveMapper

Specified by:

key2StringMapper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

metadataHelper

public RestStoreConfigurationBuilder metadataHelper(java.lang.String metadataHelper)

Description copied from interface: RestStoreConfigurationChildBuilder

The class name of a MetadataHelper to use for managing appropriate metadata for the entries Defaults to EmbeddedMetadataHelper

Specified by:

metadataHelper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

metadataHelper

public RestStoreConfigurationBuilder metadataHelper(java.lang.Class<? extends MetadataHelper> metadataHelper)

Description copied from interface: RestStoreConfigurationChildBuilder

The class of a MetadataHelper to use for managing appropriate metadata for the entries Defaults to EmbeddedMetadataHelper

Specified by:

metadataHelper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

path

public RestStoreConfigurationBuilder path(java.lang.String path)

Description copied from interface: RestStoreConfigurationChildBuilder

The path portion of the RESTful service. Defaults to /

Specified by:

path in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

port

public RestStoreConfigurationBuilder port(int port)

Description copied from interface: RestStoreConfigurationChildBuilder

The port to connect to. Defaults to 80

Specified by:

port in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

appendCacheNameToPath

public RestStoreConfigurationBuilder appendCacheNameToPath(boolean appendCacheNameToPath)

Description copied from interface: RestStoreConfigurationChildBuilder

Determines whether to append the cache name to the path URI. Defaults to false.

Specified by:

appendCacheNameToPath in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

rawValues

public RestStoreConfigurationBuilder rawValues(boolean rawValues)

Description copied from interface: RestStoreConfigurationChildBuilder

Reads/writes "raw" values to the REST server instead of marshalling (used by the rolling upgrades feature)

Specified by:

rawValues in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

maxContentLength

public RestStoreConfigurationBuilder maxContentLength(int maxContentLength)

Description copied from interface: RestStoreConfigurationChildBuilder

Sets the maximum content length. Defaults to 10M.

Specified by:

maxContentLength in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>

create

public RestStoreConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<RestStoreConfiguration>

Returns:

read

public RestStoreConfigurationBuilder read(RestStoreConfiguration 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<RestStoreConfiguration>

Overrides:

read in class AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>

Parameters:

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

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

Overrides:

validate in class AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

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 interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

jmxStatistics

public JMXStatisticsConfigurationBuilder jmxStatistics()

Specified by:

jmxStatistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder