org.craftercms.search.elasticsearch

Interface ElasticsearchAdminService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ElasticsearchAdminServiceImpl, MultiElasticsearchAdminServiceImpl

public interface ElasticsearchAdminService
extends AutoCloseable

Provides operations to manage indices in Elasticsearch

Since:

3.1.0

Author:

joseross

Method Summary

Modifier and Type	Method and Description
void	createIndex(String aliasName, boolean isAuthoring) Creates an index
void	deleteIndexes(String aliasName) Deletes all indexes assigned to the given alias
void	recreateIndex(String aliasName, boolean isAuthoring) Recreates an existing index
void	waitUntilReady() Checks if the Elasticsearch cluster is ready to receive requests

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createIndex

void createIndex(String aliasName,
                 boolean isAuthoring)
          throws ElasticsearchException

Creates an index

Parameters:

aliasName - the name of the alias

isAuthoring - indicates if the index is for authoring

Throws:

ElasticsearchException - if there is any error during the operation

deleteIndexes

void deleteIndexes(String aliasName)
            throws ElasticsearchException

Deletes all indexes assigned to the given alias

Parameters:

aliasName - the name of the alias

Throws:

ElasticsearchException - if there is any error during the operation

recreateIndex

void recreateIndex(String aliasName,
                   boolean isAuthoring)
            throws ElasticsearchException

Recreates an existing index

Parameters:

aliasName - the name of the alias

isAuthoring - indicates if the index is for authoring

Throws:

ElasticsearchException - if there is any error during the operation

waitUntilReady

void waitUntilReady()

Checks if the Elasticsearch cluster is ready to receive requests