Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.repositories.reservedstate

Class ReservedRepositoryAction

java.lang.Object

org.elasticsearch.action.admin.cluster.repositories.reservedstate.ReservedRepositoryAction

All Implemented Interfaces:

ReservedClusterStateHandler<List<PutRepositoryRequest>>, ReservedStateHandler<List<PutRepositoryRequest>>

public class ReservedRepositoryAction
extends Object
implements ReservedClusterStateHandler<List<PutRepositoryRequest>>

This Action is the reserved state save version of RestPutRepositoryAction/RestDeleteRepositoryAction

It is used by the ReservedClusterStateService to add/update or remove snapshot repositories. Typical usage for this action is in the context of file based settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface org.elasticsearch.reservedstate.ReservedStateHandler

RESERVED_CLUSTER_STATE_HANDLER_IGNORED_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
ReservedRepositoryAction(RepositoriesService repositoriesService)	Creates a ReservedRepositoryAction

Method Summary

Modifier and Type	Method	Description
List<PutRepositoryRequest>	fromXContent(XContentParser parser)	The parse content method which is called during parsing of file based content.
String	name()	Unique identifier for the handler.
Collection<PutRepositoryRequest>	prepare(Object input)
ClusterState	remove(TransformState prevState)	Called when the source no longer contains a section corresponding to ReservedStateHandler.name().
TransformState	transform(List<PutRepositoryRequest> source, TransformState prevState)	The transformation method implemented by the handler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.reservedstate.ReservedStateHandler

dependencies, optionalDependencies, validate

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

ReservedRepositoryAction

public ReservedRepositoryAction(RepositoriesService repositoriesService)

Creates a ReservedRepositoryAction

Parameters:

repositoriesService - requires RepositoriesService for the cluster state operations

Method Details

name

public String name()

Description copied from interface: ReservedStateHandler

Unique identifier for the handler.

The handler name is a unique identifier that is matched to a section in a cluster state update content. The reserved cluster state updates are done as a single cluster state update and the cluster state is typically supplied as a combined content, unlike the REST handlers. This name must match a desired content key name in the combined cluster state update, e.g. "ilm" or "cluster_settings" (for persistent cluster settings update).

Specified by:

name in interface ReservedStateHandler<List<PutRepositoryRequest>>

Returns:

a String with the handler name, e.g "ilm".

prepare

public Collection<PutRepositoryRequest> prepare(Object input)

transform

public TransformState transform(List<PutRepositoryRequest> source,
 TransformState prevState)
                         throws Exception

Description copied from interface: ReservedClusterStateHandler

The transformation method implemented by the handler.

The transform method of the handler should apply the necessary changes to the cluster state as it normally would in a REST handler. One difference is that the transform method in an reserved state handler must perform all CRUD operations of the cluster state in one go. For that reason, we supply a wrapper class to the cluster state called TransformState, which contains the current cluster state as well as any previous keys set by this handler on prior invocation.

Specified by:

transform in interface ReservedClusterStateHandler<List<PutRepositoryRequest>>

Parameters:

source - The parsed information specific to this handler from the combined cluster state content

prevState - The previous cluster state and keys set by this handler (if any)

Returns:

The modified state and the current keys set by this handler

Throws:

Exception

remove

public ClusterState remove(TransformState prevState)
                    throws Exception

Description copied from interface: ReservedClusterStateHandler

Called when the source no longer contains a section corresponding to ReservedStateHandler.name(). A bit like ReservedClusterStateHandler.transform(T, org.elasticsearch.reservedstate.TransformState), but with no source because the "source" has disappeared, and no keys in the return value because there aren't any.

The intent is to "cancel the reservation" and return the configuration to the state it would have had if the section had never existed.

Specified by:

remove in interface ReservedClusterStateHandler<List<PutRepositoryRequest>>

Throws:

Exception

fromXContent

public List<PutRepositoryRequest> fromXContent(XContentParser parser)
                                        throws IOException

Description copied from interface: ReservedStateHandler

The parse content method which is called during parsing of file based content.

The immutable state can be provided as XContent, which means that each handler needs to implement a method to convert an XContent to an object it can consume later in transform

Specified by:

fromXContent in interface ReservedStateHandler<List<PutRepositoryRequest>>

Parameters:

parser - the XContent parser we are parsing from

Returns:

Throws:

IOException