Package org.opensearch.node

Class Node

java.lang.Object

org.opensearch.node.Node

All Implemented Interfaces:

Closeable, AutoCloseable

public class Node
extends Object
implements Closeable

A node represent a node within a cluster (cluster.name). The client() can be used in order to use a Client to perform actions/operations against the cluster.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Node.DiscoverySettings	The discovery settings for the node.

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<String>	BREAKER_TYPE_KEY
static final Setting.AffixSetting<String>	NODE_ATTRIBUTES
static final Setting<Boolean>	NODE_LOCAL_STORAGE_SETTING	controls whether the node is allowed to persist things like metadata to disk Note that this does not control whether the node stores actual indices (see NODE_DATA_SETTING).
static final Setting<String>	NODE_NAME_SETTING
static final Setting<org.opensearch.core.common.unit.ByteSizeValue>	NODE_SEARCH_CACHE_SIZE_SETTING
static final Setting<Boolean>	WRITE_PORTS_FILE_SETTING

Constructor Summary

Constructors

Modifier	Constructor	Description
	Node(Environment environment)
protected	Node(Environment initialEnvironment, Collection<Class<? extends Plugin>> classpathPlugins, boolean forbidPrivateIndexSettings)	Constructs a node

Method Summary

Modifier and Type	Method	Description
boolean	awaitClose(long timeout, TimeUnit timeUnit)	Wait for this node to be effectively closed.
Client	client()	A client that can be used to execute actions (operations) against the cluster.
void	close()
protected void	configureNodeAndClusterIdStateListener(ClusterService clusterService)
static org.opensearch.core.indices.breaker.CircuitBreakerService	createCircuitBreakerService(Settings settings, List<BreakerSettings> breakerSettings, ClusterSettings clusterSettings)	Creates a new CircuitBreakerService based on the settings provided.
FileCache	fileCache()	Returns the FileCache instance for remote search node Note: Visible for testing
Environment	getEnvironment()	Returns the environment of the node
NodeEnvironment	getNodeEnvironment()	Returns the NodeEnvironment instance of this node
protected PluginsService	getPluginsService()	The PluginsService used to build this node's components.
Injector	injector()
boolean	isClosed()	Returns true if the node is closed.
protected ClusterInfoService	newClusterInfoService(Settings settings, ClusterService clusterService, ThreadPool threadPool, NodeClient client)	Constructs a ClusterInfoService which may be mocked for tests.
protected HttpServerTransport	newHttpTransport(NetworkModule networkModule)	Constructs a HttpServerTransport which may be mocked for tests.
protected ScriptService	newScriptService(Settings settings, Map<String,ScriptEngine> engines, Map<String,ScriptContext<?>> contexts)	Creates a new the ScriptService.
protected SearchService	newSearchService(ClusterService clusterService, IndicesService indicesService, ThreadPool threadPool, ScriptService scriptService, BigArrays bigArrays, QueryPhase queryPhase, FetchPhase fetchPhase, ResponseCollectorService responseCollectorService, org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService, Executor indexSearcherExecutor)	Creates a new the SearchService.
protected TransportService	newTransportService(Settings settings, Transport transport, ThreadPool threadPool, TransportInterceptor interceptor, Function<org.opensearch.core.common.transport.BoundTransportAddress,DiscoveryNode> localNodeFactory, ClusterSettings clusterSettings, Set<String> taskHeaders)
protected void	processRecoverySettings(ClusterSettings clusterSettings, RecoverySettings recoverySettings)
Settings	settings()	The settings that are used by this node.
Node	start()	Start the node.
protected void	validateNodeBeforeAcceptingRequests(BootstrapContext context, org.opensearch.core.common.transport.BoundTransportAddress boundTransportAddress, List<BootstrapCheck> bootstrapChecks)	Hook for validating the node after network services are started but before the cluster service is started and before the network service starts accepting incoming network requests.

Methods inherited from class java.lang.Object

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

Field Details

WRITE_PORTS_FILE_SETTING

public static final Setting<Boolean> WRITE_PORTS_FILE_SETTING

NODE_LOCAL_STORAGE_SETTING

public static final Setting<Boolean> NODE_LOCAL_STORAGE_SETTING

controls whether the node is allowed to persist things like metadata to disk Note that this does not control whether the node stores actual indices (see NODE_DATA_SETTING). However, if this is false, NODE_DATA_SETTING and NODE_MASTER_SETTING must also be false.

NODE_NAME_SETTING

public static final Setting<String> NODE_NAME_SETTING

NODE_ATTRIBUTES

public static final Setting.AffixSetting<String> NODE_ATTRIBUTES

BREAKER_TYPE_KEY

public static final Setting<String> BREAKER_TYPE_KEY

NODE_SEARCH_CACHE_SIZE_SETTING

public static final Setting<org.opensearch.core.common.unit.ByteSizeValue> NODE_SEARCH_CACHE_SIZE_SETTING

Constructor Details

Node

public Node(Environment environment)

Node

protected Node(Environment initialEnvironment,
 Collection<Class<? extends Plugin>> classpathPlugins,
 boolean forbidPrivateIndexSettings)

Constructs a node

Parameters:

initialEnvironment - the initial environment for this node, which will be added to by plugins

classpathPlugins - the plugins to be loaded from the classpath

forbidPrivateIndexSettings - whether or not private index settings are forbidden when creating an index; this is used in the test framework for tests that rely on being able to set private settings

Method Details

newTransportService

protected TransportService newTransportService(Settings settings,
 Transport transport,
 ThreadPool threadPool,
 TransportInterceptor interceptor,
 Function<org.opensearch.core.common.transport.BoundTransportAddress,DiscoveryNode> localNodeFactory,
 ClusterSettings clusterSettings,
 Set<String> taskHeaders)

processRecoverySettings

protected void processRecoverySettings(ClusterSettings clusterSettings,
 RecoverySettings recoverySettings)

settings

public Settings settings()

The settings that are used by this node. Contains original settings as well as additional settings provided by plugins.

client

public Client client()

A client that can be used to execute actions (operations) against the cluster.

getEnvironment

public Environment getEnvironment()

Returns the environment of the node

getNodeEnvironment

public NodeEnvironment getNodeEnvironment()

Returns the NodeEnvironment instance of this node

start

public Node start()
           throws NodeValidationException

Start the node. If the node is already started, this method is no-op.

Throws:

NodeValidationException

configureNodeAndClusterIdStateListener

protected void configureNodeAndClusterIdStateListener(ClusterService clusterService)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

awaitClose

public boolean awaitClose(long timeout,
 TimeUnit timeUnit)
                   throws InterruptedException

Wait for this node to be effectively closed.

Throws:

InterruptedException

isClosed

public boolean isClosed()

Returns true if the node is closed.

injector

public Injector injector()

validateNodeBeforeAcceptingRequests

protected void validateNodeBeforeAcceptingRequests(BootstrapContext context,
 org.opensearch.core.common.transport.BoundTransportAddress boundTransportAddress,
 List<BootstrapCheck> bootstrapChecks)
                                            throws NodeValidationException

Hook for validating the node after network services are started but before the cluster service is started and before the network service starts accepting incoming network requests.

Parameters:

context - the bootstrap context for this node

boundTransportAddress - the network addresses the node is bound and publishing to

Throws:

NodeValidationException

getPluginsService

protected PluginsService getPluginsService()

The PluginsService used to build this node's components.

createCircuitBreakerService

public static org.opensearch.core.indices.breaker.CircuitBreakerService createCircuitBreakerService(Settings settings,
 List<BreakerSettings> breakerSettings,
 ClusterSettings clusterSettings)

Creates a new CircuitBreakerService based on the settings provided.

See Also:

• BREAKER_TYPE_KEY

newSearchService

protected SearchService newSearchService(ClusterService clusterService,
 IndicesService indicesService,
 ThreadPool threadPool,
 ScriptService scriptService,
 BigArrays bigArrays,
 QueryPhase queryPhase,
 FetchPhase fetchPhase,
 ResponseCollectorService responseCollectorService,
 org.opensearch.core.indices.breaker.CircuitBreakerService circuitBreakerService,
 Executor indexSearcherExecutor)

Creates a new the SearchService. This method can be overwritten by tests to inject mock implementations.

newScriptService

protected ScriptService newScriptService(Settings settings,
 Map<String,ScriptEngine> engines,
 Map<String,ScriptContext<?>> contexts)

Creates a new the ScriptService. This method can be overwritten by tests to inject mock implementations.

newClusterInfoService

protected ClusterInfoService newClusterInfoService(Settings settings,
 ClusterService clusterService,
 ThreadPool threadPool,
 NodeClient client)

Constructs a ClusterInfoService which may be mocked for tests.

newHttpTransport

protected HttpServerTransport newHttpTransport(NetworkModule networkModule)

Constructs a HttpServerTransport which may be mocked for tests.

fileCache

public FileCache fileCache()

Returns the FileCache instance for remote search node Note: Visible for testing