Package com.broadleafcommerce.customer.client.context

Class CustomerSegmentResolutionProperties

java.lang.Object

com.broadleafcommerce.customer.client.context.CustomerSegmentResolutionProperties

public class CustomerSegmentResolutionProperties
extends Object

Properties related to resolving CustomerSegments.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
CustomerSegmentResolutionProperties()

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalClaims()	Represents a list of additional auth token claims to add as attributes to the ResolveCustomerSegmentsRequest for rules to be evaluated against.
List<String>	getRequestAttributeList()	Represents the list of attribute from a WebRequest to store on ResolveCustomerSegmentsRequest.
boolean	isEvaluatingRuleBasedSegmentsExternallyAllowed()	Whether to allow rule-based CustomerSegments with CustomerSegment.isInternalEvaluationRequired() set to true to be sent to the customer service to be evaluated.
void	setAdditionalClaims(List<String> additionalClaims)	Represents a list of additional auth token claims to add as attributes to the ResolveCustomerSegmentsRequest for rules to be evaluated against.
void	setEvaluatingRuleBasedSegmentsExternallyAllowed(boolean evaluatingRuleBasedSegmentsExternallyAllowed)	Whether to allow rule-based CustomerSegments with CustomerSegment.isInternalEvaluationRequired() set to true to be sent to the customer service to be evaluated.
void	setRequestAttributeList(List<String> requestAttributeList)	Represents the list of attribute from a WebRequest to store on ResolveCustomerSegmentsRequest.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomerSegmentResolutionProperties

public CustomerSegmentResolutionProperties()

Method Details

getRequestAttributeList

public List<String> getRequestAttributeList()

Represents the list of attribute from a WebRequest to store on ResolveCustomerSegmentsRequest. This is used to whitelist request attributes used when evaluating dynamic CustomerSegments. The attribute name should be matched by a field name configured in metadata for the CustomerSegment.getRealtimeMatchRule() rule-builder.

getAdditionalClaims

public List<String> getAdditionalClaims()

Represents a list of additional auth token claims to add as attributes to the ResolveCustomerSegmentsRequest for rules to be evaluated against. The claim name should be matched by a field name configured in metadata for the CustomerSegment.getRealtimeMatchRule() rule-builder.

isEvaluatingRuleBasedSegmentsExternallyAllowed

public boolean isEvaluatingRuleBasedSegmentsExternallyAllowed()

Whether to allow rule-based CustomerSegments with CustomerSegment.isInternalEvaluationRequired() set to true to be sent to the customer service to be evaluated. This requires an additional request to evaluate these segments outside the client which can have important performance impacts and is disabled by default.

setRequestAttributeList

public void setRequestAttributeList(List<String> requestAttributeList)

Represents the list of attribute from a WebRequest to store on ResolveCustomerSegmentsRequest. This is used to whitelist request attributes used when evaluating dynamic CustomerSegments. The attribute name should be matched by a field name configured in metadata for the CustomerSegment.getRealtimeMatchRule() rule-builder.

setAdditionalClaims

public void setAdditionalClaims(List<String> additionalClaims)

Represents a list of additional auth token claims to add as attributes to the ResolveCustomerSegmentsRequest for rules to be evaluated against. The claim name should be matched by a field name configured in metadata for the CustomerSegment.getRealtimeMatchRule() rule-builder.

setEvaluatingRuleBasedSegmentsExternallyAllowed

public void setEvaluatingRuleBasedSegmentsExternallyAllowed(boolean evaluatingRuleBasedSegmentsExternallyAllowed)

Whether to allow rule-based CustomerSegments with CustomerSegment.isInternalEvaluationRequired() set to true to be sent to the customer service to be evaluated. This requires an additional request to evaluate these segments outside the client which can have important performance impacts and is disabled by default.