RestStoreConfigurationBuilder (Infinispan JavaDoc 8.0.2.Final API)

java.lang.Object
- org.infinispan.configuration.cache.AbstractPersistenceConfigurationChildBuilder
- - org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>
  - - org.infinispan.persistence.rest.configuration.RestStoreConfigurationBuilder

All Implemented Interfaces:

Builder<RestStoreConfiguration>, Self<RestStoreConfigurationBuilder>, ConfigurationChildBuilder, PersistenceConfigurationChildBuilder, StoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>, StoreConfigurationChildBuilder<RestStoreConfigurationBuilder>, RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>
```
public class RestStoreConfigurationBuilder
extends AbstractStoreConfigurationBuilder<RestStoreConfiguration,RestStoreConfigurationBuilder>
implements RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>
```
RestStoreConfigurationBuilder. Configures a RestStore

Since:

6.0

Author:

Tristan Tarrant

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder
- Fields inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder
  async, attributes, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singletonStore

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Constructor Summary

Constructors
Constructor and Description

RestStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)

Constructors
Constructor and Description
`RestStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RestStoreConfigurationBuilder`	`appendCacheNameToPath(boolean appendCacheNameToPath)` Determines whether to append the cache name to the path URI.
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`ConnectionPoolConfigurationBuilder`	`connectionPool()` Configures the connection pool
`RestStoreConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`RestStoreConfigurationBuilder`	`host(String host)` The host to connect to
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`RestStoreConfigurationBuilder`	`key2StringMapper(Class<? extends MarshallingTwoWayKey2StringMapper> klass)` The class of a `Key2StringMapper` to use for mapping keys to strings suitable for RESTful retrieval/storage.
`RestStoreConfigurationBuilder`	`key2StringMapper(String key2StringMapper)` The class name of a `Key2StringMapper` to use for mapping keys to strings suitable for RESTful retrieval/storage.
`LockingConfigurationBuilder`	`locking()`
`RestStoreConfigurationBuilder`	`metadataHelper(Class<? extends MetadataHelper> metadataHelper)` The class of a `MetadataHelper` to use for managing appropriate metadata for the entries Defaults to `EmbeddedMetadataHelper`
`RestStoreConfigurationBuilder`	`metadataHelper(String metadataHelper)` The class name of a `MetadataHelper` to use for managing appropriate metadata for the entries Defaults to `EmbeddedMetadataHelper`
`RestStoreConfigurationBuilder`	`path(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()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`ConfigurationChildBuilder`	`template(boolean template)`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`VersioningConfigurationBuilder`	`versioning()`

Methods inherited from class org.infinispan.configuration.cache.AbstractStoreConfigurationBuilder
addProperty, async, fetchPersistentState, ignoreModifications, preload, properties, purgeOnStartup, shared, singleton, toString, 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.configuration.cache.StoreConfigurationChildBuilder
addProperty, async, fetchPersistentState, ignoreModifications, preload, purgeOnStartup, shared, singleton, withProperties

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, compatibility, customInterceptors, dataContainer, deadlockDetection, eviction, expiration, indexing, invocationBatching, jmxStatistics, locking, persistence, security, simpleCache, simpleCache, sites, storeAsBinary, template, transaction, unsafe, validate, versioning

Methods inherited from interface org.infinispan.configuration.cache.PersistenceConfigurationChildBuilder
persistence

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - RestStoreConfigurationBuilder
```
public RestStoreConfigurationBuilder(PersistenceConfigurationBuilder builder)
```
- Method Detail
  - 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(String host)
```
    Description copied from interface: RestStoreConfigurationChildBuilder
    
    The host to connect to
    
    Specified by:
    
    host in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>
  - key2StringMapper
```
public RestStoreConfigurationBuilder key2StringMapper(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 MarshalledValueOrPrimitiveMapper
    
    Specified by:
    
    key2StringMapper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>
  - key2StringMapper
```
public RestStoreConfigurationBuilder key2StringMapper(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 MarshalledValueOrPrimitiveMapper
    
    Specified by:
    
    key2StringMapper in interface RestStoreConfigurationChildBuilder<RestStoreConfigurationBuilder>
  - metadataHelper
```
public RestStoreConfigurationBuilder metadataHelper(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(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(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>
  - 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
```
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - dataContainer
```
public DataContainerConfigurationBuilder dataContainer()
```
    Specified by:
    
    dataContainer in interface ConfigurationChildBuilder
  - deadlockDetection
```
public DeadlockDetectionConfigurationBuilder deadlockDetection()
```
    Specified by:
    
    deadlockDetection in interface ConfigurationChildBuilder
  - eviction
```
public EvictionConfigurationBuilder eviction()
```
    Specified by:
    
    eviction 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
  - storeAsBinary
```
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Specified by:
    
    storeAsBinary in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - versioning
```
public VersioningConfigurationBuilder versioning()
```
    Specified by:
    
    versioning in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class RestStoreConfigurationBuilder

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

builder

Constructor Detail

RestStoreConfigurationBuilder

Method Detail

self

connectionPool

host

key2StringMapper

key2StringMapper

metadataHelper

metadataHelper

path

port

appendCacheNameToPath

rawValues

create

read

validate

template

simpleCache

simpleCache

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build