IndexingConfigurationBuilder (Infinispan Distribution 6.0.2.Final API)

java.lang.Object
- org.infinispan.configuration.cache.IndexingConfigurationBuilder

All Implemented Interfaces:

Builder<IndexingConfiguration>, ConfigurationChildBuilder
```
public class IndexingConfigurationBuilder
extends Object
implements Builder<IndexingConfiguration>
```
Configures indexing of entries in the cache for searching.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexingConfigurationBuilder`	`addProperty(String key, String value)` Defines a single property.
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`IndexingConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`IndexingConfigurationBuilder`	`disable()` Disable indexing
`IndexingConfigurationBuilder`	`enable()` Enable indexing
`IndexingConfigurationBuilder`	`enabled(boolean enabled)`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`IndexingConfigurationBuilder`	`indexLocalOnly(boolean b)` If true, only index changes made locally, ignoring remote changes.
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LockingConfigurationBuilder`	`locking()`
`PersistenceConfigurationBuilder`	`persistence()`
`IndexingConfigurationBuilder`	`read(IndexingConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`IndexingConfigurationBuilder`	`setProperty(String key, Object value)` Defines a single value.
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`VersioningConfigurationBuilder`	`versioning()`
`IndexingConfigurationBuilder`	`withProperties(Properties props)` The Query engine relies on properties for configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - enable
```
public IndexingConfigurationBuilder enable()
```
    Enable indexing
  - disable
```
public IndexingConfigurationBuilder disable()
```
    Disable indexing
  - enabled
```
public IndexingConfigurationBuilder enabled(boolean enabled)
```
  - indexLocalOnly
```
public IndexingConfigurationBuilder indexLocalOnly(boolean b)
```
    If true, only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.
  - addProperty
```
public IndexingConfigurationBuilder addProperty(String key,
                                                String value)
```
    Defines a single property. Can be used multiple times to define all needed properties, but the full set is overridden by withProperties(Properties).
    
    These properties are passed directly to the embedded Hibernate Search engine, so for the complete and up to date documentation about available properties refer to the the Hibernate Search reference of the version used by Infinispan Query.
    
    Parameters:
    
    key - Property key
    
    value - Property value
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Hibernate Search
  - setProperty
```
public IndexingConfigurationBuilder setProperty(String key,
                                                Object value)
```
    Defines a single value. Can be used multiple times to define all needed property values, but the full set is overridden by withProperties(Properties).
    
    These properties are passed directly to the embedded Hibernate Search engine, so for the complete and up to date documentation about available properties refer to the the Hibernate Search reference of the version used by Infinispan Query.
    
    Parameters:
    
    key - Property key
    
    value - Property value
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Hibernate Search
  - withProperties
```
public IndexingConfigurationBuilder withProperties(Properties props)
```
    The Query engine relies on properties for configuration.
    
    These properties are passed directly to the embedded Hibernate Search engine, so for the complete and up to date documentation about available properties refer to the Hibernate Search reference of the version you're using with Infinispan Query.
    
    Parameters:
    
    props - the properties
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    Hibernate Search
  - 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<IndexingConfiguration>
  - create
```
public IndexingConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<IndexingConfiguration>
    
    Returns:
  - read
```
public IndexingConfigurationBuilder read(IndexingConfiguration 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<IndexingConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - 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 IndexingConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

enable

disable

enabled

indexLocalOnly

addProperty

setProperty

withProperties

validate

create

read

toString

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

getBuilder

build