Package org.craftercms.studio.impl.v2.service.search

Class PermissionAwareSearchService

java.lang.Object
org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper
org.craftercms.studio.impl.v2.service.search.PermissionAwareSearchService
All Implemented Interfaces:
org.craftercms.search.opensearch.client.OpenSearchClientWrapper
public class PermissionAwareSearchService extends org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper
Implementation of OpenSearchWrapper specific for authoring indexes
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 String
    indexSuffix
    The suffix to append to the site name
    protected String
    pathFieldName
    The name of the field to filter paths

    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
    PermissionAwareSearchService(org.opensearch.client.opensearch.OpenSearchClient client, String indexSuffix, String pathFieldName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addFilters(org.opensearch.client.opensearch.core.SearchRequest request, List<String> allowedPaths, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)
     
    protected org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates
    getRequestUpdates(org.opensearch.client.opensearch.core.SearchRequest request, Map<String,Object> parameters)
     
    <T> org.opensearch.client.opensearch.core.SearchResponse<T>
    search(String siteId, org.opensearch.client.opensearch.core.SearchRequest request, Class<T> documentClass)
    Perform a search operation for the given site
    <T> org.opensearch.client.opensearch.core.SearchResponse<T>
    search(org.opensearch.client.opensearch.core.SearchRequest request, Class<T> docClass, Map<String,Object> parameters)

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

    copyQuery, getErrorRootCauseType, setFilterQueries, updateIndex, updateIndicesOptions, updateQuery, 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

    • indexSuffix

      protected String indexSuffix
      The suffix to append to the site name

    • pathFieldName

      protected String pathFieldName
      The name of the field to filter paths

  • Constructor Details

    • PermissionAwareSearchService

      @ConstructorProperties({"client","indexSuffix","pathFieldName"}) public PermissionAwareSearchService(org.opensearch.client.opensearch.OpenSearchClient client, String indexSuffix, String pathFieldName)

  • Method Details

    • search

      public <T> org.opensearch.client.opensearch.core.SearchResponse<T> search(String siteId, org.opensearch.client.opensearch.core.SearchRequest request, Class<T> documentClass) throws IOException, ServiceLayerException
      Perform a search operation for the given site
      Parameters:
      siteId - the site id
      request - the search request
      Returns:
      the search response
      Throws:
      IOException
      ServiceLayerException

    • getRequestUpdates

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

    • addFilters

      protected void addFilters(org.opensearch.client.opensearch.core.SearchRequest request, List<String> allowedPaths, org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper.RequestUpdates updates)

    • 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
      Specified by:
      search in interface org.craftercms.search.opensearch.client.OpenSearchClientWrapper
      Overrides:
      search in class org.craftercms.search.opensearch.impl.client.AbstractOpenSearchClientWrapper
      Throws:
      IOException