Package org.elasticsearch.test.transport

Class CapturingTransport

java.lang.Object

org.elasticsearch.test.transport.CapturingTransport

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, Transport

public class CapturingTransport
extends java.lang.Object
implements 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 interface org.elasticsearch.transport.Transport

Transport.Connection, Transport.ResponseContext<T extends TransportResponse>, Transport.ResponseHandlers

Constructor Summary

Constructors

Constructor	Description
CapturingTransport()

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(LifecycleListener listener)
void	addMessageListener(TransportMessageListener listener)
TransportAddress[]	addressesFromString(java.lang.String address, int perAddressLimit)
BoundTransportAddress	boundAddress()
CapturingTransport.CapturedRequest[]	capturedRequests()	returns all requests captured so far.
java.util.Map<java.lang.String,java.util.List<CapturingTransport.CapturedRequest>>	capturedRequestsByTargetNode()	returns all requests captured so far, grouped by target node.
void	clear()	clears captured requests
void	close()
TransportService	createCapturingTransportService(Settings settings, ThreadPool threadPool, TransportInterceptor interceptor, java.util.function.Function<BoundTransportAddress,DiscoveryNode> localNodeFactory, ClusterSettings clusterSettings, java.util.Set<java.lang.String> taskHeaders)
CapturingTransport.CapturedRequest[]	getCapturedRequestsAndClear()	Returns all requests captured so far.
java.util.Map<java.lang.String,java.util.List<CapturingTransport.CapturedRequest>>	getCapturedRequestsByTargetNodeAndClear()	Returns all requests captured so far, grouped by target node.
java.util.List<java.lang.String>	getLocalAddresses()
RequestHandlerRegistry	getRequestHandler(java.lang.String action)
Transport.ResponseHandlers	getResponseHandlers()
TransportStats	getStats()
void	handleError(long requestId, 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, java.lang.Throwable t)	simulate a local error for the given requestId, will be wrapped by a SendRequestTransportException
void	handleRemoteError(long requestId, java.lang.Throwable t)	simulate a remote error for the given requestId, will be wrapped by a RemoteTransportException
<Response extends TransportResponse> void	handleResponse(long requestId, Response response)	simulate a response for the given requestId
Lifecycle.State	lifecycleState()
protected boolean	nodeConnected(DiscoveryNode discoveryNode)
protected void	onSendRequest(long requestId, java.lang.String action, TransportRequest request, DiscoveryNode node)
Releasable	openConnection(DiscoveryNode node, ConnectionProfile profile, ActionListener<Transport.Connection> listener)
java.util.Map<java.lang.String,BoundTransportAddress>	profileBoundAddresses()
<Request extends TransportRequest> void	registerRequestHandler(RequestHandlerRegistry<Request> reg)
void	removeLifecycleListener(LifecycleListener listener)
boolean	removeMessageListener(TransportMessageListener listener)
void	start()
void	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.Transport

getInFlightRequestBreaker

Constructor Detail

CapturingTransport

public CapturingTransport()

Method Detail

createCapturingTransportService

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

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 java.util.Map<java.lang.String,java.util.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 java.util.Map<java.lang.String,java.util.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

handleResponse

public <Response extends TransportResponse> void handleResponse(long requestId,
                                                                Response response)

simulate a response for the given requestId

handleLocalError

public void handleLocalError(long requestId,
                             java.lang.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,
                              java.lang.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,
                        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

openConnection

public Releasable openConnection(DiscoveryNode node,
                                 ConnectionProfile profile,
                                 ActionListener<Transport.Connection> listener)

Specified by:

openConnection in interface Transport

onSendRequest

protected void onSendRequest(long requestId,
                             java.lang.String action,
                             TransportRequest request,
                             DiscoveryNode node)

nodeConnected

protected boolean nodeConnected(DiscoveryNode discoveryNode)

getStats

public TransportStats getStats()

Specified by:

getStats in interface Transport

boundAddress

public BoundTransportAddress boundAddress()

Specified by:

boundAddress in interface Transport

profileBoundAddresses

public java.util.Map<java.lang.String,BoundTransportAddress> profileBoundAddresses()

Specified by:

profileBoundAddresses in interface Transport

addressesFromString

public TransportAddress[] addressesFromString(java.lang.String address,
                                              int perAddressLimit)

Specified by:

addressesFromString in interface Transport

lifecycleState

public Lifecycle.State lifecycleState()

Specified by:

lifecycleState in interface LifecycleComponent

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Specified by:

addLifecycleListener in interface LifecycleComponent

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Specified by:

removeLifecycleListener in interface LifecycleComponent

start

public void start()

Specified by:

start in interface LifecycleComponent

stop

public void stop()

Specified by:

stop in interface LifecycleComponent

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable

getLocalAddresses

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

Specified by:

getLocalAddresses in interface Transport

registerRequestHandler

public <Request extends TransportRequest> void registerRequestHandler(RequestHandlerRegistry<Request> reg)

Specified by:

registerRequestHandler in interface Transport

getResponseHandlers

public Transport.ResponseHandlers getResponseHandlers()

Specified by:

getResponseHandlers in interface Transport

getRequestHandler

public RequestHandlerRegistry getRequestHandler(java.lang.String action)

Specified by:

getRequestHandler in interface Transport

addMessageListener

public void addMessageListener(TransportMessageListener listener)

Specified by:

addMessageListener in interface Transport

removeMessageListener

public boolean removeMessageListener(TransportMessageListener listener)

Specified by:

removeMessageListener in interface Transport