Class TestGatewayAllocator

java.lang.Object
org.opensearch.gateway.GatewayAllocator
org.opensearch.test.gateway.TestGatewayAllocator
All Implemented Interfaces:
org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
public class TestGatewayAllocator extends org.opensearch.gateway.GatewayAllocator
A gateway allocator implementation that keeps an in memory list of started shard allocation that are used as replies to the, normally async, fetch data requests. The in memory list is adapted when shards are started and failed.

Nodes leaving and joining the cluster do not change the list of shards the class tracks but rather serves as a filter to what is returned by fetch data. Concretely - fetch data will only return shards that were started on nodes that are currently part of the cluster.

For now only primary shard related data is fetched. Replica request always get an empty response.

This class is useful to use in unit tests that require the functionality of GatewayAllocator but do not have all the infrastructure required to use it.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator

    org.opensearch.cluster.routing.allocation.ExistingShardsAllocator.UnassignedAllocationHandler

  • Field Summary

    Fields inherited from class org.opensearch.gateway.GatewayAllocator

    ALLOCATOR_NAME

    Fields inherited from interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator

    EXISTING_SHARDS_ALLOCATOR_BATCH_MODE, EXISTING_SHARDS_ALLOCATOR_SETTING

  • Constructor Summary

    Constructors
    Constructor
    Description
    TestGatewayAllocator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addKnownAllocation(org.opensearch.cluster.routing.ShardRouting shard)
    manually add a specific shard to the allocations the gateway keeps track of
    void
    addReplicationCheckpoint(org.opensearch.core.index.shard.ShardId shardId, String nodeName, org.opensearch.indices.replication.checkpoint.ReplicationCheckpoint replicationCheckpoint)
     
    void
    afterPrimariesBeforeReplicas(org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
     
    void
    allocateUnassigned(org.opensearch.cluster.routing.ShardRouting shardRouting, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation, org.opensearch.cluster.routing.allocation.ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)
     
    void
    applyFailedShards(List<org.opensearch.cluster.routing.allocation.FailedShard> failedShards, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
     
    void
    applyStartedShards(List<org.opensearch.cluster.routing.ShardRouting> startedShards, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
     
    void
    beforeAllocation(org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
     
    String
    getReplicationCheckPointKey(org.opensearch.core.index.shard.ShardId shardId, String nodeName)
     

    Methods inherited from class org.opensearch.gateway.GatewayAllocator

    cleanCaches, explainUnassignedShardAllocation, getNumberOfInFlightFetches, innerAllocatedUnassigned

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator

    allocateAllUnassignedShards

  • Constructor Details

    • TestGatewayAllocator

      public TestGatewayAllocator()

  • Method Details

    • applyStartedShards

      public void applyStartedShards(List<org.opensearch.cluster.routing.ShardRouting> startedShards, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
      Specified by:
      applyStartedShards in interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
      Overrides:
      applyStartedShards in class org.opensearch.gateway.GatewayAllocator

    • applyFailedShards

      public void applyFailedShards(List<org.opensearch.cluster.routing.allocation.FailedShard> failedShards, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
      Specified by:
      applyFailedShards in interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
      Overrides:
      applyFailedShards in class org.opensearch.gateway.GatewayAllocator

    • beforeAllocation

      public void beforeAllocation(org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
      Specified by:
      beforeAllocation in interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
      Overrides:
      beforeAllocation in class org.opensearch.gateway.GatewayAllocator

    • afterPrimariesBeforeReplicas

      public void afterPrimariesBeforeReplicas(org.opensearch.cluster.routing.allocation.RoutingAllocation allocation)
      Specified by:
      afterPrimariesBeforeReplicas in interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
      Overrides:
      afterPrimariesBeforeReplicas in class org.opensearch.gateway.GatewayAllocator

    • allocateUnassigned

      public void allocateUnassigned(org.opensearch.cluster.routing.ShardRouting shardRouting, org.opensearch.cluster.routing.allocation.RoutingAllocation allocation, org.opensearch.cluster.routing.allocation.ExistingShardsAllocator.UnassignedAllocationHandler unassignedAllocationHandler)
      Specified by:
      allocateUnassigned in interface org.opensearch.cluster.routing.allocation.ExistingShardsAllocator
      Overrides:
      allocateUnassigned in class org.opensearch.gateway.GatewayAllocator

    • addKnownAllocation

      public void addKnownAllocation(org.opensearch.cluster.routing.ShardRouting shard)
      manually add a specific shard to the allocations the gateway keeps track of

    • getReplicationCheckPointKey

      public String getReplicationCheckPointKey(org.opensearch.core.index.shard.ShardId shardId, String nodeName)

    • addReplicationCheckpoint

      public void addReplicationCheckpoint(org.opensearch.core.index.shard.ShardId shardId, String nodeName, org.opensearch.indices.replication.checkpoint.ReplicationCheckpoint replicationCheckpoint)