Package com.broadleafcommerce.search.provider.solr

Class SandboxTrackableSolrQueryContributor

  • All Implemented Interfaces:
    SolrQueryContributor, org.springframework.core.Ordered
    public class SandboxTrackableSolrQueryContributor
extends AbstractSolrQueryContributor
    Add query filters to narrow query results down to the most specific Sandbox context provided.

    • Field Summary

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void contributeInternal​(org.apache.solr.client.solrj.SolrQuery solrQuery, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, String locale, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Customize the provided solrQuery with some additional behavior.
      boolean contributeOnTypeAhead()  
      protected String filterOnOtherSandboxes​(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Create a filter for sandboxes other than the current user's sandbox.
      protected String filterOnProductionSandbox()
      Create a filter for the production sandbox.
      protected String filterOnUserSandbox​(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Create a filter for the current user's sandbox.
      protected void filterOverriddenSandboxes​(org.apache.solr.client.solrj.SolrQuery solrQuery, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Applies a filter to exclude documents for which more specific versions exist for this sandbox context.
      protected boolean shouldContribute​(org.apache.solr.client.solrj.SolrQuery solrQuery, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Determines if this contributor should run.

    • Constructor Detail

      • SandboxTrackableSolrQueryContributor

        public SandboxTrackableSolrQueryContributor()

    • Method Detail

      • contributeInternal

        protected void contributeInternal​(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                  com.broadleafcommerce.search.api.domain.SearchRequest searchRequest,
                                  List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions,
                                  org.springframework.data.domain.Pageable page,
                                  com.broadleafcommerce.search.core.service.SearchRequestProperties properties,
                                  @Nullable
                                  String locale,
                                  @Nullable
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Description copied from class: AbstractSolrQueryContributor
        Customize the provided solrQuery with some additional behavior.
        Specified by:
        contributeInternal in class AbstractSolrQueryContributor
        Parameters:
        solrQuery - The query to customize
        searchRequest - The search query request
        fieldDefinitions - The fields to perform the search on
        page - Page information for page to retrieve for query
        properties - Additional properties for this query
        locale - The locale of this search
        context - The context information surrounding sandboxing/multitenant state

      • filterOnUserSandbox

        protected String filterOnUserSandbox​(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Create a filter for the current user's sandbox.
        Parameters:
        context - The context information surrounding sandboxing/multitenant state
        Returns:
        Filter for the current user's sandbox

      • filterOnOtherSandboxes

        protected String filterOnOtherSandboxes​(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Create a filter for sandboxes other than the current user's sandbox.
        Parameters:
        context - The context information surrounding sandboxing/multitenant state
        Returns:
        Filter for sandboxes other than the current user's sandbox

      • filterOnProductionSandbox

        protected String filterOnProductionSandbox()
        Create a filter for the production sandbox.
        Returns:
        Filter for the production sandbox

      • filterOverriddenSandboxes

        protected void filterOverriddenSandboxes​(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Applies a filter to exclude documents for which more specific versions exist for this sandbox context.
        Parameters:
        solrQuery - Query to execute in Solr
        context - The context information surrounding sandboxing/multitenant state

      • shouldContribute

        protected boolean shouldContribute​(org.apache.solr.client.solrj.SolrQuery solrQuery,
                                   com.broadleafcommerce.search.api.domain.SearchRequest searchRequest,
                                   org.springframework.data.domain.Pageable page,
                                   com.broadleafcommerce.search.core.service.SearchRequestProperties properties,
                                   @Nullable
                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Description copied from class: AbstractSolrQueryContributor
        Determines if this contributor should run.
        Specified by:
        shouldContribute in class AbstractSolrQueryContributor
        Parameters:
        solrQuery - The query to customize
        searchRequest - The search query request
        page - Page information for page to retrieve for query
        properties - Additional properties for this query.
        context - The context information surrounding sandboxing/multitenant state
        Returns:
        whether this contributor should run

      • contributeOnTypeAhead

        public boolean contributeOnTypeAhead()
        Returns:
        Should this contributor be executed on TypeAhead requests?