Package org.elasticsearch.transport

Class TransportService

java.lang.Object

org.elasticsearch.common.component.AbstractLifecycleComponent

org.elasticsearch.transport.TransportService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, TransportConnectionListener, TransportMessageListener

public class TransportService
extends AbstractLifecycleComponent
implements TransportMessageListener, TransportConnectionListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransportService.ContextRestoreResponseHandler<T extends TransportResponse>	This handler wrapper ensures that the response thread executes with the correct thread context.
static class	TransportService.HandshakeResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterName	clusterName
protected ConnectionManager	connectionManager
static java.lang.String	DIRECT_RESPONSE_PROFILE
static java.lang.String	HANDSHAKE_ACTION_NAME
static TransportInterceptor	NOOP_TRANSPORT_INTERCEPTOR
protected TaskManager	taskManager
protected ThreadPool	threadPool
protected Transport	transport
static java.util.Set<java.lang.String>	VALID_ACTION_PREFIXES	A set of all valid action prefixes.

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from interface org.elasticsearch.transport.TransportMessageListener

NOOP_LISTENER

Constructor Summary

Constructors

Constructor	Description
TransportService(Settings settings, Transport transport, ThreadPool threadPool, TransportInterceptor transportInterceptor, java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory, ClusterSettings clusterSettings, java.util.Set<java.lang.String> taskHeaders)	Build the service.
TransportService(Settings settings, Transport transport, ThreadPool threadPool, TransportInterceptor transportInterceptor, java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory, ClusterSettings clusterSettings, java.util.Set<java.lang.String> taskHeaders, ConnectionManager connectionManager)

Method Summary

Modifier and Type	Method	Description
void	acceptIncomingRequests()	start accepting incoming requests.
void	addConnectionListener(TransportConnectionListener listener)
void	addMessageListener(TransportMessageListener listener)
TransportAddress[]	addressesFromString(java.lang.String address)
BoundTransportAddress	boundAddress()
CheckedBiConsumer<Transport.Connection,ConnectionProfile,java.io.IOException>	connectionValidator(DiscoveryNode node)
void	connectToNode(DiscoveryNode node)	Connect to the specified node with the default connection profile
void	connectToNode(DiscoveryNode node, ConnectionProfile connectionProfile)	Connect to the specified node with the given connection profile
protected TaskManager	createTaskManager(Settings settings, ThreadPool threadPool, java.util.Set<java.lang.String> taskHeaders)
void	disconnectFromNode(DiscoveryNode node)
protected void	doClose()
protected void	doStart()
protected void	doStop()
Transport.Connection	getConnection(DiscoveryNode node)	Returns either a real transport connection or a local node connection if we are using the local node optimization.
ConnectionManager	getConnectionManager()
java.util.List<java.lang.String>	getDefaultSeedAddresses()
DiscoveryNode	getLocalNode()
RemoteClusterService	getRemoteClusterService()
RequestHandlerRegistry<? extends TransportRequest>	getRequestHandler(java.lang.String action)
TaskManager	getTaskManager()
ThreadPool	getThreadPool()	Returns the internal thread pool
DiscoveryNode	handshake(Transport.Connection connection, long handshakeTimeout)	Executes a high-level handshake using the given connection and returns the discovery node of the node the connection was established with.
TransportService.HandshakeResponse	handshake(Transport.Connection connection, long handshakeTimeout, java.util.function.Predicate<ClusterName> clusterNamePredicate)	Executes a high-level handshake using the given connection and returns the discovery node of the node the connection was established with.
TransportInfo	info()
static boolean	isValidActionName(java.lang.String actionName)	Returns true iff the action name starts with a valid prefix.
boolean	nodeConnected(DiscoveryNode node)	Returns true iff the given node is already connected.
void	onConnectionClosed(Transport.Connection connection)	Called once a connection ws closed.
void	onRequestReceived(long requestId, java.lang.String action)	called by the Transport implementation when an incoming request arrives but before any parsing of it has happened (with the exception of the requestId and action)
void	onRequestSent(DiscoveryNode node, long requestId, java.lang.String action, TransportRequest request, TransportRequestOptions options)	called by the Transport implementation once a request has been sent
void	onResponseReceived(long requestId, Transport.ResponseContext holder)	Called for every response received
void	onResponseSent(long requestId, java.lang.String action, java.lang.Exception e)	called by the Transport implementation after an exception was sent as a response to an incoming request
void	onResponseSent(long requestId, java.lang.String action, TransportResponse response)	called by the Transport implementation once a response was sent to calling node
Transport.Connection	openConnection(DiscoveryNode node, ConnectionProfile connectionProfile)	Establishes and returns a new connection to the given node.
<Request extends TransportRequest> void	registerRequestHandler(java.lang.String action, java.lang.String executor, boolean forceExecution, boolean canTripCircuitBreaker, Writeable.Reader<Request> requestReader, TransportRequestHandler<Request> handler)	Registers a new request handler
<Request extends TransportRequest> void	registerRequestHandler(java.lang.String action, java.lang.String executor, Writeable.Reader<Request> requestReader, TransportRequestHandler<Request> handler)	Registers a new request handler
<Request extends TransportRequest> void	registerRequestHandler(java.lang.String action, java.util.function.Supplier<Request> request, java.lang.String executor, boolean forceExecution, boolean canTripCircuitBreaker, TransportRequestHandler<Request> handler)	Registers a new request handler
<Request extends TransportRequest> void	registerRequestHandler(java.lang.String action, java.util.function.Supplier<Request> requestFactory, java.lang.String executor, TransportRequestHandler<Request> handler)	Registers a new request handler
void	removeConnectionListener(TransportConnectionListener listener)
boolean	removeMessageListener(TransportMessageListener listener)
<T extends TransportResponse> void	sendChildRequest(DiscoveryNode node, java.lang.String action, TransportRequest request, Task parentTask, TransportRequestOptions options, TransportResponseHandler<T> handler)
<T extends TransportResponse> void	sendChildRequest(Transport.Connection connection, java.lang.String action, TransportRequest request, Task parentTask, TransportRequestOptions options, TransportResponseHandler<T> handler)
<T extends TransportResponse> void	sendChildRequest(Transport.Connection connection, java.lang.String action, TransportRequest request, Task parentTask, TransportResponseHandler<T> handler)
<T extends TransportResponse> void	sendRequest(DiscoveryNode node, java.lang.String action, TransportRequest request, TransportRequestOptions options, TransportResponseHandler<T> handler)
<T extends TransportResponse> void	sendRequest(DiscoveryNode node, java.lang.String action, TransportRequest request, TransportResponseHandler<T> handler)
<T extends TransportResponse> void	sendRequest(Transport.Connection connection, java.lang.String action, TransportRequest request, TransportRequestOptions options, TransportResponseHandler<T> handler)
TransportStats	stats()
<T extends TransportResponse> TransportFuture<T>	submitRequest(DiscoveryNode node, java.lang.String action, TransportRequest request, TransportRequestOptions options, TransportResponseHandler<T> handler)
<T extends TransportResponse> TransportFuture<T>	submitRequest(DiscoveryNode node, java.lang.String action, TransportRequest request, TransportResponseHandler<T> handler)

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.transport.TransportConnectionListener

onConnectionOpened, onNodeConnected, onNodeDisconnected

Field Detail

DIRECT_RESPONSE_PROFILE

public static final java.lang.String DIRECT_RESPONSE_PROFILE

See Also:

Constant Field Values

HANDSHAKE_ACTION_NAME

public static final java.lang.String HANDSHAKE_ACTION_NAME

See Also:

Constant Field Values

transport

protected final Transport transport

connectionManager

protected final ConnectionManager connectionManager

threadPool

protected final ThreadPool threadPool

clusterName

protected final ClusterName clusterName

taskManager

protected final TaskManager taskManager

NOOP_TRANSPORT_INTERCEPTOR

public static final TransportInterceptor NOOP_TRANSPORT_INTERCEPTOR

VALID_ACTION_PREFIXES

public static final java.util.Set<java.lang.String> VALID_ACTION_PREFIXES

A set of all valid action prefixes.

Constructor Detail

TransportService

public TransportService(Settings settings,
                        Transport transport,
                        ThreadPool threadPool,
                        TransportInterceptor transportInterceptor,
                        java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory,
                        @Nullable
                        ClusterSettings clusterSettings,
                        java.util.Set<java.lang.String> taskHeaders)

Build the service.

Parameters:

clusterSettings - if non null, the TransportService will register with the ClusterSettings for settings * updates for TransportSettings.TRACE_LOG_EXCLUDE_SETTING and TransportSettings.TRACE_LOG_INCLUDE_SETTING.

TransportService

public TransportService(Settings settings,
                        Transport transport,
                        ThreadPool threadPool,
                        TransportInterceptor transportInterceptor,
                        java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory,
                        @Nullable
                        ClusterSettings clusterSettings,
                        java.util.Set<java.lang.String> taskHeaders,
                        ConnectionManager connectionManager)

Method Detail

getRemoteClusterService

public RemoteClusterService getRemoteClusterService()

getLocalNode

public DiscoveryNode getLocalNode()

getTaskManager

public TaskManager getTaskManager()

createTaskManager

protected TaskManager createTaskManager(Settings settings,
                                        ThreadPool threadPool,
                                        java.util.Set<java.lang.String> taskHeaders)

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent

doClose

protected void doClose()
                throws java.io.IOException

Specified by:

doClose in class AbstractLifecycleComponent

Throws:

java.io.IOException

acceptIncomingRequests

public final void acceptIncomingRequests()

start accepting incoming requests. when the transport layer starts up it will block any incoming requests until this method is called

info

public TransportInfo info()

stats

public TransportStats stats()

boundAddress

public BoundTransportAddress boundAddress()

getDefaultSeedAddresses

public java.util.List<java.lang.String> getDefaultSeedAddresses()

nodeConnected

public boolean nodeConnected(DiscoveryNode node)

Returns true iff the given node is already connected.

connectToNode

public void connectToNode(DiscoveryNode node)
                   throws ConnectTransportException

Connect to the specified node with the default connection profile

Parameters:

node - the node to connect to

Throws:

ConnectTransportException

connectToNode

public void connectToNode(DiscoveryNode node,
                          ConnectionProfile connectionProfile)

Connect to the specified node with the given connection profile

Parameters:

node - the node to connect to

connectionProfile - the connection profile to use when connecting to this node

connectionValidator

public CheckedBiConsumer<Transport.Connection,ConnectionProfile,java.io.IOException> connectionValidator(DiscoveryNode node)

openConnection

public Transport.Connection openConnection(DiscoveryNode node,
                                           ConnectionProfile connectionProfile)
                                    throws java.io.IOException

Establishes and returns a new connection to the given node. The connection is NOT maintained by this service, it's the callers responsibility to close the connection once it goes out of scope.

Parameters:

node - the node to connect to

connectionProfile - the connection profile to use

Throws:

java.io.IOException

handshake

public DiscoveryNode handshake(Transport.Connection connection,
                               long handshakeTimeout)
                        throws ConnectTransportException

Executes a high-level handshake using the given connection and returns the discovery node of the node the connection was established with. The handshake will fail if the cluster name on the target node mismatches the local cluster name.

Parameters:

connection - the connection to a specific node

handshakeTimeout - handshake timeout

Returns:

the connected node

Throws:

ConnectTransportException - if the connection failed

java.lang.IllegalStateException - if the handshake failed

handshake

public TransportService.HandshakeResponse handshake(Transport.Connection connection,
                                                    long handshakeTimeout,
                                                    java.util.function.Predicate<ClusterName> clusterNamePredicate)

Executes a high-level handshake using the given connection and returns the discovery node of the node the connection was established with. The handshake will fail if the cluster name on the target node doesn't match the local cluster name.

Parameters:

connection - the connection to a specific node

handshakeTimeout - handshake timeout

clusterNamePredicate - cluster name validation predicate

Returns:

the handshake response

Throws:

java.lang.IllegalStateException - if the handshake failed

getConnectionManager

public ConnectionManager getConnectionManager()

disconnectFromNode

public void disconnectFromNode(DiscoveryNode node)

addMessageListener

public void addMessageListener(TransportMessageListener listener)

removeMessageListener

public boolean removeMessageListener(TransportMessageListener listener)

addConnectionListener

public void addConnectionListener(TransportConnectionListener listener)

removeConnectionListener

public void removeConnectionListener(TransportConnectionListener listener)

submitRequest

public <T extends TransportResponse> TransportFuture<T> submitRequest(DiscoveryNode node,
                                                                      java.lang.String action,
                                                                      TransportRequest request,
                                                                      TransportResponseHandler<T> handler)
                                                               throws TransportException

Throws:

TransportException

submitRequest

public <T extends TransportResponse> TransportFuture<T> submitRequest(DiscoveryNode node,
                                                                      java.lang.String action,
                                                                      TransportRequest request,
                                                                      TransportRequestOptions options,
                                                                      TransportResponseHandler<T> handler)
                                                               throws TransportException

Throws:

TransportException

sendRequest

public <T extends TransportResponse> void sendRequest(DiscoveryNode node,
                                                      java.lang.String action,
                                                      TransportRequest request,
                                                      TransportResponseHandler<T> handler)

sendRequest

public final <T extends TransportResponse> void sendRequest(DiscoveryNode node,
                                                            java.lang.String action,
                                                            TransportRequest request,
                                                            TransportRequestOptions options,
                                                            TransportResponseHandler<T> handler)

sendRequest

public final <T extends TransportResponse> void sendRequest(Transport.Connection connection,
                                                            java.lang.String action,
                                                            TransportRequest request,
                                                            TransportRequestOptions options,
                                                            TransportResponseHandler<T> handler)

getConnection

public Transport.Connection getConnection(DiscoveryNode node)

Returns either a real transport connection or a local node connection if we are using the local node optimization.

Throws:

NodeNotConnectedException - if the given node is not connected

sendChildRequest

public final <T extends TransportResponse> void sendChildRequest(DiscoveryNode node,
                                                                 java.lang.String action,
                                                                 TransportRequest request,
                                                                 Task parentTask,
                                                                 TransportRequestOptions options,
                                                                 TransportResponseHandler<T> handler)

sendChildRequest

public <T extends TransportResponse> void sendChildRequest(Transport.Connection connection,
                                                           java.lang.String action,
                                                           TransportRequest request,
                                                           Task parentTask,
                                                           TransportResponseHandler<T> handler)

sendChildRequest

public <T extends TransportResponse> void sendChildRequest(Transport.Connection connection,
                                                           java.lang.String action,
                                                           TransportRequest request,
                                                           Task parentTask,
                                                           TransportRequestOptions options,
                                                           TransportResponseHandler<T> handler)

addressesFromString

public TransportAddress[] addressesFromString(java.lang.String address)
                                       throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

isValidActionName

public static boolean isValidActionName(java.lang.String actionName)

Returns true iff the action name starts with a valid prefix.

See Also:

VALID_ACTION_PREFIXES

registerRequestHandler

public <Request extends TransportRequest> void registerRequestHandler(java.lang.String action,
                                                                      java.util.function.Supplier<Request> requestFactory,
                                                                      java.lang.String executor,
                                                                      TransportRequestHandler<Request> handler)

Registers a new request handler

Parameters:

action - The action the request handler is associated with

requestFactory - a callable to be used construct new instances for streaming

executor - The executor the request handling will be executed on

handler - The handler itself that implements the request handling

registerRequestHandler

public <Request extends TransportRequest> void registerRequestHandler(java.lang.String action,
                                                                      java.lang.String executor,
                                                                      Writeable.Reader<Request> requestReader,
                                                                      TransportRequestHandler<Request> handler)

Registers a new request handler

Parameters:

action - The action the request handler is associated with

requestReader - a callable to be used construct new instances for streaming

executor - The executor the request handling will be executed on

handler - The handler itself that implements the request handling

registerRequestHandler

public <Request extends TransportRequest> void registerRequestHandler(java.lang.String action,
                                                                      java.util.function.Supplier<Request> request,
                                                                      java.lang.String executor,
                                                                      boolean forceExecution,
                                                                      boolean canTripCircuitBreaker,
                                                                      TransportRequestHandler<Request> handler)

Registers a new request handler

Parameters:

action - The action the request handler is associated with

request - The request class that will be used to construct new instances for streaming

executor - The executor the request handling will be executed on

forceExecution - Force execution on the executor queue and never reject it

canTripCircuitBreaker - Check the request size and raise an exception in case the limit is breached.

handler - The handler itself that implements the request handling

registerRequestHandler

public <Request extends TransportRequest> void registerRequestHandler(java.lang.String action,
                                                                      java.lang.String executor,
                                                                      boolean forceExecution,
                                                                      boolean canTripCircuitBreaker,
                                                                      Writeable.Reader<Request> requestReader,
                                                                      TransportRequestHandler<Request> handler)

Registers a new request handler

Parameters:

action - The action the request handler is associated with

requestReader - The request class that will be used to construct new instances for streaming

executor - The executor the request handling will be executed on

forceExecution - Force execution on the executor queue and never reject it

canTripCircuitBreaker - Check the request size and raise an exception in case the limit is breached.

handler - The handler itself that implements the request handling

onRequestReceived

public void onRequestReceived(long requestId,
                              java.lang.String action)

called by the Transport implementation when an incoming request arrives but before any parsing of it has happened (with the exception of the requestId and action)

Specified by:

onRequestReceived in interface TransportMessageListener

Parameters:

requestId - the internal request ID

action - the request action

onRequestSent

public void onRequestSent(DiscoveryNode node,
                          long requestId,
                          java.lang.String action,
                          TransportRequest request,
                          TransportRequestOptions options)

called by the Transport implementation once a request has been sent

Specified by:

onRequestSent in interface TransportMessageListener

Parameters:

node - the node the request was sent to

requestId - the internal request id

action - the action name

request - the actual request

options - the request options

onResponseReceived

public void onResponseReceived(long requestId,
                               Transport.ResponseContext holder)

Description copied from interface: TransportMessageListener

Called for every response received

Specified by:

onResponseReceived in interface TransportMessageListener

Parameters:

requestId - the request id for this reponse

holder - the response context or null if the context was already processed ie. due to a timeout.

onResponseSent

public void onResponseSent(long requestId,
                           java.lang.String action,
                           TransportResponse response)

called by the Transport implementation once a response was sent to calling node

Specified by:

onResponseSent in interface TransportMessageListener

Parameters:

requestId - the request ID (unique per client)

action - the request action

response - the response send

onResponseSent

public void onResponseSent(long requestId,
                           java.lang.String action,
                           java.lang.Exception e)

called by the Transport implementation after an exception was sent as a response to an incoming request

Specified by:

onResponseSent in interface TransportMessageListener

Parameters:

requestId - the request ID (unique per client)

action - the request action

e - the error sent back to the caller

getRequestHandler

public RequestHandlerRegistry<? extends TransportRequest> getRequestHandler(java.lang.String action)

onConnectionClosed

public void onConnectionClosed(Transport.Connection connection)

Description copied from interface: TransportConnectionListener

Called once a connection ws closed.

Specified by:

onConnectionClosed in interface TransportConnectionListener

Parameters:

connection - the closed connection

getThreadPool

public ThreadPool getThreadPool()

Returns the internal thread pool