Package org.infinispan.configuration.cache

Class IndexingConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.IndexingConfigurationBuilder

All Implemented Interfaces:

org.infinispan.commons.configuration.BaseConfigurationInfo, org.infinispan.commons.configuration.Builder<IndexingConfiguration>, org.infinispan.commons.configuration.ConfigurationBuilderInfo, ConfigurationChildBuilder

public class IndexingConfigurationBuilder
extends Object
implements org.infinispan.commons.configuration.Builder<IndexingConfiguration>, org.infinispan.commons.configuration.ConfigurationBuilderInfo

Configures indexing of entries in the cache for searching.

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
IndexingConfigurationBuilder	addIndexedEntities(Class<?>... indexedEntities)
IndexingConfigurationBuilder	addIndexedEntities(String... indexedEntities)
IndexingConfigurationBuilder	addIndexedEntity(Class<?> indexedEntity)
IndexingConfigurationBuilder	addIndexedEntity(String indexedEntity)
IndexingConfigurationBuilder	addKeyTransformer(Class<?> keyClass, Class<?> keyTransformerClass)	Registers a transformer for a key class.
IndexingConfigurationBuilder	addProperty(String key, String value)	Defines a single property.
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
boolean	autoConfig()	Deprecated. Since 11.0, with no replacement.
IndexingConfigurationBuilder	autoConfig(boolean autoConfig)	Deprecated. Since 11.0 with no replacement.
Configuration	build()
ClusteringConfigurationBuilder	clustering()
IndexingConfiguration	create()
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
IndexingConfigurationBuilder	disable()
IndexingConfigurationBuilder	enable()
boolean	enabled()
IndexingConfigurationBuilder	enabled(boolean enabled)
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
org.infinispan.commons.configuration.elements.ElementDefinition	getElementDefinition()
IndexingConfigurationBuilder	index(Index index)	Deprecated. Since 11.0.
Set<String>	indexedEntities()	The set of fully qualified names of indexed entity types, either Java classes or protobuf type names.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
IndexingConfigurationBuilder	read(IndexingConfiguration template)
SecurityConfigurationBuilder	security()
IndexingConfigurationBuilder	setProperty(String key, Object value)	Defines a single value.
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()
void	validate(GlobalConfiguration globalConfig)
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

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

getBuilderInfo, getChildrenInfo, getNewBuilderInfo

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

jmxStatistics

Field Detail

builder

protected final ConfigurationBuilder builder

Method Detail

enabled

public IndexingConfigurationBuilder enabled(boolean enabled)

enable

public IndexingConfigurationBuilder enable()

disable

public IndexingConfigurationBuilder disable()

enabled

public boolean enabled()

addKeyTransformer

public IndexingConfigurationBuilder addKeyTransformer(Class<?> keyClass,
                                                      Class<?> keyTransformerClass)

Registers a transformer for a key class.

Parameters:

keyClass - the class of the key

keyTransformerClass - the class of the org.infinispan.query.Transformer that handles this key type

Returns:

this, for method chaining

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

index

@Deprecated
public IndexingConfigurationBuilder index(Index index)

Deprecated.

Since 11.0. This configuration will be removed in next major version as the index mode is calculated automatically.

Indicates indexing mode

autoConfig

@Deprecated
public IndexingConfigurationBuilder autoConfig(boolean autoConfig)

Deprecated.

Since 11.0 with no replacement.

When enabled, applies to properties default configurations based on the cache type

Parameters:

autoConfig - boolean

Returns:

this, for method chaining

autoConfig

@Deprecated
public boolean autoConfig()

Deprecated.

Since 11.0, with no replacement.

addIndexedEntity

public IndexingConfigurationBuilder addIndexedEntity(String indexedEntity)

addIndexedEntities

public IndexingConfigurationBuilder addIndexedEntities(String... indexedEntities)

addIndexedEntity

public IndexingConfigurationBuilder addIndexedEntity(Class<?> indexedEntity)

addIndexedEntities

public IndexingConfigurationBuilder addIndexedEntities(Class<?>... indexedEntities)

indexedEntities

public Set<String> indexedEntities()

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.

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<IndexingConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public IndexingConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<IndexingConfiguration>

read

public IndexingConfigurationBuilder read(IndexingConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<IndexingConfiguration>

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface org.infinispan.commons.configuration.BaseConfigurationInfo

toString

public String toString()

Overrides:

toString in class Object

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface org.infinispan.commons.configuration.BaseConfigurationInfo

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

@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics 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

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder