Package org.hibernate.search.mapper.pojo.standalone.cfg

Class StandalonePojoMapperSettings

java.lang.Object

org.hibernate.search.mapper.pojo.standalone.cfg.StandalonePojoMapperSettings

@Incubating
public final class StandalonePojoMapperSettings
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StandalonePojoMapperSettings.Defaults	Default values for the different settings if no values are given.
static class	StandalonePojoMapperSettings.Radicals

Field Summary

Fields

Modifier and Type	Field	Description
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 SearchSession's indexing plan.
static final String	MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES	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	Whether Hibernate Search should automatically discover annotated types present in the Jandex index that are also annotated with root mapping annotations.
static final String	MULTI_TENANCY_ENABLED	Enables or disables multi-tenancy.
static final String	MULTI_TENANCY_TENANT_IDENTIFIER_CONVERTER	How to convert tenant identifier to and form the string representation.
static final String	PREFIX
static final String	SCHEMA_MANAGEMENT_STRATEGY	The schema management strategy, controlling 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

See Also:

• Constant Field Values

SCHEMA_MANAGEMENT_STRATEGY

public static final String SCHEMA_MANAGEMENT_STRATEGY

The schema management strategy, controlling 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 StandalonePojoMapperSettings.Defaults.SCHEMA_MANAGEMENT_STRATEGY.

See Also:

• SchemaManagementStrategyName
• Constant Field Values

MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES

public static final String MAPPING_BUILD_MISSING_DISCOVERED_JANDEX_INDEXES

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

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 StandalonePojoMapperSettings.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 StandalonePojoMappingConfigurer.

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

MULTI_TENANCY_ENABLED

public static final String MULTI_TENANCY_ENABLED

Enables or disables multi-tenancy.

If multi-tenancy is enabled, every session will need to be assigned a tenant identifier.

Expects a boolean value.

Defaults to StandalonePojoMapperSettings.Defaults.MULTI_TENANCY_ENABLED.

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.

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

Defaults to StandalonePojoMapperSettings.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 SearchSession's indexing plan.

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

Defaults to StandalonePojoMapperSettings.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_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 StandalonePojoMapperSettings.Defaults.INDEXING_MASS_DEFAULT_CLEAN_OPERATION.

See Also:

• Constant Field Values