Package org.nuxeo.runtime.opensearch1

Class OpenSearchComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.runtime.opensearch1.OpenSearchComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, OpenSearchClientService, TimestampedService

public class OpenSearchComponent
extends DefaultComponent
implements OpenSearchClientService

Component used to get a client configured to hit an OpenSearch instance.

Since:

2025.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	OpenSearchComponent.OpenSearchClientWithId

Field Summary

Fields

Modifier and Type	Field	Description
protected static final OpenSearchClientFactory	CLIENT_FACTORY
protected final Map<String,OpenSearchClient>	clients
protected static final String	DEFAULT_CLIENT_ID
protected static final Duration	TIMEOUT_WAIT_FOR_CLUSTER
protected static final String	XP_CLIENT
protected static final String	XP_INDEX

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
OpenSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected void	createIndex(String indexName, OpenSearchIndexConfig config, boolean dropIfExists)
void	dropAndInitIndex(String indexName)
int	getApplicationStartedOrder()	The component notification order for Component.start(ComponentContext).
OpenSearchClient	getClient(String id)	Gets the OpenSearch client for the given id.
protected void	initIndex(OpenSearchIndexConfig config, boolean dropIfExists)
protected OpenSearchComponent.OpenSearchClientWithId	instantiateClient(OpenSearchClientConfig descriptor)
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Details

XP_CLIENT

protected static final String XP_CLIENT

See Also:

• Constant Field Values

XP_INDEX

protected static final String XP_INDEX

See Also:

• Constant Field Values

DEFAULT_CLIENT_ID

protected static final String DEFAULT_CLIENT_ID

See Also:

• Constant Field Values

TIMEOUT_WAIT_FOR_CLUSTER

protected static final Duration TIMEOUT_WAIT_FOR_CLUSTER

CLIENT_FACTORY

protected static final OpenSearchClientFactory CLIENT_FACTORY

clients

protected final Map<String,OpenSearchClient> clients

Constructor Details

OpenSearchComponent

public OpenSearchComponent()

Method Details

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.start(ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

instantiateClient

protected OpenSearchComponent.OpenSearchClientWithId instantiateClient(OpenSearchClientConfig descriptor)

initIndex

protected void initIndex(OpenSearchIndexConfig config,
 boolean dropIfExists)

createIndex

protected void createIndex(String indexName,
 OpenSearchIndexConfig config,
 boolean dropIfExists)

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

getClient

public OpenSearchClient getClient(String id)

Description copied from interface: OpenSearchClientService

Gets the OpenSearch client for the given id.

Specified by:

getClient in interface OpenSearchClientService

Parameters:

id - the client id

Returns:

the client configured by OpenSearchClientConfig for the input id, or the default one if it doesn't exist

dropAndInitIndex

public void dropAndInitIndex(String indexName)