org.elasticsearch.cluster.routing.allocation.command

Class AbstractAllocateAllocationCommand

java.lang.Object

org.elasticsearch.cluster.routing.allocation.command.AbstractAllocateAllocationCommand

All Implemented Interfaces:

AllocationCommand, NamedWriteable, Writeable, ToXContent

Direct Known Subclasses:

AllocateReplicaAllocationCommand, BasePrimaryAllocationCommand

public abstract class AbstractAllocateAllocationCommand
extends java.lang.Object
implements AllocationCommand

Abstract base class for allocating an unassigned shard to a node

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAllocateAllocationCommand.Builder<T extends AbstractAllocateAllocationCommand> Works around ObjectParser not supporting constructor arguments.

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.routing.allocation.command.AllocationCommand

AllocationCommand.Parser<T extends AllocationCommand>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<R>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	index
protected java.lang.String	node
protected int	shardId

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAllocateAllocationCommand(StreamInput in) Read from a stream.
protected	AbstractAllocateAllocationCommand(java.lang.String index, int shardId, java.lang.String node)

Method Summary

Modifier and Type	Method and Description
protected static <T extends AbstractAllocateAllocationCommand.Builder<?>> ObjectParser<T,ParseFieldMatcherSupplier>	createAllocateParser(java.lang.String command)
protected RerouteExplanation	explainOrThrowMissingRoutingNode(RoutingAllocation allocation, boolean explain, DiscoveryNode discoNode) Handle case where a disco node cannot be found in the routing table.
protected RerouteExplanation	explainOrThrowRejectedCommand(boolean explain, RoutingAllocation allocation, java.lang.RuntimeException rte) Utility method for rejecting the current allocation command based on provided exception
protected RerouteExplanation	explainOrThrowRejectedCommand(boolean explain, RoutingAllocation allocation, java.lang.String reason) Utility method for rejecting the current allocation command based on provided reason
protected void	extraXContent(XContentBuilder builder)
java.lang.String	index() Get the index name
protected void	initializeUnassignedShard(RoutingAllocation allocation, RoutingNodes routingNodes, RoutingNode routingNode, ShardRouting shardRouting) Initializes an unassigned shard on a node and removes it from the unassigned
protected void	initializeUnassignedShard(RoutingAllocation allocation, RoutingNodes routingNodes, RoutingNode routingNode, ShardRouting shardRouting, java.util.function.Consumer<ShardRouting> shardRoutingChanges) Initializes an unassigned shard on a node and removes it from the unassigned
java.lang.String	node() Get the id of the node
int	shardId() Get the shard id
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.routing.allocation.command.AllocationCommand

execute, getWriteableName, name

Field Detail

index

protected final java.lang.String index

shardId

protected final int shardId

node

protected final java.lang.String node

Constructor Detail

AbstractAllocateAllocationCommand

protected AbstractAllocateAllocationCommand(java.lang.String index,
                                            int shardId,
                                            java.lang.String node)

AbstractAllocateAllocationCommand

protected AbstractAllocateAllocationCommand(StreamInput in)
                                     throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

createAllocateParser

protected static <T extends AbstractAllocateAllocationCommand.Builder<?>> ObjectParser<T,ParseFieldMatcherSupplier> createAllocateParser(java.lang.String command)

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

index

public java.lang.String index()

Get the index name

Returns:

name of the index

shardId

public int shardId()

Get the shard id

Returns:

id of the shard

node

public java.lang.String node()

Get the id of the node

Returns:

id of the node

explainOrThrowMissingRoutingNode

protected RerouteExplanation explainOrThrowMissingRoutingNode(RoutingAllocation allocation,
                                                              boolean explain,
                                                              DiscoveryNode discoNode)

Handle case where a disco node cannot be found in the routing table. Usually means that it's not a data node.

explainOrThrowRejectedCommand

protected RerouteExplanation explainOrThrowRejectedCommand(boolean explain,
                                                           RoutingAllocation allocation,
                                                           java.lang.String reason)

Utility method for rejecting the current allocation command based on provided reason

explainOrThrowRejectedCommand

protected RerouteExplanation explainOrThrowRejectedCommand(boolean explain,
                                                           RoutingAllocation allocation,
                                                           java.lang.RuntimeException rte)

Utility method for rejecting the current allocation command based on provided exception

initializeUnassignedShard

protected void initializeUnassignedShard(RoutingAllocation allocation,
                                         RoutingNodes routingNodes,
                                         RoutingNode routingNode,
                                         ShardRouting shardRouting)

Initializes an unassigned shard on a node and removes it from the unassigned

Parameters:

allocation - the allocation

routingNodes - the routing nodes

routingNode - the node to initialize it to

shardRouting - the shard routing that is to be matched in unassigned shards

initializeUnassignedShard

protected void initializeUnassignedShard(RoutingAllocation allocation,
                                         RoutingNodes routingNodes,
                                         RoutingNode routingNode,
                                         ShardRouting shardRouting,
                                         @Nullable
                                         java.util.function.Consumer<ShardRouting> shardRoutingChanges)

Initializes an unassigned shard on a node and removes it from the unassigned

Parameters:

allocation - the allocation

routingNodes - the routing nodes

routingNode - the node to initialize it to

shardRouting - the shard routing that is to be matched in unassigned shards

shardRoutingChanges - changes to apply for shard routing in unassigned shards before initialization

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

extraXContent

protected void extraXContent(XContentBuilder builder)
                      throws java.io.IOException

Throws:

java.io.IOException