org.craftercms.search.elasticsearch.impl

Class ElasticsearchServiceImpl

java.lang.Object

org.craftercms.search.elasticsearch.impl.ElasticsearchServiceImpl

All Implemented Interfaces:

AutoCloseable, ElasticsearchService

Direct Known Subclasses:

MultiElasticsearchServiceImpl

public class ElasticsearchServiceImpl
extends Object
implements ElasticsearchService

Default implementation of ElasticsearchService

Author:

joseross

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DOC According to Elasticsearch documentation this will be removed and this is the recommended value
static String	DEFAULT_LOCAL_ID_NAME
static int	DEFAULT_SCROLL_SIZE
static String	DEFAULT_SCROLL_TIMEOUT
protected ElasticsearchDocumentBuilder	documentBuilder Document Builder
protected DocumentParser	documentParser Document Parser
protected org.elasticsearch.client.RestHighLevelClient	elasticsearchClient The Elasticsearch client
protected String	localIdFieldName The name of the field for full ids
protected int	scrollSize The number of results to return for each scroll request
protected String	scrollTimeout The timeout for each the scroll request

Constructor Summary

Constructors

Constructor and Description
ElasticsearchServiceImpl(ElasticsearchDocumentBuilder documentBuilder, DocumentParser documentParser, org.elasticsearch.client.RestHighLevelClient elasticsearchClient)

Method Summary

Modifier and Type	Method and Description
void	close()
void	delete(String indexName, String siteName, String docId) Performs a delete for the given document
protected void	doDelete(org.elasticsearch.client.RestHighLevelClient client, String indexName, String siteName, String docId) Performs the delete operation using the given Elasticsearch client
protected void	doIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName, String siteName, String docId, Map<String,Object> doc) Performs the index operation using the given Elasticsearch client
protected void	doRefresh(org.elasticsearch.client.RestHighLevelClient client, String indexName) Performs the refresh operation using the given Elasticsearch client
protected String	getId(String path) Hashes the full path to use as a unique id for Elasticsearch
void	index(String indexName, String siteName, String docId, Map<String,Object> doc)
void	index(String indexName, String siteName, String docId, String xml, org.springframework.util.MultiValueMap<String,String> additionalFields) Performs an index for the given xml file
void	indexBinary(String indexName, String siteName, String path, org.springframework.util.MultiValueMap<String,String> additionalFields, org.craftercms.core.service.Content content) Performs an index for the given binary file
void	indexBinary(String indexName, String siteName, String path, org.springframework.util.MultiValueMap<String,String> additionalFields, org.springframework.core.io.Resource resource)
void	refresh(String indexName) Performs a refresh for a given index
List<String>	searchField(String indexName, String field, org.elasticsearch.index.query.QueryBuilder queryBuilder) Performs a search for a specific field
Map<String,Object>	searchId(String indexName, String docId)
void	setLocalIdFieldName(String localIdFieldName)
void	setScrollSize(int scrollSize)
void	setScrollTimeout(String scrollTimeout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.search.elasticsearch.ElasticsearchService

index

Field Detail

DEFAULT_DOC

public static final String DEFAULT_DOC

According to Elasticsearch documentation this will be removed and this is the recommended value

See Also:

Constant Field Values

DEFAULT_LOCAL_ID_NAME

public static final String DEFAULT_LOCAL_ID_NAME

See Also:

Constant Field Values

DEFAULT_SCROLL_SIZE

public static final int DEFAULT_SCROLL_SIZE

See Also:

Constant Field Values

DEFAULT_SCROLL_TIMEOUT

public static final String DEFAULT_SCROLL_TIMEOUT

See Also:

Constant Field Values

documentBuilder

protected ElasticsearchDocumentBuilder documentBuilder

Document Builder

documentParser

protected DocumentParser documentParser

Document Parser

elasticsearchClient

protected org.elasticsearch.client.RestHighLevelClient elasticsearchClient

The Elasticsearch client

localIdFieldName

protected String localIdFieldName

The name of the field for full ids

scrollSize

protected int scrollSize

The number of results to return for each scroll request

scrollTimeout

protected String scrollTimeout

The timeout for each the scroll request

Constructor Detail

ElasticsearchServiceImpl

public ElasticsearchServiceImpl(ElasticsearchDocumentBuilder documentBuilder,
                                DocumentParser documentParser,
                                org.elasticsearch.client.RestHighLevelClient elasticsearchClient)

Method Detail

setLocalIdFieldName

public void setLocalIdFieldName(String localIdFieldName)

setScrollSize

public void setScrollSize(int scrollSize)

setScrollTimeout

public void setScrollTimeout(String scrollTimeout)

searchField

public List<String> searchField(String indexName,
                                String field,
                                org.elasticsearch.index.query.QueryBuilder queryBuilder)
                         throws ElasticsearchException

Performs a search for a specific field

Specified by:

searchField in interface ElasticsearchService

Parameters:

indexName - the name of the index

field - the name of the field

queryBuilder - the filters to apply

Returns:

the list of values that match the search

Throws:

ElasticsearchException - if there is any error during the operation

searchId

public Map<String,Object> searchId(String indexName,
                                   String docId)

Specified by:

searchId in interface ElasticsearchService

index

public void index(String indexName,
                  String siteName,
                  String docId,
                  Map<String,Object> doc)

Specified by:

index in interface ElasticsearchService

doIndex

protected void doIndex(org.elasticsearch.client.RestHighLevelClient client,
                       String indexName,
                       String siteName,
                       String docId,
                       Map<String,Object> doc)

Performs the index operation using the given Elasticsearch client

index

public void index(String indexName,
                  String siteName,
                  String docId,
                  String xml,
                  org.springframework.util.MultiValueMap<String,String> additionalFields)
           throws ElasticsearchException

Performs an index for the given xml file

Specified by:

index in interface ElasticsearchService

Parameters:

indexName - the name of the index

siteName - the name of the site

docId - the id of the document

xml - the content of the document

additionalFields - additional fields to index

Throws:

ElasticsearchException - if there is any error during the operation

indexBinary

public void indexBinary(String indexName,
                        String siteName,
                        String path,
                        org.springframework.util.MultiValueMap<String,String> additionalFields,
                        org.craftercms.core.service.Content content)
                 throws ElasticsearchException

Performs an index for the given binary file

Specified by:

indexBinary in interface ElasticsearchService

Parameters:

indexName - the name of the index

siteName - the name of the site

path - the path of the document

additionalFields - the additional fields to index

content - the content of the document

Throws:

ElasticsearchException - if there is any error during the operation

indexBinary

public void indexBinary(String indexName,
                        String siteName,
                        String path,
                        org.springframework.util.MultiValueMap<String,String> additionalFields,
                        org.springframework.core.io.Resource resource)
                 throws ElasticsearchException

Specified by:

indexBinary in interface ElasticsearchService

Throws:

ElasticsearchException

delete

public void delete(String indexName,
                   String siteName,
                   String docId)
            throws ElasticsearchException

Performs a delete for the given document

Specified by:

delete in interface ElasticsearchService

Parameters:

indexName - the name of the index

siteName - the id of the site

docId - the id of the document

Throws:

ElasticsearchException - if there is any error during the operation

doDelete

protected void doDelete(org.elasticsearch.client.RestHighLevelClient client,
                        String indexName,
                        String siteName,
                        String docId)

Performs the delete operation using the given Elasticsearch client

refresh

public void refresh(String indexName)
             throws ElasticsearchException

Performs a refresh for a given index

Specified by:

refresh in interface ElasticsearchService

Parameters:

indexName - the name of the index

Throws:

ElasticsearchException - if there is any error during the operation

doRefresh

protected void doRefresh(org.elasticsearch.client.RestHighLevelClient client,
                         String indexName)
                  throws ElasticsearchException

Performs the refresh operation using the given Elasticsearch client

Throws:

ElasticsearchException

getId

protected String getId(String path)

Hashes the full path to use as a unique id for Elasticsearch

Parameters:

path - the path of the file

Returns:

MD5 hash for the path

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception