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

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.io.Resource	authoringIndexSettings Index settings file for authoring indices
static String	DEFAULT_INDEX_NAME_SUFFIX
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	previewIndexSettings Index settings file for preview indices

Constructor Summary

Constructors

Constructor and Description
ElasticsearchAdminServiceImpl(org.springframework.core.io.Resource authoringIndexSettings, org.springframework.core.io.Resource previewIndexSettings, org.elasticsearch.client.RestHighLevelClient elasticsearchClient)

Method Summary

Modifier and Type	Method and Description
void	close()
void	createIndex(String indexName, boolean isAuthoring) Creates an index
void	deleteIndex(String indexName) Deletes an index
protected void	doCreateIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName, boolean isAuthoring) Performs the index creation using the given Elasticsearch client
protected void	doDeleteIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName) Performs the index delete using the given Elasticsearch client
protected boolean	exists(org.elasticsearch.client.RestHighLevelClient client, String indexName) Checks if a given index already exists in Elasticsearch
void	setIndexNameSuffix(String indexNameSuffix)

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

authoringIndexSettings

protected org.springframework.core.io.Resource authoringIndexSettings

Index settings file for authoring indices

previewIndexSettings

protected org.springframework.core.io.Resource previewIndexSettings

Index settings file for preview indices

elasticsearchClient

protected org.elasticsearch.client.RestHighLevelClient elasticsearchClient

The Elasticsearch client

Constructor Detail

ElasticsearchAdminServiceImpl

public ElasticsearchAdminServiceImpl(org.springframework.core.io.Resource authoringIndexSettings,
                                     org.springframework.core.io.Resource previewIndexSettings,
                                     org.elasticsearch.client.RestHighLevelClient elasticsearchClient)

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 indexName,
                        boolean isAuthoring)
                 throws ElasticsearchException

Creates an index

Specified by:

createIndex in interface ElasticsearchAdminService

Parameters:

indexName - the name of the index

isAuthoring - indicates if the index if for authoring

Throws:

ElasticsearchException - if there is any error during the operation

doCreateIndex

protected void doCreateIndex(org.elasticsearch.client.RestHighLevelClient client,
                             String indexName,
                             boolean isAuthoring)

Performs the index creation using the given Elasticsearch client

deleteIndex

public void deleteIndex(String indexName)
                 throws ElasticsearchException

Deletes an index

Specified by:

deleteIndex in interface ElasticsearchAdminService

Parameters:

indexName - the name of the index

Throws:

ElasticsearchException - if there is any error during the operation

doDeleteIndex

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

Performs the index delete using the given Elasticsearch client

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception