Package org.craftercms.deployer.utils.opensearch

Class OpenSearchConfig

java.lang.Object

org.craftercms.deployer.utils.opensearch.OpenSearchConfig

public class OpenSearchConfig
extends Object

Holds the configuration for connecting to OpenSearch, either a single or multiple clusters

Since:

3.1.5

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY_GLOBAL_CLUSTER
static final String	CONFIG_KEY_INDEX_SETTINGS
static final String	CONFIG_KEY_KEY
static final String	CONFIG_KEY_LOCALE_MAPPING
static final String	CONFIG_KEY_READ_CLUSTER
static final String	CONFIG_KEY_VALUE
static final String	CONFIG_KEY_WRITE_CLUSTERS
final OpenSearchClusterConfig	globalCluster	The global cluster, used for connecting to a single cluster for read & write operations
final Map<String,String>	indexSettings
final Map<String,String>	localeMapping	Mapping of locale codes to OpenSearch language analyzers
final OpenSearchClusterConfig	readCluster	The read cluster, used for connecting to multiple clusters
final List<OpenSearchClusterConfig>	writeClusters	The write clusters, used for connecting to multiple clusters

Constructor Summary

Constructors

Constructor	Description
OpenSearchConfig(org.apache.commons.configuration2.HierarchicalConfiguration<?> config)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getLocaleMapping()
boolean	useSingleCluster()	Indicates if a single cluster should be used, only if any of the read or write clusters is missing

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_KEY_GLOBAL_CLUSTER

public static final String CONFIG_KEY_GLOBAL_CLUSTER

See Also:

• Constant Field Values

CONFIG_KEY_READ_CLUSTER

public static final String CONFIG_KEY_READ_CLUSTER

See Also:

• Constant Field Values

CONFIG_KEY_WRITE_CLUSTERS

public static final String CONFIG_KEY_WRITE_CLUSTERS

See Also:

• Constant Field Values

CONFIG_KEY_LOCALE_MAPPING

public static final String CONFIG_KEY_LOCALE_MAPPING

See Also:

• Constant Field Values

CONFIG_KEY_INDEX_SETTINGS

public static final String CONFIG_KEY_INDEX_SETTINGS

See Also:

• Constant Field Values

CONFIG_KEY_KEY

public static final String CONFIG_KEY_KEY

See Also:

• Constant Field Values

CONFIG_KEY_VALUE

public static final String CONFIG_KEY_VALUE

See Also:

• Constant Field Values

globalCluster

public final OpenSearchClusterConfig globalCluster

The global cluster, used for connecting to a single cluster for read & write operations

readCluster

public final OpenSearchClusterConfig readCluster

The read cluster, used for connecting to multiple clusters

writeClusters

public final List<OpenSearchClusterConfig> writeClusters

The write clusters, used for connecting to multiple clusters

localeMapping

public final Map<String,String> localeMapping

Mapping of locale codes to OpenSearch language analyzers

indexSettings

public final Map<String,String> indexSettings

Constructor Details

OpenSearchConfig

@ConstructorProperties("config")
public OpenSearchConfig(org.apache.commons.configuration2.HierarchicalConfiguration<?> config)

Method Details

useSingleCluster

public boolean useSingleCluster()

Indicates if a single cluster should be used, only if any of the read or write clusters is missing

getLocaleMapping

public Map<String,String> getLocaleMapping()