org.elasticsearch.repositories

Class RepositoriesService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.repositories.RepositoriesService

All Implemented Interfaces:

ClusterStateListener

public class RepositoriesService
extends AbstractComponent
implements ClusterStateListener

Service responsible for maintaining and providing access to snapshot repositories on nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RepositoriesService.RegisterRepositoryRequest Register repository request
static class	RepositoriesService.UnregisterRepositoryRequest Unregister repository request
static class	RepositoriesService.VerifyResponse Verify repository request

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RepositoriesService(Settings settings, ClusterService clusterService, TransportService transportService, RepositoryTypesRegistry typesRegistry, Injector injector)

Method Summary

Methods

Modifier and Type	Method and Description
void	clusterChanged(ClusterChangedEvent event) Checks if new repositories appeared in or disappeared from cluster metadata and updates current list of repositories accordingly.
IndexShardRepository	indexShardRepository(String repository) Returns registered index shard repository
void	registerRepository(RepositoriesService.RegisterRepositoryRequest request, ActionListener<ClusterStateUpdateResponse> listener) Registers new repository in the cluster
Repository	repository(String repository) Returns registered repository
void	unregisterRepository(RepositoriesService.UnregisterRepositoryRequest request, ActionListener<ClusterStateUpdateResponse> listener) Unregisters repository in the cluster
void	verifyRepository(String repositoryName, ActionListener<RepositoriesService.VerifyResponse> listener)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoriesService

@Inject
public RepositoriesService(Settings settings,
                          ClusterService clusterService,
                          TransportService transportService,
                          RepositoryTypesRegistry typesRegistry,
                          Injector injector)

Method Detail

registerRepository

public void registerRepository(RepositoriesService.RegisterRepositoryRequest request,
                      ActionListener<ClusterStateUpdateResponse> listener)

Registers new repository in the cluster

This method can be only called on the master node. It tries to create a new repository on the master and if it was successful it adds new repository to cluster metadata.

Parameters:

request - register repository request

listener - register repository listener

unregisterRepository

public void unregisterRepository(RepositoriesService.UnregisterRepositoryRequest request,
                        ActionListener<ClusterStateUpdateResponse> listener)

Unregisters repository in the cluster

This method can be only called on the master node. It removes repository information from cluster metadata.

Parameters:

request - unregister repository request

listener - unregister repository listener

verifyRepository

public void verifyRepository(String repositoryName,
                    ActionListener<RepositoriesService.VerifyResponse> listener)

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Checks if new repositories appeared in or disappeared from cluster metadata and updates current list of repositories accordingly.

Specified by:

clusterChanged in interface ClusterStateListener

Parameters:

event - cluster changed event

repository

public Repository repository(String repository)

Returns registered repository

This method is called only on the master node

Parameters:

repository - repository name

Returns:

registered repository

Throws:

RepositoryMissingException - if repository with such name isn't registered

indexShardRepository

public IndexShardRepository indexShardRepository(String repository)

Returns registered index shard repository

This method is called only on data nodes

Parameters:

repository - repository name

Returns:

registered repository

Throws:

RepositoryMissingException - if repository with such name isn't registered