Package org.craftercms.engine.search.legacy

Class SiteAwareOpenSearchService

java.lang.Object

org.craftercms.search.opensearch.impl.AbstractOpenSearchWrapper

org.craftercms.engine.search.legacy.SiteAwareOpenSearchService

All Implemented Interfaces:

org.craftercms.search.opensearch.OpenSearchWrapper

public class SiteAwareOpenSearchService
extends org.craftercms.search.opensearch.impl.AbstractOpenSearchWrapper

Implementation of OpenSearchWrapper that sets the index based on the current site context for all search requests.

Since:

3.1

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	enableDefaultFilters
protected final 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.opensearch.impl.AbstractOpenSearchWrapper

client, filterQueries, logger, PARAM_NAME_INDEX, PARAM_NAME_SEARCH_TYPE

Constructor Summary

Constructors

Constructor	Description
SiteAwareOpenSearchService(org.opensearch.client.RestHighLevelClient client, String indexIdFormat, boolean enableTranslation, boolean enableDefaultFilters)

Method Summary

Modifier and Type	Method	Description
protected String	addPrefix(SiteContext siteContext, String name)
protected org.opensearch.index.query.BoolQueryBuilder	getDefaultFiltersQuery()	Builds the default filters query to be applied to all searches if enableDefaultFilters is set to true.
protected List<Locale>	getLocales()
void	setFallbackParameterName(String fallbackParameterName)
void	setLocalesParameterName(String localesParameterName)
void	setRoleFieldName(String roleFieldName)
protected void	updateFilters(org.opensearch.action.search.SearchRequest request)
protected void	updateIndex(org.opensearch.action.search.SearchRequest request)

Methods inherited from class org.craftercms.search.opensearch.impl.AbstractOpenSearchWrapper

search, search, search, setFilterQueries

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.opensearch.OpenSearchWrapper

search, search, search, search, search, search, search

Field Details

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

enableDefaultFilters

protected final boolean enableDefaultFilters

Constructor Details

SiteAwareOpenSearchService

@ConstructorProperties({"client","indexIdFormat","enableTranslation","enableDefaultFilters"})
public SiteAwareOpenSearchService(org.opensearch.client.RestHighLevelClient client,
 String indexIdFormat,
 boolean enableTranslation,
 boolean enableDefaultFilters)

Method Details

setRoleFieldName

public void setRoleFieldName(String roleFieldName)

setLocalesParameterName

public void setLocalesParameterName(String localesParameterName)

setFallbackParameterName

public void setFallbackParameterName(String fallbackParameterName)

getLocales

protected List<Locale> getLocales()

updateIndex

protected void updateIndex(org.opensearch.action.search.SearchRequest request)

Specified by:

updateIndex in class org.craftercms.search.opensearch.impl.AbstractOpenSearchWrapper

addPrefix

protected String addPrefix(SiteContext siteContext,
 String name)

updateFilters

protected void updateFilters(org.opensearch.action.search.SearchRequest request)

Overrides:

updateFilters in class org.craftercms.search.opensearch.impl.AbstractOpenSearchWrapper

getDefaultFiltersQuery

protected org.opensearch.index.query.BoolQueryBuilder getDefaultFiltersQuery()

Builds the default filters query to be applied to all searches if enableDefaultFilters is set to true.

Returns:

the default filters query