Class CapturingTransport

java.lang.Object

org.opensearch.test.transport.StubbableTransport

org.opensearch.test.transport.MockTransport

org.opensearch.test.transport.CapturingTransport

All Implemented Interfaces:

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

public class CapturingTransport
extends MockTransport
implements org.opensearch.transport.Transport

A transport class that doesn't send anything but rather captures all requests for inspection from tests

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapturingTransport.CapturedRequest

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
CapturingTransport()

Method Summary

Modifier and Type	Method	Description
CapturingTransport.CapturedRequest[]	capturedRequests()	returns all requests captured so far.
Map<String, List<CapturingTransport.CapturedRequest>>	capturedRequestsByTargetNode()	returns all requests captured so far, grouped by target node.
void	clear()	clears captured requests
CapturingTransport.CapturedRequest[]	getCapturedRequestsAndClear()	Returns all requests captured so far.
Map<String, List<CapturingTransport.CapturedRequest>>	getCapturedRequestsByTargetNodeAndClear()	Returns all requests captured so far, grouped by target node.
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)

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

createConnection, createTransportService, handleError, handleLocalError, handleRemoteError, handleResponse, setMessageListener, 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.common.lifecycle.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.opensearch.common.lease.Releasable

close

Methods inherited from interface org.opensearch.transport.Transport

addressesFromString, boundAddress, getDefaultSeedAddresses, getRequestHandlers, getResponseHandlers, getStats, isSecure, openConnection, profileBoundAddresses, registerRequestHandler, setMessageListener, setSlowLogThreshold

Constructor Details

CapturingTransport

public CapturingTransport()

Method Details

capturedRequests

public CapturingTransport.CapturedRequest[] capturedRequests()

returns all requests captured so far. Doesn't clear the captured request list. See clear()

getCapturedRequestsAndClear

public CapturingTransport.CapturedRequest[] getCapturedRequestsAndClear()

Returns all requests captured so far. This method does clear the captured requests list. If you do not want the captured requests list cleared, use capturedRequests().

Returns:

the captured requests

capturedRequestsByTargetNode

public Map<String, List<CapturingTransport.CapturedRequest>> capturedRequestsByTargetNode()

returns all requests captured so far, grouped by target node. Doesn't clear the captured request list. See clear()

getCapturedRequestsByTargetNodeAndClear

public Map<String, List<CapturingTransport.CapturedRequest>> getCapturedRequestsByTargetNodeAndClear()

Returns all requests captured so far, grouped by target node. This method does clear the captured request list. If you do not want the captured requests list cleared, use capturedRequestsByTargetNode().

Returns:

the captured requests grouped by target node

clear

public void clear()

clears captured requests

onSendRequest

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

Overrides:

onSendRequest in class MockTransport

onSendRequest

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

Overrides:

onSendRequest in class MockTransport