Class NoOpNodeClient

java.lang.Object
org.opensearch.transport.client.support.AbstractClient
org.opensearch.transport.client.node.NodeClient
org.opensearch.test.client.NoOpNodeClient
All Implemented Interfaces:
Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.transport.client.Client, org.opensearch.transport.client.OpenSearchClient
Direct Known Subclasses:
RestActionTestCase.VerifyingClient
public class NoOpNodeClient extends org.opensearch.transport.client.node.NodeClient
Client that always response with null to every request. Override doExecute(ActionType, ActionRequest, ActionListener), executeLocally(ActionType, ActionRequest, ActionListener), or executeLocally(ActionType, ActionRequest, TaskListener) for testing.

See also NoOpClient if you do not specifically need a NodeClient.

  • Field Summary

    Fields inherited from class org.opensearch.transport.client.support.AbstractClient

    logger, settings

    Fields inherited from interface org.opensearch.transport.client.Client

    CLIENT_TYPE_SETTING_S

  • Constructor Summary

    Constructors
    Constructor
    Description
    NoOpNodeClient(String testName)
    Create a new TestThreadPool for this client.
    NoOpNodeClient(org.opensearch.threadpool.ThreadPool threadPool)
    Build with ThreadPool.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse>
    void
    doExecute(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.core.action.ActionListener<Response> listener)
     
    <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse>
    org.opensearch.tasks.Task
    executeLocally(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.core.action.ActionListener<Response> listener)
     
    <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse>
    org.opensearch.tasks.Task
    executeLocally(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.tasks.TaskListener<Response> listener)
     
    String
    getLocalNodeId()
     
    org.opensearch.transport.client.Client
    getRemoteClusterClient(String clusterAlias)
     
    void
    initialize(org.opensearch.action.ActionModule.DynamicActionRegistry dynamicActionRegistry, Supplier<String> localNodeId, org.opensearch.transport.RemoteClusterService remoteClusterService, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)
     

    Methods inherited from class org.opensearch.transport.client.node.NodeClient

    getNamedWriteableRegistry, prepareStreamSearch

    Methods inherited from class org.opensearch.transport.client.support.AbstractClient

    admin, bulk, bulk, clearScroll, clearScroll, createPit, delete, delete, deletePits, execute, execute, explain, explain, fieldCaps, fieldCaps, filterWithHeader, get, get, getAllPits, index, index, listViewNames, listViewNames, multiGet, multiGet, multiSearch, multiSearch, multiTermVectors, multiTermVectors, pitSegments, prepareBulk, prepareBulk, prepareClearScroll, prepareDelete, prepareDelete, prepareExplain, prepareFieldCaps, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareMultiGet, prepareMultiSearch, prepareMultiTermVectors, prepareSearch, prepareSearchScroll, prepareTermVectors, prepareTermVectors, prepareUpdate, prepareUpdate, search, search, searchScroll, searchScroll, searchView, searchView, settings, termVectors, termVectors, threadPool, update, update

    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.client.Client

    bulkAsync, clearScrollAsync, deleteAsync, explainAsync, fieldCapsAsync, getAsync, indexAsync, listViewNamesAsync, multiGetAsync, multiSearchAsync, multiTermVectorsAsync, searchAsync, searchScrollAsync, searchViewAsync, termVectorsAsync, updateAsync

  • Constructor Details

    • NoOpNodeClient

      public NoOpNodeClient(org.opensearch.threadpool.ThreadPool threadPool)
      Build with ThreadPool. This ThreadPool is terminated on close().

    • NoOpNodeClient

      public NoOpNodeClient(String testName)
      Create a new TestThreadPool for this client. This TestThreadPool is terminated on close().

  • Method Details

    • doExecute

      public <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse> void doExecute(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.core.action.ActionListener<Response> listener)
      Overrides:
      doExecute in class org.opensearch.transport.client.node.NodeClient

    • initialize

      public void initialize(org.opensearch.action.ActionModule.DynamicActionRegistry dynamicActionRegistry, Supplier<String> localNodeId, org.opensearch.transport.RemoteClusterService remoteClusterService, org.opensearch.core.common.io.stream.NamedWriteableRegistry namedWriteableRegistry)
      Overrides:
      initialize in class org.opensearch.transport.client.node.NodeClient

    • executeLocally

      public <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse> org.opensearch.tasks.Task executeLocally(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.core.action.ActionListener<Response> listener)
      Overrides:
      executeLocally in class org.opensearch.transport.client.node.NodeClient

    • executeLocally

      public <Request extends org.opensearch.action.ActionRequest, Response extends org.opensearch.core.action.ActionResponse> org.opensearch.tasks.Task executeLocally(org.opensearch.action.ActionType<Response> action, Request request, org.opensearch.tasks.TaskListener<Response> listener)
      Overrides:
      executeLocally in class org.opensearch.transport.client.node.NodeClient

    • getLocalNodeId

      public String getLocalNodeId()
      Overrides:
      getLocalNodeId in class org.opensearch.transport.client.node.NodeClient

    • getRemoteClusterClient

      public org.opensearch.transport.client.Client getRemoteClusterClient(String clusterAlias)
      Specified by:
      getRemoteClusterClient in interface org.opensearch.transport.client.Client
      Overrides:
      getRemoteClusterClient in class org.opensearch.transport.client.node.NodeClient

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface org.opensearch.common.lease.Releasable
      Overrides:
      close in class org.opensearch.transport.client.node.NodeClient