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>
    AUTO_CONFIG
    Deprecated.
    since 11.0
    static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean>
    ENABLED
     
    static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Index>
    INDEX
    Deprecated.
    since 11.0
    static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Set<String>>
    INDEXED_ENTITIES
     
    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
    autoConfig()
    Deprecated.
    Since 11.0, with no replacement.
    boolean
    enabled()
    Determines if indexing is enabled for this cache configuration.
    Index
    index()
    Deprecated.
    Since 11.
    Set<Class<?>>
    indexedEntities()
    Deprecated.
    since 11.
    Set<String>
    indexedEntityTypes()
    The set of fully qualified names of indexed entity types, either Java classes or protobuf type names.
    final boolean
    indexShareable()
    Deprecated.
    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()
     
    org.infinispan.commons.util.TypedProperties
    properties()
    Deprecated.
    Since 12.0, indexing behaviour is defined by writer() and reader().
    IndexReaderConfiguration
    reader()
     
    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

    • INDEX

      @Deprecated public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Index> INDEX
      Deprecated.
      since 11.0

    • ENABLED

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

    • AUTO_CONFIG

      @Deprecated public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> AUTO_CONFIG
      Deprecated.
      since 11.0

    • 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

  • Method Details

    • properties

      @Deprecated public org.infinispan.commons.util.TypedProperties properties()
      Deprecated.
      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 public Index index()
      Deprecated.
      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 public boolean autoConfig()
      Deprecated.
      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 public Set<Class<?>> indexedEntities()
      Deprecated.
      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 public final boolean indexShareable()
      Deprecated.
      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 org.infinispan.commons.configuration.attributes.ConfigurationElement<IndexingConfiguration>