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

Class TransportCleanupRepositoryAction

java.lang.Object

org.elasticsearch.action.support.TransportAction<Request,Response>

org.elasticsearch.action.support.HandledTransportAction<Request,Response>

org.elasticsearch.action.support.master.TransportMasterNodeAction<CleanupRepositoryRequest,CleanupRepositoryResponse>

org.elasticsearch.action.admin.cluster.repositories.cleanup.TransportCleanupRepositoryAction

public final class TransportCleanupRepositoryAction
extends TransportMasterNodeAction<CleanupRepositoryRequest,CleanupRepositoryResponse>

Repository cleanup action for repository implementations based on BlobStoreRepository. The steps taken by the repository cleanup operation are as follows:

1. Check that there are no running repository cleanup, snapshot create, or snapshot delete actions and add an entry for the repository that is to be cleaned up to RepositoryCleanupInProgress
2. Run cleanup actions on the repository. Note, these are executed exclusively on the master node. For the precise operations execute see BlobStoreRepository.cleanup(long, org.elasticsearch.Version, org.elasticsearch.action.ActionListener<org.elasticsearch.repositories.RepositoryCleanupResult>)
3. Remove the entry in RepositoryCleanupInProgress in the first step.

On master failover during the cleanup operation it is simply removed from the cluster state. This is safe because the logic in BlobStoreRepository.cleanup(long, org.elasticsearch.Version, org.elasticsearch.action.ActionListener<org.elasticsearch.repositories.RepositoryCleanupResult>) ensures that the repository state id has not changed between creation of the cluster state entry and any delete/write operations. TODO: This will not work if we also want to clean up at the shard level as those will involve writes as well as deletes.

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

clusterService, executor, indexNameExpressionResolver, threadPool, transportService

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, localConnection, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportCleanupRepositoryAction(TransportService transportService, ClusterService clusterService, RepositoriesService repositoriesService, SnapshotsService snapshotsService, ThreadPool threadPool, ActionFilters actionFilters, IndexNameExpressionResolver indexNameExpressionResolver)

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkBlock(CleanupRepositoryRequest request, ClusterState state)
protected void	masterOperation(CleanupRepositoryRequest request, ClusterState state, ActionListener<CleanupRepositoryResponse> listener)

Methods inherited from class org.elasticsearch.action.support.master.TransportMasterNodeAction

doExecute, getMasterActionName, localExecute, masterOperation

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, execute, execute

Methods inherited from class java.lang.Object

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

Constructor Details

TransportCleanupRepositoryAction

@Inject
public TransportCleanupRepositoryAction(TransportService transportService,
 ClusterService clusterService,
 RepositoriesService repositoriesService,
 SnapshotsService snapshotsService,
 ThreadPool threadPool,
 ActionFilters actionFilters,
 IndexNameExpressionResolver indexNameExpressionResolver)

Method Details

masterOperation

protected void masterOperation(CleanupRepositoryRequest request,
 ClusterState state,
 ActionListener<CleanupRepositoryResponse> listener)

Specified by:

masterOperation in class TransportMasterNodeAction<CleanupRepositoryRequest,CleanupRepositoryResponse>

checkBlock

protected ClusterBlockException checkBlock(CleanupRepositoryRequest request,
 ClusterState state)

Specified by:

checkBlock in class TransportMasterNodeAction<CleanupRepositoryRequest,CleanupRepositoryResponse>