Package org.craftercms.engine.search

Class SiteAwareElasticsearchClient

java.lang.Object

org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

org.craftercms.engine.search.SiteAwareElasticsearchClient

All Implemented Interfaces:

org.craftercms.search.elasticsearch.client.ElasticsearchClientWrapper

public class SiteAwareElasticsearchClient
extends org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

Implementation of AbstractElasticsearchClientWrapper that sets the index and security filters based on the current site context for all search requests.

Since:

4.0.0

Author:

joseross

Nested Class Summary

Nested classes/interfaces inherited from class org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.RequestUpdates, org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.SearchRequestWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enableTranslation
protected String	fallbackParameterName
protected String	indexIdFormat	Format used to build the index id
protected String	localesParameterName
protected String	roleFieldName

Fields inherited from class org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

client, filterQueries, logger, PARAM_NAME_INDEX, PARAM_NAME_SEARCH_TYPE

Constructor Summary

Constructors

Constructor	Description
SiteAwareElasticsearchClient(co.elastic.clients.elasticsearch.ElasticsearchClient client, String indexIdFormat, boolean enableTranslation)

Method Summary

Modifier and Type	Method	Description
protected String	addPrefix(SiteContext siteContext, String name)
protected List<Locale>	getLocales()
void	setFallbackParameterName(String fallbackParameterName)
void	setLocalesParameterName(String localesParameterName)
void	setRoleFieldName(String roleFieldName)
protected void	updateIndex(co.elastic.clients.elasticsearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.RequestUpdates updates)
protected void	updateQuery(co.elastic.clients.elasticsearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.RequestUpdates updates)

Methods inherited from class org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

copyQuery, getRequestUpdates, search, setFilterQueries, updateIndicesOptions, updateSearchType

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.client.ElasticsearchClientWrapper

search, search, search

Field Detail

indexIdFormat

protected String indexIdFormat

Format used to build the index id

roleFieldName

protected String roleFieldName

localesParameterName

protected String localesParameterName

fallbackParameterName

protected String fallbackParameterName

enableTranslation

protected final boolean enableTranslation

Constructor Detail

SiteAwareElasticsearchClient

@ConstructorProperties({"client","indexIdFormat","enableTranslation"})
public SiteAwareElasticsearchClient(co.elastic.clients.elasticsearch.ElasticsearchClient client,
                                    String indexIdFormat,
                                    boolean enableTranslation)

Method Detail

setRoleFieldName

public void setRoleFieldName(String roleFieldName)

setLocalesParameterName

public void setLocalesParameterName(String localesParameterName)

setFallbackParameterName

public void setFallbackParameterName(String fallbackParameterName)

getLocales

protected List<Locale> getLocales()

addPrefix

protected String addPrefix(SiteContext siteContext,
                           String name)

updateIndex

protected void updateIndex(co.elastic.clients.elasticsearch.core.SearchRequest request,
                           Map<String,Object> parameters,
                           org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.RequestUpdates updates)

Overrides:

updateIndex in class org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper

updateQuery

protected void updateQuery(co.elastic.clients.elasticsearch.core.SearchRequest request,
                           Map<String,Object> parameters,
                           org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper.RequestUpdates updates)

Overrides:

updateQuery in class org.craftercms.search.elasticsearch.impl.client.AbstractElasticsearchClientWrapper