Package org.craftercms.search.opensearch.impl.client

Class AbstractOpenSearchClientWrapper

java.lang.Object

org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper

All Implemented Interfaces:

OpenSearchClientWrapper

public abstract class AbstractOpenSearchClientWrapper
extends Object
implements OpenSearchClientWrapper

Base implementation of OpenSearchClientWrapper

Since:

4.0.0

Author:

joseross

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOpenSearchClientWrapper.RequestUpdates
class	AbstractOpenSearchClientWrapper.SearchRequestWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.opensearch.client.opensearch.OpenSearchClient	client	The OpenSearch client
protected String[]	filterQueries	The filter queries to apply to all searches
protected final org.slf4j.Logger	logger
static final String	PARAM_NAME_INDEX
static final String	PARAM_NAME_SEARCH_TYPE
protected static final String	TOO_MANY_NESTED_CLAUSES_ERROR	Error returned by OpenSearch when the number of nested clauses exceeds the limit

Constructor Summary

Constructors

Constructor	Description
AbstractOpenSearchClientWrapper(org.opensearch.client.opensearch.OpenSearchClient client)

Method Summary

Modifier and Type	Method	Description
protected void	copyQuery(org.opensearch.client.opensearch._types.query_dsl.BoolQuery originalQuery, org.opensearch.client.opensearch._types.query_dsl.BoolQuery.Builder builder)
protected String	getErrorRootCauseType(org.opensearch.client.ResponseException e)	Get the error type from an error response
protected AbstractOpenSearchClientWrapper.RequestUpdates	getRequestUpdates(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters)
<T> org.opensearch.client.opensearch.core.SearchResponse<T>	search(org.opensearch.client.opensearch.core.SearchRequest request, Class<T> docClass, Map<String,Object> parameters)	Executes the given request
void	setFilterQueries(String[] filterQueries)
protected void	updateIndex(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, AbstractOpenSearchClientWrapper.RequestUpdates updates)
protected void	updateIndicesOptions(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, AbstractOpenSearchClientWrapper.RequestUpdates updates)
protected void	updateQuery(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, AbstractOpenSearchClientWrapper.RequestUpdates updates)	Updates the filter queries for the given request
protected void	updateSearchType(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, AbstractOpenSearchClientWrapper.RequestUpdates updates)

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

search, search, search

Field Details

TOO_MANY_NESTED_CLAUSES_ERROR

protected static final String TOO_MANY_NESTED_CLAUSES_ERROR

Error returned by OpenSearch when the number of nested clauses exceeds the limit

See Also:

• Constant Field Values

logger

protected final org.slf4j.Logger logger

PARAM_NAME_INDEX

public static final String PARAM_NAME_INDEX

See Also:

• Constant Field Values

PARAM_NAME_SEARCH_TYPE

public static final String PARAM_NAME_SEARCH_TYPE

See Also:

• Constant Field Values

client

protected final org.opensearch.client.opensearch.OpenSearchClient client

The OpenSearch client

filterQueries

protected String[] filterQueries

The filter queries to apply to all searches

Constructor Details

AbstractOpenSearchClientWrapper

public AbstractOpenSearchClientWrapper(org.opensearch.client.opensearch.OpenSearchClient client)

Method Details

setFilterQueries

public void setFilterQueries(String[] filterQueries)

search

public <T>
org.opensearch.client.opensearch.core.SearchResponse<T> search(org.opensearch.client.opensearch.core.SearchRequest request,
 Class<T> docClass,
 Map<String,Object> parameters)
                                                        throws IOException,
OpenSearchException

Description copied from interface: OpenSearchClientWrapper

Executes the given request

Specified by:

search in interface OpenSearchClientWrapper

Throws:

IOException

OpenSearchException

getErrorRootCauseType

protected String getErrorRootCauseType(org.opensearch.client.ResponseException e)
                                throws IOException

Get the error type from an error response

Parameters:

e - the response exception

Returns:

the error type, or null if couldn't be determined

Throws:

IOException - if there is an error reading the response

getRequestUpdates

protected AbstractOpenSearchClientWrapper.RequestUpdates getRequestUpdates(org.opensearch.client.opensearch.core.SearchRequest request,
 Map<String,Object> parameters)

updateIndex

protected void updateIndex(org.opensearch.client.opensearch.core.SearchRequest request,
 Map<String,Object> parameters,
 AbstractOpenSearchClientWrapper.RequestUpdates updates)

updateSearchType

protected void updateSearchType(org.opensearch.client.opensearch.core.SearchRequest request,
 Map<String,Object> parameters,
 AbstractOpenSearchClientWrapper.RequestUpdates updates)

updateIndicesOptions

protected void updateIndicesOptions(org.opensearch.client.opensearch.core.SearchRequest request,
 Map<String,Object> parameters,
 AbstractOpenSearchClientWrapper.RequestUpdates updates)

copyQuery

protected void copyQuery(org.opensearch.client.opensearch._types.query_dsl.BoolQuery originalQuery,
 org.opensearch.client.opensearch._types.query_dsl.BoolQuery.Builder builder)

updateQuery

protected void updateQuery(org.opensearch.client.opensearch.core.SearchRequest request,
 Map<String,Object> parameters,
 AbstractOpenSearchClientWrapper.RequestUpdates updates)

Updates the filter queries for the given request

Parameters:

request - the request to update

updates - the request updates