org.elasticsearch.cluster.routing.allocation.command

Class AllocationCommands

java.lang.Object

org.elasticsearch.cluster.routing.allocation.command.AllocationCommands

public class AllocationCommands
extends Object

A simple AllocationCommand composite managing several AllocationCommand implementations

Constructor Summary

Constructors

Constructor and Description
AllocationCommands(AllocationCommand... commands) Creates a new set of AllocationCommands

Method Summary

Methods

Modifier and Type	Method and Description
AllocationCommands	add(AllocationCommand... commands) Adds a set of commands to this collection
List<AllocationCommand>	commands() Get the commands wrapped by this instance
RoutingExplanations	execute(RoutingAllocation allocation, boolean explain) Executes all wrapped commands on a given RoutingAllocation
static AllocationCommands	fromXContent(XContentParser parser) Reads AllocationCommands from a XContentParser
static <T extends AllocationCommand> AllocationCommand.Factory<T>	lookupFactory(String name)
static <T extends AllocationCommand> AllocationCommand.Factory<T>	lookupFactorySafe(String name)
static AllocationCommands	readFrom(StreamInput in) Reads a AllocationCommands from a StreamInput
static void	registerFactory(String type, AllocationCommand.Factory factory) Register a custom index meta data factory.
static void	toXContent(AllocationCommands commands, XContentBuilder builder, ToXContent.Params params) Writes AllocationCommands to a XContentBuilder
static void	writeTo(AllocationCommands commands, StreamOutput out) Writes AllocationCommands to a StreamOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

AllocationCommands

public AllocationCommands(AllocationCommand... commands)

Creates a new set of AllocationCommands

Parameters:

commands - AllocationCommands that are wrapped by this instance

Method Detail

registerFactory

public static void registerFactory(String type,
                   AllocationCommand.Factory factory)

Register a custom index meta data factory. Make sure to call it from a static block.

lookupFactory

@Nullable
public static <T extends AllocationCommand> AllocationCommand.Factory<T> lookupFactory(String name)

lookupFactorySafe

public static <T extends AllocationCommand> AllocationCommand.Factory<T> lookupFactorySafe(String name)

add

public AllocationCommands add(AllocationCommand... commands)

Adds a set of commands to this collection

Parameters:

commands - Array of commands to add to this instance

Returns:

AllocationCommands with the given commands added

commands

public List<AllocationCommand> commands()

Get the commands wrapped by this instance

Returns:

List of commands

execute

public RoutingExplanations execute(RoutingAllocation allocation,
                          boolean explain)

Executes all wrapped commands on a given RoutingAllocation

Parameters:

allocation - RoutingAllocation to apply this command to

Throws:

ElasticsearchException - if something happens during execution

readFrom

public static AllocationCommands readFrom(StreamInput in)
                                   throws IOException

Reads a AllocationCommands from a StreamInput

Parameters:

in - StreamInput to read from

Returns:

AllocationCommands read

Throws:

IOException - if something happens during read

writeTo

public static void writeTo(AllocationCommands commands,
           StreamOutput out)
                    throws IOException

Writes AllocationCommands to a StreamOutput

Parameters:

commands - Commands to write

out - StreamOutput to write the commands to

Throws:

IOException - if something happens during write

fromXContent

public static AllocationCommands fromXContent(XContentParser parser)
                                       throws IOException

Reads AllocationCommands from a XContentParser

     {
         "commands" : [
              {"allocate" : {"index" : "test", "shard" : 0, "node" : "test"}}
         ]
     }
 

Parameters:

parser - XContentParser to read the commands from

Returns:

AllocationCommands read

Throws:

IOException - if something bad happens while reading the stream

toXContent

public static void toXContent(AllocationCommands commands,
              XContentBuilder builder,
              ToXContent.Params params)
                       throws IOException

Writes AllocationCommands to a XContentBuilder

Parameters:

commands - AllocationCommands to write

builder - XContentBuilder to use

params - Parameters to use for building

Throws:

IOException - if something bad happens while building the content