com.broadleafcommerce.cap.service

Class CatalogAccessPolicyServiceImpl

java.lang.Object

com.broadleafcommerce.cap.service.CatalogAccessPolicyServiceImpl

All Implemented Interfaces:

CatalogAccessPolicyService

@Service(value="blCatalogAccessPolicyService")
public class CatalogAccessPolicyServiceImpl
extends Object
implements CatalogAccessPolicyService

Author:

Nick Crum ncrum

Field Summary

Fields

Modifier and Type	Field and Description
protected com.broadleafcommerce.customersegment.service.CustomerSegmentService	customerSegmentService
protected CatalogAccessPolicyServiceExtensionManager	extensionManager
protected org.broadleafcommerce.core.search.dao.IndexFieldDao	indexFieldDao
protected CatalogAccessPolicyDao	policyDao

Constructor Summary

Constructors

Constructor and Description
CatalogAccessPolicyServiceImpl()

Method Summary

Modifier and Type	Method and Description
boolean	attachCatalogAccessPolicyFiltersIfPossible(org.broadleafcommerce.core.search.service.solr.SearchContextDTO context, org.apache.solr.client.solrj.SolrQuery solrQuery) This method is responsible for creating and attaching the filter queries for any catalog access policies.
protected Collection<String>	convertAdditionalRuleToFilters(CatalogAccessPolicy policy, String key, String matchRule) Default method called when matching fields that are not one of the defaults.
protected Collection<String>	convertCategoryRuleToFilters(String matchRule)
protected Collection<String>	convertProductRuleToFilters(String matchRule)
List<String>	createSolrFiltersForPolicy(CatalogAccessPolicy policy) This method generates the filter queries for SolrQuery to filter search results.
List<CatalogAccessPolicy>	findAllActivePolicies() This method retrieves all of the active policies and orders them by priority.
CatalogAccessPolicy	findById(Long id) This retrieves the CatalogAccessPolicy by primary key.
CatalogAccessPolicy	findCatalogAccessPolicyForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer) This method retrieves the highest priority policy for the given customer.
protected String	getCustomFieldPropertyName(String mvelRule)
protected String	getCustomFieldValue(String mvelRule)
protected boolean	isValidPolicy(CatalogAccessPolicy policy, org.broadleafcommerce.profile.core.domain.Customer customer)
protected boolean	isWildCardSearch(String fieldValue) Determines if the given field value string represents a wild card search.
protected boolean	validateCategoryForAdditionalRule(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Category category, String key, String matchRule) Validates the category for any additional fields that are not one of the defaults.
boolean	validateCategoryForPolicy(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Category category) This method evaluates whether the given Category is valid for the given CatalogAccessPolicy.
protected boolean	validateProductForAdditionalRule(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Product product, String key, String matchRule) Validates the category for any additional fields that are not one of the defaults.
boolean	validateProductForPolicy(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Product product) This method evaluates whether the given Product is valid for the given CatalogAccessPolicy.

Methods inherited from class java.lang.Object

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

Field Detail

policyDao

protected CatalogAccessPolicyDao policyDao

customerSegmentService

protected com.broadleafcommerce.customersegment.service.CustomerSegmentService customerSegmentService

indexFieldDao

protected org.broadleafcommerce.core.search.dao.IndexFieldDao indexFieldDao

extensionManager

protected CatalogAccessPolicyServiceExtensionManager extensionManager

Constructor Detail

CatalogAccessPolicyServiceImpl

public CatalogAccessPolicyServiceImpl()

Method Detail

findById

public CatalogAccessPolicy findById(Long id)

Description copied from interface: CatalogAccessPolicyService

This retrieves the CatalogAccessPolicy by primary key.

Specified by:

findById in interface CatalogAccessPolicyService

Parameters:

id - the primary key

Returns:

the policy with the primary key

findAllActivePolicies

public List<CatalogAccessPolicy> findAllActivePolicies()

Description copied from interface: CatalogAccessPolicyService

This method retrieves all of the active policies and orders them by priority.

Specified by:

findAllActivePolicies in interface CatalogAccessPolicyService

Returns:

the active policies

findCatalogAccessPolicyForCustomer

public CatalogAccessPolicy findCatalogAccessPolicyForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)

Description copied from interface: CatalogAccessPolicyService

This method retrieves the highest priority policy for the given customer.

Specified by:

findCatalogAccessPolicyForCustomer in interface CatalogAccessPolicyService

Parameters:

customer - the Customer

Returns:

the CatalogAccessPolicy

isValidPolicy

protected boolean isValidPolicy(CatalogAccessPolicy policy,
                                org.broadleafcommerce.profile.core.domain.Customer customer)

validateProductForPolicy

public boolean validateProductForPolicy(CatalogAccessPolicy policy,
                                        org.broadleafcommerce.core.catalog.domain.Product product)

Description copied from interface: CatalogAccessPolicyService

This method evaluates whether the given Product is valid for the given CatalogAccessPolicy.

Specified by:

validateProductForPolicy in interface CatalogAccessPolicyService

Parameters:

policy - the policy

product - the product to check if valid

Returns:

whether the product is valid for the policy

validateProductForAdditionalRule

protected boolean validateProductForAdditionalRule(CatalogAccessPolicy policy,
                                                   org.broadleafcommerce.core.catalog.domain.Product product,
                                                   String key,
                                                   String matchRule)

Validates the category for any additional fields that are not one of the defaults. This allows for extensions to add additional rule types.

Parameters:

policy - the CatalogAccessPolicy

product - the Product

key - the field key for the rule

matchRule - the mvel expression

Returns:

whether the category is valid for the additional rule

validateCategoryForPolicy

public boolean validateCategoryForPolicy(CatalogAccessPolicy policy,
                                         org.broadleafcommerce.core.catalog.domain.Category category)

Description copied from interface: CatalogAccessPolicyService

This method evaluates whether the given Category is valid for the given CatalogAccessPolicy.

Specified by:

validateCategoryForPolicy in interface CatalogAccessPolicyService

Parameters:

policy - the policy

category - the category to check if valid

Returns:

whether the category is valid for the policy

validateCategoryForAdditionalRule

protected boolean validateCategoryForAdditionalRule(CatalogAccessPolicy policy,
                                                    org.broadleafcommerce.core.catalog.domain.Category category,
                                                    String key,
                                                    String matchRule)

Validates the category for any additional fields that are not one of the defaults. This allows for extensions to add additional rule types.

Parameters:

policy - the CatalogAccessPolicy

category - the Category

key - the field key for the rule

matchRule - the mvel expression @return whether the category is valid for the additional rule

attachCatalogAccessPolicyFiltersIfPossible

public boolean attachCatalogAccessPolicyFiltersIfPossible(org.broadleafcommerce.core.search.service.solr.SearchContextDTO context,
                                                          org.apache.solr.client.solrj.SolrQuery solrQuery)

Description copied from interface: CatalogAccessPolicyService

This method is responsible for creating and attaching the filter queries for any catalog access policies.

Specified by:

attachCatalogAccessPolicyFiltersIfPossible in interface CatalogAccessPolicyService

Parameters:

context - the SearchContextDTO for the search query

solrQuery - the SolrQuery

Returns:

whether the filters were attached or not

createSolrFiltersForPolicy

public List<String> createSolrFiltersForPolicy(CatalogAccessPolicy policy)

Description copied from interface: CatalogAccessPolicyService

This method generates the filter queries for SolrQuery to filter search results.

Specified by:

createSolrFiltersForPolicy in interface CatalogAccessPolicyService

Parameters:

policy - the policy

Returns:

a List of filters

convertAdditionalRuleToFilters

protected Collection<String> convertAdditionalRuleToFilters(CatalogAccessPolicy policy,
                                                            String key,
                                                            String matchRule)

Default method called when matching fields that are not one of the defaults. This allows for extensions to the type of rules that can be defined.

Parameters:

policy - the CatalogAccessPolicy

key - the field key for the rule

matchRule - the mvel expression

Returns:

a Collection of solr filter queries

convertCategoryRuleToFilters

protected Collection<String> convertCategoryRuleToFilters(String matchRule)

convertProductRuleToFilters

protected Collection<String> convertProductRuleToFilters(String matchRule)

isWildCardSearch

protected boolean isWildCardSearch(String fieldValue)

Determines if the given field value string represents a wild card search. In Solr a wild card search either starts or ends with an asterisk.

Parameters:

fieldValue - the String field value

Returns:

whether the value is for a wildcard search

getCustomFieldPropertyName

protected String getCustomFieldPropertyName(String mvelRule)

getCustomFieldValue

protected String getCustomFieldValue(String mvelRule)