Package com.broadleafcommerce.search.catalog.solr.query

Class CatalogAccessPolicyQueryContributor

java.lang.Object
com.broadleafcommerce.search.provider.solr.AbstractSolrQueryContributor
com.broadleafcommerce.search.catalog.solr.query.CatalogAccessPolicyQueryContributor
All Implemented Interfaces:
com.broadleafcommerce.search.provider.solr.SolrQueryContributor, org.springframework.core.Ordered
public class CatalogAccessPolicyQueryContributor extends com.broadleafcommerce.search.provider.solr.AbstractSolrQueryContributor

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CatalogAccessPolicyQueryContributor(com.broadleafcommerce.search.core.service.SearchCatalogAccessPolicyService<com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> searchCatalogAccessPolicyService, com.broadleafcommerce.data.tracking.core.filtering.fetch.rsql.RSQLFilterParser filterParser, com.broadleafcommerce.search.provider.solr.rsql.SolrRSQLFilterBuilder rsqlFilterBuilder, com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService ruleEvaluationService, com.broadleafcommerce.search.core.utils.SearchCatalogAccessPolicyUtils catalogAccessPolicyUtils, com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addPoliciesAsQueryFilters(org.apache.solr.client.solrj.SolrQuery solrQuery, Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, String locale)
     
    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)
     
    boolean
    contributeOnTypeAhead()
     
    protected String
    customizeFilter(String filter, Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies)
    Extension hook point allowing additional run-time customization to the configured filter.
    protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils
    getAuthenticationUtils()
     
    protected com.broadleafcommerce.search.core.utils.SearchCatalogAccessPolicyUtils
    getCatalogAccessPolicyUtils()
     
    protected com.broadleafcommerce.data.tracking.core.filtering.fetch.rsql.RSQLFilterParser
    getFilterParser()
     
    protected cz.jirutka.rsql.parser.ast.Node
    getProductFilters(Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies)
     
    protected com.broadleafcommerce.search.provider.solr.rsql.SolrRSQLFilterBuilder
    getRsqlFilterBuilder()
     
    protected com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService
    getRuleEvaluationService()
     
    protected com.broadleafcommerce.search.core.service.SearchCatalogAccessPolicyService<com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy>
    getSearchCatalogAccessPolicyService()
     
    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)
     

    Methods inherited from class com.broadleafcommerce.search.provider.solr.AbstractSolrQueryContributor

    contribute

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.broadleafcommerce.search.provider.solr.SolrQueryContributor

    getOrder, isTypeAheadRequest

  • Constructor Details

    • CatalogAccessPolicyQueryContributor

      public CatalogAccessPolicyQueryContributor(com.broadleafcommerce.search.core.service.SearchCatalogAccessPolicyService<com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> searchCatalogAccessPolicyService, com.broadleafcommerce.data.tracking.core.filtering.fetch.rsql.RSQLFilterParser filterParser, com.broadleafcommerce.search.provider.solr.rsql.SolrRSQLFilterBuilder rsqlFilterBuilder, com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService ruleEvaluationService, com.broadleafcommerce.search.core.utils.SearchCatalogAccessPolicyUtils catalogAccessPolicyUtils, com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

  • Method Details

    • 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)
      Specified by:
      contributeInternal in class com.broadleafcommerce.search.provider.solr.AbstractSolrQueryContributor

    • addPoliciesAsQueryFilters

      protected void addPoliciesAsQueryFilters(org.apache.solr.client.solrj.SolrQuery solrQuery, Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, @Nullable String locale)

    • customizeFilter

      protected String customizeFilter(String filter, Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies)
      Extension hook point allowing additional run-time customization to the configured filter.
      Parameters:
      filter - - the default RSQL filter
      policies -
      Returns:
      - the modified filter (if applicable)

    • getProductFilters

      protected cz.jirutka.rsql.parser.ast.Node getProductFilters(Collection<? extends com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> policies)

    • 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)
      Specified by:
      shouldContribute in class com.broadleafcommerce.search.provider.solr.AbstractSolrQueryContributor

    • contributeOnTypeAhead

      public boolean contributeOnTypeAhead()

    • getSearchCatalogAccessPolicyService

      protected com.broadleafcommerce.search.core.service.SearchCatalogAccessPolicyService<com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy> getSearchCatalogAccessPolicyService()

    • getFilterParser

      protected com.broadleafcommerce.data.tracking.core.filtering.fetch.rsql.RSQLFilterParser getFilterParser()

    • getRsqlFilterBuilder

      protected com.broadleafcommerce.search.provider.solr.rsql.SolrRSQLFilterBuilder getRsqlFilterBuilder()

    • getRuleEvaluationService

      protected com.broadleafcommerce.rulesengine.expression.service.RuleEvaluationService getRuleEvaluationService()

    • getCatalogAccessPolicyUtils

      protected com.broadleafcommerce.search.core.utils.SearchCatalogAccessPolicyUtils getCatalogAccessPolicyUtils()

    • getAuthenticationUtils

      protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils getAuthenticationUtils()