Package org.infinispan.configuration.cache

Class IndexingConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.IndexingConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<IndexingConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder, IndexingConfigurationChildBuilder

public class IndexingConfigurationBuilder
extends Object
implements IndexingConfigurationChildBuilder, Builder<IndexingConfiguration>, 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)	Deprecated. Since 12.0, please use writer() and reader() to define indexing behavior.
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()	Create the configuration bean
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()
Collection<ConfigurationBuilderInfo>	getChildrenInfo()
org.infinispan.commons.configuration.elements.ElementDefinition<IndexingConfiguration>	getElementDefinition()
IndexingConfigurationBuilder	index(Index index)	Deprecated. Since 11.0.
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
IndexingConfigurationBuilder	path(String path)
PersistenceConfigurationBuilder	persistence()
IndexingConfigurationBuilder	read(IndexingConfiguration template)	Reads the configuration from an already created configuration bean into this builder.
IndexReaderConfigurationBuilder	reader()
void	reset()	Wipe out all indexing configuration settings and disable indexing.
SecurityConfigurationBuilder	security()
IndexingConfigurationBuilder	setProperty(String key, Object value)	Deprecated. Since 12.0, please writer() and reader() to define indexing behavior.
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
IndexingConfigurationBuilder	storage(IndexStorage storage)
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)
IndexingConfigurationBuilder	withProperties(Properties props)	Deprecated. Since 12.0, please writer() and reader() to define indexing behavior.
IndexWriterConfigurationBuilder	writer()

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

getBuilderInfo, getNewBuilderInfo

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

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

Field Detail

builder

protected final ConfigurationBuilder builder

Method Detail

getChildrenInfo

public Collection<ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface ConfigurationBuilderInfo

Returns:

a collection of ConfigurationBuilderInfo for the sub-elements of the builder.

enabled

public IndexingConfigurationBuilder enabled(boolean enabled)

reader

public IndexReaderConfigurationBuilder reader()

Specified by:

reader in interface IndexingConfigurationChildBuilder

writer

public IndexWriterConfigurationBuilder writer()

Specified by:

writer in interface IndexingConfigurationChildBuilder

reset

public void reset()

Wipe out all indexing configuration settings and disable indexing.

enable

public IndexingConfigurationBuilder enable()

Specified by:

enable in interface IndexingConfigurationChildBuilder

disable

public IndexingConfigurationBuilder disable()

Specified by:

disable in interface IndexingConfigurationChildBuilder

enabled

public boolean enabled()

path

public IndexingConfigurationBuilder path(String path)

Specified by:

path in interface IndexingConfigurationChildBuilder

storage

public IndexingConfigurationBuilder storage(IndexStorage storage)

Specified by:

storage in interface IndexingConfigurationChildBuilder

addKeyTransformer

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

Registers a transformer for a key class.

Specified by:

addKeyTransformer in interface IndexingConfigurationChildBuilder

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

@Deprecated
public IndexingConfigurationBuilder addProperty(String key,
                                                String value)

Deprecated.

Since 12.0, please use writer() and reader() to define indexing behavior.

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

@Deprecated
public IndexingConfigurationBuilder setProperty(String key,
                                                Object value)

Deprecated.

Since 12.0, please writer() and reader() to define indexing behavior.

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

@Deprecated
public IndexingConfigurationBuilder withProperties(Properties props)

Deprecated.

Since 12.0, please writer() and reader() to define indexing behavior.

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)

Specified by:

addIndexedEntity in interface IndexingConfigurationChildBuilder

addIndexedEntities

public IndexingConfigurationBuilder addIndexedEntities(String... indexedEntities)

Specified by:

addIndexedEntities in interface IndexingConfigurationChildBuilder

addIndexedEntity

public IndexingConfigurationBuilder addIndexedEntity(Class<?> indexedEntity)

Specified by:

addIndexedEntity in interface IndexingConfigurationChildBuilder

addIndexedEntities

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

Specified by:

addIndexedEntities in interface IndexingConfigurationChildBuilder

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>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

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.

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition<IndexingConfiguration> getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

toString

public String toString()

attributes

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

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

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