Package org.infinispan.configuration.cache

Class IndexingConfiguration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<IndexingConfiguration>

org.infinispan.configuration.cache.IndexingConfiguration

All Implemented Interfaces:

org.infinispan.commons.configuration.attributes.Matchable<IndexingConfiguration>, org.infinispan.commons.configuration.attributes.Updatable<IndexingConfiguration>

public class IndexingConfiguration
extends org.infinispan.commons.configuration.attributes.ConfigurationElement<IndexingConfiguration>

Configures indexing of entries in the cache for searching.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean>	ENABLED
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Set<String>>	INDEXED_ENTITIES
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexingMode>	INDEXING_MODE
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Map<Class<?>,Class<?>>>	KEY_TRANSFORMERS
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<String>	PATH
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexStartupMode>	STARTUP_MODE
static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexStorage>	STORAGE

Fields inherited from class org.infinispan.commons.configuration.attributes.ConfigurationElement

attributes, CHILDLESS, children, element, repeated

Method Summary

Modifier and Type	Method	Description
boolean	enabled()	Determines if indexing is enabled for this cache configuration.
Set<String>	indexedEntityTypes()	The set of fully qualified names of indexed entity types, either Java classes or protobuf type names.
IndexingMode	indexingMode()	Affects how cache operations will be propagated to the indexes.
final boolean	indexShareable()	Deprecated, for removal: This API element is subject to removal in a future version. Since 11.0 with no replacement; to be removed in next major version.
boolean	isVolatile()	Does the index use a provider that does not persist upon restart?
Map<Class<?>,Class<?>>	keyTransformers()	The currently configured key transformers.
String	path()
IndexReaderConfiguration	reader()
IndexShardingConfiguration	sharding()
IndexStartupMode	startupMode()
IndexStorage	storage()
String	toString()
IndexWriterConfiguration	writer()

Methods inherited from class org.infinispan.commons.configuration.attributes.ConfigurationElement

attributes, child, children, children, elementName, equals, findAttribute, hashCode, isModified, list, matches, update, validateUpdate, write

Methods inherited from class java.lang.Object

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

Field Details

ENABLED

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> ENABLED

KEY_TRANSFORMERS

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Map<Class<?>,Class<?>>> KEY_TRANSFORMERS

INDEXED_ENTITIES

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Set<String>> INDEXED_ENTITIES

STORAGE

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexStorage> STORAGE

STARTUP_MODE

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexStartupMode> STARTUP_MODE

PATH

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<String> PATH

INDEXING_MODE

public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<IndexingMode> INDEXING_MODE

Method Details

enabled

public boolean enabled()

Determines if indexing is enabled for this cache configuration.

storage

public IndexStorage storage()

startupMode

public IndexStartupMode startupMode()

path

public String path()

indexingMode

public IndexingMode indexingMode()

Affects how cache operations will be propagated to the indexes. By default, IndexingMode.AUTO.

Returns:

If the auto-indexing is enabled

See Also:

• IndexingMode

keyTransformers

public Map<Class<?>,Class<?>> keyTransformers()

The currently configured key transformers.

Returns:

a Map in which the map key is the key class and the value is the Transformer class.

indexedEntityTypes

public Set<String> indexedEntityTypes()

The set of fully qualified names of indexed entity types, either Java classes or protobuf type names. This configuration corresponds to the <indexed-entities> XML configuration element.

indexShareable

@Deprecated(forRemoval=true,
            since="11.0")
public final boolean indexShareable()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 11.0 with no replacement; to be removed in next major version.

Check if the indexes can be shared. Currently no index can be shared, so it always returns false. sharing.

Returns:

always false, starting with version 11.0

reader

public IndexReaderConfiguration reader()

writer

public IndexWriterConfiguration writer()

sharding

public IndexShardingConfiguration sharding()

isVolatile

public boolean isVolatile()

Does the index use a provider that does not persist upon restart?

toString

public String toString()

Overrides:

toString in class org.infinispan.commons.configuration.attributes.ConfigurationElement<IndexingConfiguration>