Class MockTransport

java.lang.Object

org.opensearch.test.transport.StubbableTransport

org.opensearch.test.transport.MockTransport

All Implemented Interfaces:

Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent, org.opensearch.transport.Transport

Direct Known Subclasses:

CapturingTransport, DisruptableMockTransport

public class MockTransport
extends StubbableTransport

A basic transport implementation that allows to intercept requests that have been sent

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.test.transport.StubbableTransport

StubbableTransport.OpenConnectionBehavior, StubbableTransport.RequestHandlingBehavior<Request extends org.opensearch.transport.TransportRequest>, StubbableTransport.SendRequestBehavior, StubbableTransport.WrappedConnection

Nested classes/interfaces inherited from interface org.opensearch.transport.Transport

org.opensearch.transport.Transport.Connection, org.opensearch.transport.Transport.RequestHandlers, org.opensearch.transport.Transport.ResponseContext<T extends org.opensearch.core.transport.TransportResponse>, org.opensearch.transport.Transport.ResponseHandlers

Constructor Summary

Constructors

Constructor	Description
MockTransport()

Method Summary

Modifier and Type	Method	Description
org.opensearch.transport.Transport.Connection	createConnection(org.opensearch.cluster.node.DiscoveryNode node)
org.opensearch.transport.TransportService	createTransportService(org.opensearch.common.settings.Settings settings, org.opensearch.threadpool.ThreadPool threadPool, org.opensearch.transport.TransportInterceptor interceptor, Function<org.opensearch.core.common.transport.BoundTransportAddress, org.opensearch.cluster.node.DiscoveryNode> localNodeFactory, org.opensearch.common.settings.ClusterSettings clusterSettings, Set<String> taskHeaders, org.opensearch.telemetry.tracing.Tracer tracer)
void	handleError(long requestId, org.opensearch.transport.TransportException e)	simulate an error for the given requestId, unlike handleLocalError(long, Throwable) and handleRemoteError(long, Throwable), the provided exception will not be wrapped but will be delivered to the transport layer as is
void	handleLocalError(long requestId, Throwable t)	simulate a local error for the given requestId, will be wrapped by a SendRequestTransportException
void	handleRemoteError(long requestId, Throwable t)	simulate a remote error for the given requestId, will be wrapped by a RemoteTransportException
<Response extends org.opensearch.core.transport.TransportResponse> void	handleResponse(long requestId, Response response)	simulate a response for the given requestId
protected void	onSendRequest(long requestId, String action, org.opensearch.transport.TransportRequest request, org.opensearch.cluster.node.DiscoveryNode node)
protected void	onSendRequest(long requestId, String action, org.opensearch.transport.TransportRequest request, org.opensearch.cluster.node.DiscoveryNode node, org.opensearch.transport.TransportRequestOptions options)
void	setMessageListener(org.opensearch.transport.TransportMessageListener listener)
protected org.opensearch.core.common.io.stream.NamedWriteableRegistry	writeableRegistry()

Methods inherited from class org.opensearch.test.transport.StubbableTransport

addLifecycleListener, addressesFromString, boundAddress, close, getDefaultSeedAddresses, getRequestHandlers, getResponseHandlers, getStats, lifecycleState, openConnection, profileBoundAddresses, removeLifecycleListener, setDefaultConnectBehavior, 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.opensearch.transport.Transport

isSecure, registerRequestHandler, setSlowLogThreshold

Constructor Details

MockTransport

public MockTransport()

Method Details

createTransportService

public org.opensearch.transport.TransportService createTransportService(org.opensearch.common.settings.Settings settings,
 org.opensearch.threadpool.ThreadPool threadPool,
 org.opensearch.transport.TransportInterceptor interceptor,
 Function<org.opensearch.core.common.transport.BoundTransportAddress, org.opensearch.cluster.node.DiscoveryNode> localNodeFactory,
 @Nullable
 org.opensearch.common.settings.ClusterSettings clusterSettings,
 Set<String> taskHeaders,
 org.opensearch.telemetry.tracing.Tracer tracer)

handleResponse

public <Response extends org.opensearch.core.transport.TransportResponse>
void handleResponse(long requestId,
 Response response)

simulate a response for the given requestId

handleLocalError

public void handleLocalError(long requestId,
 Throwable t)

simulate a local error for the given requestId, will be wrapped by a SendRequestTransportException

Parameters:

requestId - the id corresponding to the captured send request

t - the failure to wrap

handleRemoteError

public void handleRemoteError(long requestId,
 Throwable t)

simulate a remote error for the given requestId, will be wrapped by a RemoteTransportException

Parameters:

requestId - the id corresponding to the captured send request

t - the failure to wrap

handleError

public void handleError(long requestId,
 org.opensearch.transport.TransportException e)

simulate an error for the given requestId, unlike handleLocalError(long, Throwable) and handleRemoteError(long, Throwable), the provided exception will not be wrapped but will be delivered to the transport layer as is

Parameters:

requestId - the id corresponding to the captured send request

e - the failure

createConnection

public org.opensearch.transport.Transport.Connection createConnection(org.opensearch.cluster.node.DiscoveryNode node)

onSendRequest

protected void onSendRequest(long requestId,
 String action,
 org.opensearch.transport.TransportRequest request,
 org.opensearch.cluster.node.DiscoveryNode node)

onSendRequest

protected void onSendRequest(long requestId,
 String action,
 org.opensearch.transport.TransportRequest request,
 org.opensearch.cluster.node.DiscoveryNode node,
 org.opensearch.transport.TransportRequestOptions options)

setMessageListener

public void setMessageListener(org.opensearch.transport.TransportMessageListener listener)

Specified by:

setMessageListener in interface org.opensearch.transport.Transport

Overrides:

setMessageListener in class StubbableTransport

writeableRegistry

protected org.opensearch.core.common.io.stream.NamedWriteableRegistry writeableRegistry()