Package org.infinispan.configuration.cache

Class IndexingConfiguration

  • All Implemented Interfaces:
    org.infinispan.commons.configuration.attributes.Matchable<IndexingConfiguration>
    public class IndexingConfiguration
extends org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration
implements org.infinispan.commons.configuration.attributes.Matchable<IndexingConfiguration>
    Configures indexing of entries in the cache for searching.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Boolean> AUTO_CONFIG  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Index> INDEX  
      static org.infinispan.commons.configuration.attributes.AttributeDefinition<Set<Class<?>>> INDEXED_ENTITIES  

      • Fields inherited from class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration

        attributes, PROPERTIES

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.infinispan.commons.configuration.attributes.AttributeSet attributes()  
      boolean autoConfig()
      Determines if autoconfig is enabled for this IndexingConfiguration
      boolean enabled()
      Deprecated.
      Use index() instead
      Index index()
      Returns the indexing mode of this cache.
      Set<Class<?>> indexedEntities()  
      boolean indexLocalOnly()
      Deprecated.
      Use index() instead
      boolean indexShareable()
      Check if the indexes can be shared.
      org.infinispan.commons.util.TypedProperties 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 Hibernate Search reference of the version you're using with Infinispan Query.
      String toString()  

      • Methods inherited from class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration

        attributeSet, equals, hashCode

      • Methods inherited from interface org.infinispan.commons.configuration.attributes.Matchable

        matches

    • Field Detail

      • INDEX

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Index> INDEX

      • AUTO_CONFIG

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

      • INDEXED_ENTITIES

        public static final org.infinispan.commons.configuration.attributes.AttributeDefinition<Set<Class<?>>> INDEXED_ENTITIES

    • Method Detail

      • enabled

        @Deprecated
public boolean enabled()
        Deprecated.
        Use index() instead
        Whether indexing is enabled. False by default.

      • indexLocalOnly

        @Deprecated
public boolean indexLocalOnly()
        Deprecated.
        Use index() instead
        If true, only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.

      • properties

        public org.infinispan.commons.util.TypedProperties 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 Hibernate Search reference of the version you're using with Infinispan Query.

        Overrides:
        properties in class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration
        See Also:
        Hibernate Search

      • index

        public Index index()
        Returns the indexing mode of this cache.

      • autoConfig

        public boolean autoConfig()
        Determines if autoconfig is enabled for this IndexingConfiguration

      • indexedEntities

        public Set<Class<?>> indexedEntities()

      • attributes

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

      • indexShareable

        public boolean indexShareable()
        Check if the indexes can be shared. Currently only "ram" based indexes don't allow any sort of sharing
        Returns:
        false if the index is ram only and thus not shared

      • toString

        public String toString()
        Overrides:
        toString in class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration