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 Details

  • Method Details

    • properties

      @Deprecated(forRemoval=true) public TypedProperties properties()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 12.0, indexing behaviour is defined by writer() and reader().

      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.

      See Also:

    • index

      @Deprecated(forRemoval=true) public Index index()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 11. This configuration will be removed in next major version as the index mode is calculated automatically.
      Returns the indexing mode of this cache.

    • enabled

      public boolean enabled()
      Determines if indexing is enabled for this cache configuration.

    • autoConfig

      @Deprecated(forRemoval=true) public boolean autoConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 11.0, with no replacement.
      Determines if autoconfig is enabled for this IndexingConfiguration.

    • storage

      public IndexStorage storage()

    • startupMode

      public IndexStartupMode startupMode()

    • path

      public String path()

    • 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.

    • indexedEntities

      @Deprecated(forRemoval=true) public Set<Class<?>> indexedEntities()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 11. Usages should be converted to indexedEntityTypes() as this method will be removed in next major version.
      The subset of indexed entity classes. This does not include the protobuf types. For the entire set of types use indexedEntityTypes().

    • 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) 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()

    • 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>