Package org.hibernate.search.mapper.orm.cfg

Class HibernateOrmMapperSettings

java.lang.Object

org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings

public final class HibernateOrmMapperSettings
extends Object

Author:

Emmanuel Bernard, Hardy Ferentschik

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HibernateOrmMapperSettings.AutomaticIndexingRadicals	Deprecated.
static final class	HibernateOrmMapperSettings.CoordinationRadicals	Configuration property keys without the prefix + HibernateOrmMapperSettings.Radicals.COORDINATION_PREFIX.
static final class	HibernateOrmMapperSettings.Defaults	Default values for the different settings if no values are given.
static final class	HibernateOrmMapperSettings.IndexingRadicals	Configuration property keys without the prefix + HibernateOrmMapperSettings.Radicals.INDEXING_PREFIX.
static final class	HibernateOrmMapperSettings.MultiTenancyRadicals	Configuration property keys without the prefix + HibernateOrmMapperSettings.Radicals.MULTI_TENANCY_PREFIX.
static final class	HibernateOrmMapperSettings.Radicals	Configuration property keys without the prefix.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK	Deprecated. This setting will be removed in a future version.
static final String	AUTOMATIC_INDEXING_ENABLED	Deprecated. Use INDEXING_LISTENERS_ENABLED instead.
static final String	AUTOMATIC_INDEXING_STRATEGY	Deprecated. Use INDEXING_LISTENERS_ENABLED instead (caution: it expects a boolean value).
static final String	AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY	Deprecated. Use INDEXING_PLAN_SYNCHRONIZATION_STRATEGY instead.
static final String	COORDINATION	The root property for properties related to coordination.
static final String	COORDINATION_STRATEGY	How to coordinate between nodes of a distributed application.
static final String	ENABLED	Whether Hibernate Search is enabled or disabled.
static final String	INDEXING_LISTENERS_ENABLED	Whether Hibernate ORM listeners that detect entity changes and automatically trigger indexing operations are enabled.
static final String	INDEXING_MASS_DEFAULT_CLEAN_OPERATION	The default index cleaning operation to apply during mass indexing, unless configured explicitly.
static final String	INDEXING_PLAN_SYNCHRONIZATION_STRATEGY	How to synchronize between application threads and indexing triggered by the SearchIndexingPlan.
static final String	MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES	When annotation processing is enabled (the default), whether Hibernate Search should automatically build Jandex indexes for types registered for annotation processing (entities in particular), to ensure that all "root mapping" annotations in those JARs (e.g.
static final String	MAPPING_CONFIGURER	A configurer for the Hibernate Search mapping.
static final String	MAPPING_DISCOVER_ANNOTATED_TYPES_FROM_ROOT_MAPPING_ANNOTATIONS	When annotation processing is enabled (the default), whether Hibernate Search should automatically discover annotated types present in the Jandex index that are also annotated with root mapping annotations.
static final String	MAPPING_PROCESS_ANNOTATIONS	Whether annotations should be automatically processed for entity types, as well as nested types in those entity types, for instance index-embedded types.
static final String	MULTI_TENANCY_TENANT_IDENTIFIER_CONVERTER	How to convert tenant identifier to and form the string representation.
static final String	MULTI_TENANCY_TENANT_IDS	An exhaustive list of all tenant identifiers that can be used by the application when multi-tenancy is enabled.
static final String	PREFIX	The prefix expected for the key of every Hibernate Search configuration property when using the Hibernate ORM mapper.
static final String	QUERY_LOADING_CACHE_LOOKUP_STRATEGY	How to look up entities in the second-level cache when loading entities for a search query.
static final String	QUERY_LOADING_FETCH_SIZE	How many entities to load per database query when loading entities for a search query.
static final String	SCHEMA_MANAGEMENT_STRATEGY	How indexes and their schema are created, updated, validated or dropped on startup and shutdown.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

The prefix expected for the key of every Hibernate Search configuration property when using the Hibernate ORM mapper.

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

Whether Hibernate Search is enabled or disabled.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.ENABLED.

See Also:

• Constant Field Values

AUTOMATIC_INDEXING_ENABLED

@Deprecated
public static final String AUTOMATIC_INDEXING_ENABLED

Deprecated.

Use INDEXING_LISTENERS_ENABLED instead.

Whether listener-triggered indexing is enabled, i.e. whether changes to entities in a Hibernate ORM session are detected automatically and lead to reindexing.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_ENABLED.

See Also:

• Constant Field Values

AUTOMATIC_INDEXING_STRATEGY

@Deprecated
public static final String AUTOMATIC_INDEXING_STRATEGY

Deprecated.

Use INDEXING_LISTENERS_ENABLED instead (caution: it expects a boolean value).

How to enable or disable listener-triggered indexing.

Expects a AutomaticIndexingStrategyName value, or a String representation of such value.

Defaults to HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_STRATEGY.

See Also:

• Constant Field Values

AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY

@Deprecated
public static final String AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY

Deprecated.

Use INDEXING_PLAN_SYNCHRONIZATION_STRATEGY instead.

How to synchronize between application threads and indexing triggered by the SearchIndexingPlan.

Expects one of the strings defined in AutomaticIndexingSynchronizationStrategyNames, or a reference to a bean of type AutomaticIndexingSynchronizationStrategy.

Defaults to HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY.

See Also:

• AutomaticIndexingSynchronizationStrategyNames
• The core documentation of configuration properties, which includes a description of the "bean reference" properties and accepted values.
• Constant Field Values

AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK

@Deprecated
public static final String AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK

Deprecated.

This setting will be removed in a future version. There will be no alternative provided to replace it. After the removal of this property in a future version, a dirty check will always be performed when considering whether to trigger reindexing.

Whether to check if dirty properties are relevant to indexing before actually reindexing an entity.

When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing. This feature is considered safe and thus enabled by default.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_ENABLE_DIRTY_CHECK.

See Also:

• Constant Field Values

QUERY_LOADING_CACHE_LOOKUP_STRATEGY

public static final String QUERY_LOADING_CACHE_LOOKUP_STRATEGY

How to look up entities in the second-level cache when loading entities for a search query.

Expects a EntityLoadingCacheLookupStrategy value, or a String representation of such value.

Defaults to HibernateOrmMapperSettings.Defaults.QUERY_LOADING_CACHE_LOOKUP_STRATEGY.

See Also:

• EntityLoadingCacheLookupStrategy
• Constant Field Values

QUERY_LOADING_FETCH_SIZE

public static final String QUERY_LOADING_FETCH_SIZE

How many entities to load per database query when loading entities for a search query.

Expects a strictly positive Integer value, such as 100, or a String that can be parsed into such Integer value.

Defaults to HibernateOrmMapperSettings.Defaults.QUERY_LOADING_FETCH_SIZE.

See Also:

• Constant Field Values

MAPPING_PROCESS_ANNOTATIONS

public static final String MAPPING_PROCESS_ANNOTATIONS

Whether annotations should be automatically processed for entity types, as well as nested types in those entity types, for instance index-embedded types.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.MAPPING_PROCESS_ANNOTATIONS.

See Also:

• Constant Field Values

MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES

public static final String MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES

When annotation processing is enabled (the default), whether Hibernate Search should automatically build Jandex indexes for types registered for annotation processing (entities in particular), to ensure that all "root mapping" annotations in those JARs (e.g. ProjectionConstructor) are taken into account.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES.

See Also:

• AnnotationMappingConfigurationContext.buildMissingDiscoveredJandexIndexes(boolean)
• Constant Field Values

MAPPING_DISCOVER_ANNOTATED_TYPES_FROM_ROOT_MAPPING_ANNOTATIONS

public static final String MAPPING_DISCOVER_ANNOTATED_TYPES_FROM_ROOT_MAPPING_ANNOTATIONS

When annotation processing is enabled (the default), whether Hibernate Search should automatically discover annotated types present in the Jandex index that are also annotated with root mapping annotations.

When enabled, if an annotation meta-annotated with RootMapping is found in the Jandex index, and a type annotated with that annotation (e.g. SearchEntity or ProjectionConstructor) is found in the Jandex index, then that type will automatically be scanned for mapping annotations, even if the type wasn't explicitly added.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.MAPPING_DISCOVER_ANNOTATED_TYPES_FROM_ROOT_MAPPING_ANNOTATIONS.

See Also:

• AnnotationMappingConfigurationContext.discoverAnnotatedTypesFromRootMappingAnnotations(boolean)
• Constant Field Values

MAPPING_CONFIGURER

public static final String MAPPING_CONFIGURER

A configurer for the Hibernate Search mapping.

Expects a single-valued or multi-valued reference to beans of type HibernateOrmSearchMappingConfigurer.

Defaults to no value.

See Also:

• The core documentation of configuration properties, which includes a description of the "multi-valued bean reference" properties and accepted values.
• Constant Field Values

SCHEMA_MANAGEMENT_STRATEGY

public static final String SCHEMA_MANAGEMENT_STRATEGY

How indexes and their schema are created, updated, validated or dropped on startup and shutdown.

Expects a SchemaManagementStrategyName value, or a String representation of such value.

Defaults to HibernateOrmMapperSettings.Defaults.SCHEMA_MANAGEMENT_STRATEGY.

See Also:

• SchemaManagementStrategyName
• Constant Field Values

COORDINATION

public static final String COORDINATION

The root property for properties related to coordination.

See Also:

• Constant Field Values

COORDINATION_STRATEGY

public static final String COORDINATION_STRATEGY

How to coordinate between nodes of a distributed application.

Expects a reference to a coordination strategy; see the reference documentation for available strategies and the relevant Maven dependencies.

Defaults to HibernateOrmMapperSettings.Defaults.COORDINATION_STRATEGY.

See Also:

• Constant Field Values

MULTI_TENANCY_TENANT_IDS

public static final String MULTI_TENANCY_TENANT_IDS

An exhaustive list of all tenant identifiers that can be used by the application when multi-tenancy is enabled.

Expects either a String representing multiple tenant IDs separated by commas, or a Collection<String> containing tenant IDs.

No default; this property may have to be set explicitly depending on the coordination strategy.

See Also:

• Constant Field Values

MULTI_TENANCY_TENANT_IDENTIFIER_CONVERTER

public static final String MULTI_TENANCY_TENANT_IDENTIFIER_CONVERTER

How to convert tenant identifier to and form the string representation.

Converts a tenant identifier to a string representation to be written to the index, and converts to its object representation from a string when a new Hibernate ORM session must be opened.

When multi-tenancy is enabled, and non-string tenant identifiers are used a custom converter must be provided through this property.

Defaults to HibernateOrmMapperSettings.Defaults.MULTI_TENANCY_TENANT_IDENTIFIER_CONVERTER. This converter only supports string tenant identifiers and will fail if some other type of identifiers is used.

See Also:

• TenantIdentifierConverter
• Constant Field Values

INDEXING_PLAN_SYNCHRONIZATION_STRATEGY

public static final String INDEXING_PLAN_SYNCHRONIZATION_STRATEGY

How to synchronize between application threads and indexing triggered by the SearchIndexingPlan.

Expects one of the strings defined in IndexingPlanSynchronizationStrategyNames, or a reference to a bean of type IndexingPlanSynchronizationStrategy.

Defaults to HibernateOrmMapperSettings.Defaults.INDEXING_PLAN_SYNCHRONIZATION_STRATEGY.

See Also:

• IndexingPlanSynchronizationStrategyNames
• The core documentation of configuration properties, which includes a description of the "bean reference" properties and accepted values.
• Constant Field Values

INDEXING_LISTENERS_ENABLED

public static final String INDEXING_LISTENERS_ENABLED

Whether Hibernate ORM listeners that detect entity changes and automatically trigger indexing operations are enabled.

Expects a Boolean value such as true or false, or a string that can be parsed into a Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.INDEXING_LISTENERS_ENABLED.

See Also:

• Constant Field Values

INDEXING_MASS_DEFAULT_CLEAN_OPERATION

public static final String INDEXING_MASS_DEFAULT_CLEAN_OPERATION

The default index cleaning operation to apply during mass indexing, unless configured explicitly.

Expects a MassIndexingDefaultCleanOperation value, or a String representation of such value.

Defaults to HibernateOrmMapperSettings.Defaults.INDEXING_MASS_DEFAULT_CLEAN_OPERATION.

See Also:

• Constant Field Values