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:

Matchable<IndexingConfiguration>, Updatable<IndexingConfiguration>

public class IndexingConfiguration
extends ConfigurationElement<IndexingConfiguration>

Configures indexing of entries in the cache for searching.

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<Boolean>	ENABLED
static final AttributeDefinition<Set<String>>	INDEXED_ENTITIES
static final AttributeDefinition<IndexingMode>	INDEXING_MODE
static final AttributeDefinition<Map<Class<?>,Class<?>>>	KEY_TRANSFORMERS
static final AttributeDefinition<String>	PATH
static final AttributeDefinition<IndexStartupMode>	STARTUP_MODE
static final AttributeDefinition<IndexStorage>	STORAGE
static final AttributeDefinition<Boolean>	USE_JAVA_EMBEDDED_ENTITIES

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()
boolean	useJavaEmbeddedEntities()	Whether true, the indexes will be defined on the Java indexed entities accessible from the class path of the server VM.
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 AttributeDefinition<Boolean> ENABLED

KEY_TRANSFORMERS

public static final AttributeDefinition<Map<Class<?>,Class<?>>> KEY_TRANSFORMERS

INDEXED_ENTITIES

public static final AttributeDefinition<Set<String>> INDEXED_ENTITIES

STORAGE

public static final AttributeDefinition<IndexStorage> STORAGE

STARTUP_MODE

public static final AttributeDefinition<IndexStartupMode> STARTUP_MODE

PATH

public static final AttributeDefinition<String> PATH

INDEXING_MODE

public static final AttributeDefinition<IndexingMode> INDEXING_MODE

USE_JAVA_EMBEDDED_ENTITIES

public static final AttributeDefinition<Boolean> USE_JAVA_EMBEDDED_ENTITIES

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

useJavaEmbeddedEntities

public boolean useJavaEmbeddedEntities()

Whether true, the indexes will be defined on the Java indexed entities accessible from the class path of the server VM. Even if the cache is Protobuf encoded and the indexes are run in server mode.

Useful in case we want to run embedded queries from a server task, in the case the cache is Protobuf encoded. By default, false.

Returns:

useJavaEmbeddedEntities

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 ConfigurationElement<IndexingConfiguration>