org.infinispan.config
Class Configuration.QueryConfigurationBean

java.lang.Object
  org.infinispan.config.AbstractConfigurationBean
      org.infinispan.config.AbstractNamedCacheConfigurationBean
          org.infinispan.config.Configuration.QueryConfigurationBean

All Implemented Interfaces:

Serializable, Cloneable, CloneableConfigurationComponent, FluentConfiguration.IndexingConfig, JAXBUnmarshallable

Enclosing class:

Configuration

public static class Configuration.QueryConfigurationBean
extends AbstractNamedCacheConfigurationBean
implements FluentConfiguration.IndexingConfig

Configures indexing of entries in the cache for searching. Note that infinispan-query.jar and its dependencies needs to be available if this option is to be used.

See Also:

Configuration reference, Serialized Form

Field Summary

protected Boolean	enabled
protected Boolean	indexLocalOnly
protected TypedProperties	properties

Fields inherited from class org.infinispan.config.AbstractNamedCacheConfigurationBean

cr

Fields inherited from class org.infinispan.config.AbstractConfigurationBean

overriddenConfigurationElements

Constructor Summary

Configuration.QueryConfigurationBean()

Method Summary

void	accept(ConfigurationBeanVisitor v)
FluentConfiguration.IndexingConfig	addProperty(String key, String value) Defines a single property.
FluentConfiguration.AsyncConfig	async()
Configuration	build()
Configuration	build()
FluentConfiguration.TransactionConfig	cacheStopTimeout(Integer cacheStopTimeout)
Configuration.QueryConfigurationBean	clone()
FluentConfiguration.ClusteringConfig	clustering()
FluentConfiguration.ClusteringConfig	clustering()
FluentConfiguration.CustomInterceptorsConfig	customInterceptors()
FluentConfiguration.CustomInterceptorsConfig	customInterceptors()
FluentConfiguration.DataContainerConfig	dataContainer()
FluentConfiguration.DataContainerConfig	dataContainer()
FluentConfiguration.DeadlockDetectionConfig	deadlockDetection() This method allows configuration of the deadlock detection.
FluentConfiguration.DeadlockDetectionConfig	deadlockDetection() This method allows configuration of the deadlock detection.
FluentConfiguration.IndexingConfig	disable() Indexing is disabled by default, but using the fluent API entering the FluentTypes.indexing() method enables Indexing implicitly.
FluentConfiguration.TransactionConfig	eagerLockSingleNode(Boolean eagerLockSingleNode)
boolean	equals(Object o)
FluentConfiguration.EvictionConfig	eviction()
FluentConfiguration.EvictionConfig	eviction()
FluentConfiguration.ExpirationConfig	expiration()
FluentConfiguration.ExpirationConfig	expiration()
protected boolean	hasComponentStarted() Tests whether the component this configuration bean intents to configure has already started.
FluentConfiguration.HashConfig	hash()
int	hashCode()
FluentConfiguration.IndexingConfig	indexing() This method allows configuration of the indexing subsystem.
FluentConfiguration.IndexingConfig	indexing() This method allows configuration of the indexing subsystem.
FluentConfiguration.IndexingConfig	indexLocalOnly(Boolean indexLocalOnly) If true, only index changes made locally, ignoring remote changes.
FluentConfiguration.InvocationBatchingConfig	invocationBatching() This method allows configuration of invocation batching.
FluentConfiguration.InvocationBatchingConfig	invocationBatching() This method allows configuration of invocation batching.
Boolean	isEnabled()
Boolean	isIndexLocalOnly()
FluentConfiguration.JmxStatisticsConfig	jmxStatistics() This method allows configuration of jmx statistics.
FluentConfiguration.JmxStatisticsConfig	jmxStatistics() This method allows configuration of jmx statistics.
FluentConfiguration.L1Config	l1()
FluentConfiguration.LoadersConfig	loaders()
FluentConfiguration.LoadersConfig	loaders()
FluentConfiguration.LockingConfig	locking()
FluentConfiguration.LockingConfig	locking()
FluentConfiguration.ClusteringConfig	mode(Configuration.CacheMode mode)
FluentConfiguration.RecoveryConfig	recovery()
protected Configuration.QueryConfigurationBean	setConfiguration(Configuration config)
void	setEnabled(Boolean enabled) Deprecated. The visibility will be reduced
void	setIndexLocalOnly(Boolean indexLocalOnly) Deprecated. Use indexLocalOnly(Boolean) instead
FluentConfiguration.StateRetrievalConfig	stateRetrieval()
FluentConfiguration.StoreAsBinaryConfig	storeAsBinary() This method allows configuration of lazy deserialization.
FluentConfiguration.StoreAsBinaryConfig	storeAsBinary() This method allows configuration of lazy deserialization.
FluentConfiguration.SyncConfig	sync()
FluentConfiguration.TransactionConfig	syncCommitPhase(Boolean syncCommitPhase)
FluentConfiguration.TransactionConfig	syncRollbackPhase(Boolean syncRollbackPhase)
String	toString()
FluentConfiguration.TransactionConfig	transaction()
FluentConfiguration.TransactionConfig	transaction()
FluentConfiguration.TransactionConfig	transactionManagerLookup(TransactionManagerLookup transactionManagerLookup)
FluentConfiguration.TransactionConfig	transactionManagerLookupClass(Class<? extends TransactionManagerLookup> transactionManagerLookupClass)
FluentConfiguration.TransactionConfig	transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup transactionSynchronizationRegistryLookup)
FluentConfiguration.UnsafeConfig	unsafe()
FluentConfiguration.UnsafeConfig	unsafe()
FluentConfiguration.TransactionConfig	useEagerLocking(Boolean useEagerLocking)
FluentConfiguration.TransactionConfig	useSynchronization(Boolean useSynchronization)
FluentConfiguration.IndexingConfig	withProperties(Properties properties) The Query engine relies on properties for configuration.

Methods inherited from class org.infinispan.config.AbstractNamedCacheConfigurationBean

inject

Methods inherited from class org.infinispan.config.AbstractConfigurationBean

testImmutability, toTypedProperties, toTypedProperties, uc, willUnmarshall

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

enabled

protected Boolean enabled

indexLocalOnly

protected Boolean indexLocalOnly

properties

protected TypedProperties properties

Constructor Detail

Configuration.QueryConfigurationBean

public Configuration.QueryConfigurationBean()

Method Detail

accept

public void accept(ConfigurationBeanVisitor v)

isEnabled

public Boolean isEnabled()

setEnabled

@Deprecated
public void setEnabled(Boolean enabled)

Deprecated. The visibility will be reduced

isIndexLocalOnly

public Boolean isIndexLocalOnly()

setIndexLocalOnly

@Deprecated
public void setIndexLocalOnly(Boolean indexLocalOnly)

Deprecated. Use indexLocalOnly(Boolean) instead

indexLocalOnly

public FluentConfiguration.IndexingConfig indexLocalOnly(Boolean indexLocalOnly)

Description copied from interface: FluentConfiguration.IndexingConfig

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.

Specified by:

indexLocalOnly in interface FluentConfiguration.IndexingConfig

Returns:

this, for method chaining

withProperties

public FluentConfiguration.IndexingConfig withProperties(Properties properties)

Description copied from interface: FluentConfiguration.IndexingConfig

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.

Specified by:

withProperties in interface FluentConfiguration.IndexingConfig

Returns:

this, for method chaining

See Also:

Hibernate Search

addProperty

public FluentConfiguration.IndexingConfig addProperty(String key,
                                                      String value)

Description copied from interface: FluentConfiguration.IndexingConfig

Defines a single property. Can be used multiple times to define all needed properties, but the full set is overridden by FluentConfiguration.IndexingConfig.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 Hibernate Search reference of the version you're using with Infinispan Query.

Specified by:

addProperty in interface FluentConfiguration.IndexingConfig

Parameters:

key - Property key

value - Property value

Returns:

this, for method chaining

See Also:

Hibernate Search

disable

public FluentConfiguration.IndexingConfig disable()

Description copied from interface: FluentConfiguration.IndexingConfig

Indexing is disabled by default, but using the fluent API entering the FluentTypes.indexing() method enables Indexing implicitly. If needed, this method can be used to disable it.

Specified by:

disable in interface FluentConfiguration.IndexingConfig

Returns:

this, for method chaining

setConfiguration

protected Configuration.QueryConfigurationBean setConfiguration(Configuration config)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasComponentStarted

protected boolean hasComponentStarted()

Description copied from class: AbstractConfigurationBean

Tests whether the component this configuration bean intents to configure has already started.

Overrides:

hasComponentStarted in class AbstractNamedCacheConfigurationBean

Returns:

true if the component has started; false otherwise.

clone

public Configuration.QueryConfigurationBean clone()

Specified by:

clone in interface CloneableConfigurationComponent

Overrides:

clone in class AbstractNamedCacheConfigurationBean

toString

public String toString()

Overrides:

toString in class Object

locking

public FluentConfiguration.LockingConfig locking()

loaders

public FluentConfiguration.LoadersConfig loaders()

transaction

public FluentConfiguration.TransactionConfig transaction()

deadlockDetection

public FluentConfiguration.DeadlockDetectionConfig deadlockDetection()

This method allows configuration of the deadlock detection. When this method is called, it automatically enables deadlock detection. So, if you want it to be disabled, make sure you call FluentConfiguration.DeadlockDetectionConfig.disable()

customInterceptors

public FluentConfiguration.CustomInterceptorsConfig customInterceptors()

eviction

public FluentConfiguration.EvictionConfig eviction()

expiration

public FluentConfiguration.ExpirationConfig expiration()

clustering

public FluentConfiguration.ClusteringConfig clustering()

indexing

public FluentConfiguration.IndexingConfig indexing()

This method allows configuration of the indexing subsystem. When this method is called, it automatically enables indexing. So, if you want it to be disabled, make sure you call FluentConfiguration.IndexingConfig.disable()

dataContainer

public FluentConfiguration.DataContainerConfig dataContainer()

unsafe

public FluentConfiguration.UnsafeConfig unsafe()

jmxStatistics

public FluentConfiguration.JmxStatisticsConfig jmxStatistics()

This method allows configuration of jmx statistics. When this method is called, it automatically enables jmx statistics.

storeAsBinary

public FluentConfiguration.StoreAsBinaryConfig storeAsBinary()

This method allows configuration of lazy deserialization. When this method is called, it automatically enables lazy deserialization.

invocationBatching

public FluentConfiguration.InvocationBatchingConfig invocationBatching()

This method allows configuration of invocation batching. When this method is called, it automatically enables invocation batching.

build

public Configuration build()

locking

public FluentConfiguration.LockingConfig locking()

loaders

public FluentConfiguration.LoadersConfig loaders()

transaction

public FluentConfiguration.TransactionConfig transaction()

deadlockDetection

public FluentConfiguration.DeadlockDetectionConfig deadlockDetection()

This method allows configuration of the deadlock detection. When this method is called, it automatically enables deadlock detection. So, if you want it to be disabled, make sure you call FluentConfiguration.DeadlockDetectionConfig.disable()

customInterceptors

public FluentConfiguration.CustomInterceptorsConfig customInterceptors()

eviction

public FluentConfiguration.EvictionConfig eviction()

expiration

public FluentConfiguration.ExpirationConfig expiration()

clustering

public FluentConfiguration.ClusteringConfig clustering()

indexing

public FluentConfiguration.IndexingConfig indexing()

This method allows configuration of the indexing subsystem. When this method is called, it automatically enables indexing. So, if you want it to be disabled, make sure you call FluentConfiguration.IndexingConfig.disable()

dataContainer

public FluentConfiguration.DataContainerConfig dataContainer()

unsafe

public FluentConfiguration.UnsafeConfig unsafe()

jmxStatistics

public FluentConfiguration.JmxStatisticsConfig jmxStatistics()

This method allows configuration of jmx statistics. When this method is called, it automatically enables jmx statistics.

storeAsBinary

public FluentConfiguration.StoreAsBinaryConfig storeAsBinary()

This method allows configuration of lazy deserialization. When this method is called, it automatically enables lazy deserialization.

invocationBatching

public FluentConfiguration.InvocationBatchingConfig invocationBatching()

This method allows configuration of invocation batching. When this method is called, it automatically enables invocation batching.

async

public FluentConfiguration.AsyncConfig async()

sync

public FluentConfiguration.SyncConfig sync()

stateRetrieval

public FluentConfiguration.StateRetrievalConfig stateRetrieval()

l1

public FluentConfiguration.L1Config l1()

hash

public FluentConfiguration.HashConfig hash()

mode

public FluentConfiguration.ClusteringConfig mode(Configuration.CacheMode mode)

transactionManagerLookupClass

public FluentConfiguration.TransactionConfig transactionManagerLookupClass(Class<? extends TransactionManagerLookup> transactionManagerLookupClass)

transactionManagerLookup

public FluentConfiguration.TransactionConfig transactionManagerLookup(TransactionManagerLookup transactionManagerLookup)

transactionSynchronizationRegistryLookup

public FluentConfiguration.TransactionConfig transactionSynchronizationRegistryLookup(TransactionSynchronizationRegistryLookup transactionSynchronizationRegistryLookup)

syncCommitPhase

public FluentConfiguration.TransactionConfig syncCommitPhase(Boolean syncCommitPhase)

syncRollbackPhase

public FluentConfiguration.TransactionConfig syncRollbackPhase(Boolean syncRollbackPhase)

useEagerLocking

public FluentConfiguration.TransactionConfig useEagerLocking(Boolean useEagerLocking)

eagerLockSingleNode

public FluentConfiguration.TransactionConfig eagerLockSingleNode(Boolean eagerLockSingleNode)

cacheStopTimeout

public FluentConfiguration.TransactionConfig cacheStopTimeout(Integer cacheStopTimeout)

useSynchronization

public FluentConfiguration.TransactionConfig useSynchronization(Boolean useSynchronization)

recovery

public FluentConfiguration.RecoveryConfig recovery()

build

public Configuration build()