Package org.hibernate.search.engine.cfg

Class EngineSettings

java.lang.Object

org.hibernate.search.engine.cfg.EngineSettings

public final class EngineSettings
extends Object

Configuration properties for the Hibernate Search engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EngineSettings.Defaults	Default values for the different settings if no values are given.
static class	EngineSettings.Radicals	Configuration property keys without the prefix.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKEND	The root property for properties of the default backend, e.g.
static String	BACKENDS	The root property for properties of named backends, e.g.
static String	BACKGROUND_FAILURE_HANDLER	The FailureHandler instance that should be notified of any failure occurring in a background process (mainly index operations).
static String	CONFIGURATION_PROPERTY_CHECKING_STRATEGY	The strategy to use when reporting the results of configuration property checking.
static String	DEFAULT_BACKEND	Deprecated. The default backend shouldn't be assigned a name; just prefix its properties with BACKEND instead of BACKENDS + a name.
static String	PREFIX	The prefix expected for the key of every Hibernate Search configuration property.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

The prefix expected for the key of every Hibernate Search configuration property.

See Also:

Constant Field Values

DEFAULT_BACKEND

@Deprecated
public static final String DEFAULT_BACKEND

Deprecated.

The default backend shouldn't be assigned a name; just prefix its properties with BACKEND instead of BACKENDS + a name.

The name of the default backend to use when none is defined in the index configuration.

Expects a String.

Defaults to no value, meaning a backend must be set in the mapping for every single index.

See Also:

Constant Field Values

BACKEND

public static final String BACKEND

The root property for properties of the default backend, e.g. "hibernate.search.backend.type = elasticsearch".

See Also:

Constant Field Values

BACKENDS

public static final String BACKENDS

The root property for properties of named backends, e.g. "hibernate.search.backends.myBackend.type = elasticsearch".

See Also:

Constant Field Values

CONFIGURATION_PROPERTY_CHECKING_STRATEGY

public static final String CONFIGURATION_PROPERTY_CHECKING_STRATEGY

The strategy to use when reporting the results of configuration property checking.

Configuration property checking will detect an configuration property that is never used, which might indicate a configuration issue.

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

Defaults to EngineSettings.Defaults.CONFIGURATION_PROPERTY_CHECKING_STRATEGY.

See Also:

Constant Field Values

BACKGROUND_FAILURE_HANDLER

public static final String BACKGROUND_FAILURE_HANDLER

The FailureHandler instance that should be notified of any failure occurring in a background process (mainly index operations).

Expects a reference to a bean of type FailureHandler.

Defaults to a logging handler.

See Also:

Constant Field Values