Package org.craftercms.engine.search

Class SiteAwareOpenSearchClient

java.lang.Object
org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper
org.craftercms.engine.search.SiteAwareOpenSearchClient
All Implemented Interfaces:
org.craftercms.search.opensearch.client.OpenSearchClientWrapper
public class SiteAwareOpenSearchClient extends org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper
Implementation of AbstractOpenSearchClientWrapper 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.opensearch.impl.client.AbstractOpenSearchClientWrapper

    org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.SearchRequestWrapper

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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.client.AbstractOpenSearchClientWrapper

    client, filterQueries, logger, PARAM_NAME_INDEX, PARAM_NAME_SEARCH_TYPE, TOO_MANY_NESTED_CLAUSES_ERROR

  • Constructor Summary

    Constructors
    Constructor
    Description
    SiteAwareOpenSearchClient(org.opensearch.client.opensearch.OpenSearchClient 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(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)
     
    protected void
    updateQuery(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)
     

    Methods inherited from class org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper

    copyQuery, getErrorRootCauseType, 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.opensearch.client.OpenSearchClientWrapper

    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

  • Constructor Details

    • SiteAwareOpenSearchClient

      @ConstructorProperties({"client","indexIdFormat","enableTranslation"}) public SiteAwareOpenSearchClient(org.opensearch.client.opensearch.OpenSearchClient client, String indexIdFormat, boolean enableTranslation)

  • 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()

    • addPrefix

      protected String addPrefix(SiteContext siteContext, String name)

    • updateIndex

      protected void updateIndex(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)
      Overrides:
      updateIndex in class org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper

    • updateQuery

      protected void updateQuery(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)
      Overrides:
      updateQuery in class org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper