org.craftercms.search.elasticsearch.impl

Class ElasticsearchAdminServiceImpl

java.lang.Object

org.craftercms.search.elasticsearch.impl.ElasticsearchAdminServiceImpl

All Implemented Interfaces:

AutoCloseable, ElasticsearchAdminService

Direct Known Subclasses:

MultiElasticsearchAdminServiceImpl

public class ElasticsearchAdminServiceImpl
extends Object
implements ElasticsearchAdminService

Default implementation of ElasticsearchAdminService

Since:

3.1.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.io.Resource	authoringMapping Index mapping file for authoring indices
static String	DEFAULT_INDEX_NAME_SUFFIX
protected Map<String,String>	defaultSettings The default settings used when creating indices
protected org.elasticsearch.client.RestHighLevelClient	elasticsearchClient The Elasticsearch client
protected String	indexNameSuffix The suffix to add to all index names during creation
protected org.springframework.core.io.Resource	previewMapping Index mapping file for preview indices

Constructor Summary

Constructors

Constructor and Description
ElasticsearchAdminServiceImpl(org.springframework.core.io.Resource authoringMapping, org.springframework.core.io.Resource previewMapping, org.elasticsearch.client.RestHighLevelClient elasticsearchClient, Map<String,String> defaultSettings)

Method Summary

Modifier and Type	Method and Description
void	close()
void	createIndex(String aliasName, boolean isAuthoring) Creates an index
void	deleteIndexes(String aliasName) Deletes all indexes assigned to the given alias
protected void	doCreateIndex(org.elasticsearch.client.RestHighLevelClient client, String aliasName, String indexSuffix, boolean isAuthoring, boolean createAlias, Map<String,String> settings) Performs the index creation without any alias association
protected void	doCreateIndexAndAlias(org.elasticsearch.client.RestHighLevelClient client, String aliasName, boolean isAuthoring) Performs the index creation using the given Elasticsearch client
protected void	doCreateIndexAndAlias(org.elasticsearch.client.RestHighLevelClient client, String aliasName, String indexSuffix, boolean isAuthoring) Performs the index creation using the given Elasticsearch client
protected void	doDeleteIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName)
protected void	doDeleteIndexes(org.elasticsearch.client.RestHighLevelClient client, String aliasName) Performs the index delete using the given Elasticsearch client
protected Optional<String>	doGetIndexName(org.elasticsearch.client.RestHighLevelClient client, String aliasName)
protected Map<String,String>	doGetIndexSettings(org.elasticsearch.client.RestHighLevelClient client, String indexName)
protected void	doRecreateIndex(org.elasticsearch.client.RestHighLevelClient client, String aliasName, boolean isAuthoring) Performs all operations for recreating an index using the given Elasticsearch client
protected void	doReindex(org.elasticsearch.client.RestHighLevelClient client, String sourceIndex, String destinationIndex)
protected void	doSwap(org.elasticsearch.client.RestHighLevelClient client, String aliasName, String existingIndexName, String newIndexName)
protected void	doWaitUntilReady(org.elasticsearch.client.RestHighLevelClient client)
protected boolean	exists(org.elasticsearch.client.RestHighLevelClient client, String indexName) Checks if a given index already exists in Elasticsearch
void	recreateIndex(String aliasName, boolean isAuthoring) Recreates an existing index
void	setIndexNameSuffix(String indexNameSuffix)
void	waitUntilReady() Checks if the Elasticsearch cluster is ready to receive requests

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDEX_NAME_SUFFIX

public static final String DEFAULT_INDEX_NAME_SUFFIX

See Also:

Constant Field Values

indexNameSuffix

protected String indexNameSuffix

The suffix to add to all index names during creation

authoringMapping

protected org.springframework.core.io.Resource authoringMapping

Index mapping file for authoring indices

previewMapping

protected org.springframework.core.io.Resource previewMapping

Index mapping file for preview indices

elasticsearchClient

protected org.elasticsearch.client.RestHighLevelClient elasticsearchClient

The Elasticsearch client

defaultSettings

protected Map<String,String> defaultSettings

The default settings used when creating indices

Constructor Detail

ElasticsearchAdminServiceImpl

public ElasticsearchAdminServiceImpl(org.springframework.core.io.Resource authoringMapping,
                                     org.springframework.core.io.Resource previewMapping,
                                     org.elasticsearch.client.RestHighLevelClient elasticsearchClient,
                                     Map<String,String> defaultSettings)

Method Detail

setIndexNameSuffix

public void setIndexNameSuffix(String indexNameSuffix)

exists

protected boolean exists(org.elasticsearch.client.RestHighLevelClient client,
                         String indexName)

Checks if a given index already exists in Elasticsearch

Parameters:

client - the elasticsearch client

indexName - the index name

createIndex

public void createIndex(String aliasName,
                        boolean isAuthoring)
                 throws ElasticsearchException

Creates an index

Specified by:

createIndex in interface ElasticsearchAdminService

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

doCreateIndexAndAlias

protected void doCreateIndexAndAlias(org.elasticsearch.client.RestHighLevelClient client,
                                     String aliasName,
                                     boolean isAuthoring)

Performs the index creation using the given Elasticsearch client

doCreateIndexAndAlias

protected void doCreateIndexAndAlias(org.elasticsearch.client.RestHighLevelClient client,
                                     String aliasName,
                                     String indexSuffix,
                                     boolean isAuthoring)

Performs the index creation using the given Elasticsearch client

doCreateIndex

protected void doCreateIndex(org.elasticsearch.client.RestHighLevelClient client,
                             String aliasName,
                             String indexSuffix,
                             boolean isAuthoring,
                             boolean createAlias,
                             Map<String,String> settings)

Performs the index creation without any alias association

deleteIndexes

public void deleteIndexes(String aliasName)
                   throws ElasticsearchException

Deletes all indexes assigned to the given alias

Specified by:

deleteIndexes in interface ElasticsearchAdminService

Parameters:

aliasName - the name of the alias

Throws:

ElasticsearchException - if there is any error during the operation

doDeleteIndexes

protected void doDeleteIndexes(org.elasticsearch.client.RestHighLevelClient client,
                               String aliasName)

Performs the index delete using the given Elasticsearch client

recreateIndex

public void recreateIndex(String aliasName,
                          boolean isAuthoring)
                   throws ElasticsearchException

Recreates an existing index

Specified by:

recreateIndex in interface ElasticsearchAdminService

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

doRecreateIndex

protected void doRecreateIndex(org.elasticsearch.client.RestHighLevelClient client,
                               String aliasName,
                               boolean isAuthoring)

Performs all operations for recreating an index using the given Elasticsearch client

doGetIndexName

protected Optional<String> doGetIndexName(org.elasticsearch.client.RestHighLevelClient client,
                                          String aliasName)
                                   throws IOException

Throws:

IOException

doGetIndexSettings

protected Map<String,String> doGetIndexSettings(org.elasticsearch.client.RestHighLevelClient client,
                                                String indexName)
                                         throws IOException

Throws:

IOException

doReindex

protected void doReindex(org.elasticsearch.client.RestHighLevelClient client,
                         String sourceIndex,
                         String destinationIndex)
                  throws IOException

Throws:

IOException

doSwap

protected void doSwap(org.elasticsearch.client.RestHighLevelClient client,
                      String aliasName,
                      String existingIndexName,
                      String newIndexName)
               throws IOException

Throws:

IOException

doDeleteIndex

protected void doDeleteIndex(org.elasticsearch.client.RestHighLevelClient client,
                             String indexName)
                      throws IOException

Throws:

IOException

waitUntilReady

public void waitUntilReady()

Description copied from interface: ElasticsearchAdminService

Checks if the Elasticsearch cluster is ready to receive requests

Specified by:

waitUntilReady in interface ElasticsearchAdminService

doWaitUntilReady

protected void doWaitUntilReady(org.elasticsearch.client.RestHighLevelClient client)

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception