Package com.broadleafcommerce.data.tracking.core.filtering

Class ActiveDateFilteringEnabledContextInfoCustomizer

java.lang.Object
com.broadleafcommerce.data.tracking.core.filtering.ActiveDateFilteringEnabledContextInfoCustomizer
All Implemented Interfaces:
ContextInfoCustomizer, org.springframework.core.Ordered
public class ActiveDateFilteringEnabledContextInfoCustomizer extends Object implements ContextInfoCustomizer
Establish whether or not filtering by active dates should be enabled for this request. By default, storefront requests, and message consumption should be filtered. Admin requests should not.
Author:
Jeff Fischer

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActiveDateFilteringEnabledContextInfoCustomizer(org.springframework.core.convert.converter.Converter<org.springframework.security.core.Authentication,Map<String,Object>> authenticationAttributesConverter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    customize(ContextInfo contextInfo, String routeKey, org.springframework.core.MethodParameter endpoint, org.springframework.web.context.request.NativeWebRequest webRequest)
    Customize any of the settings on the passed in ContextInfo instance.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.context.ContextInfoCustomizer

    getOrder

  • Constructor Details

    • ActiveDateFilteringEnabledContextInfoCustomizer

      public ActiveDateFilteringEnabledContextInfoCustomizer(org.springframework.core.convert.converter.Converter<org.springframework.security.core.Authentication,Map<String,Object>> authenticationAttributesConverter)

  • Method Details

    • customize

      public void customize(@NonNull ContextInfo contextInfo, String routeKey, org.springframework.core.MethodParameter endpoint, org.springframework.web.context.request.NativeWebRequest webRequest)
      Description copied from interface: ContextInfoCustomizer
      Customize any of the settings on the passed in ContextInfo instance.
      Specified by:
      customize in interface ContextInfoCustomizer
      Parameters:
      contextInfo - The instance to customize
      routeKey - Analogous to the key identified by DataRouteByKey. Useful in restricting the influence of the customization to particular flows. For example, you could use this to limit customization to all catalog service flows by comparing this routeKey to the catalog service's RouteConstants.CATALOG_ROUTE_KEY. May be null if the ContextInfo is being customized from a non-standard location, or if data routing is not currently engaged for the flow.
      endpoint - The method that initiated the instantiation of this ContextInfo instance. You can use this value to limit customization to a particular endpoint class or method call by inspecting the attributes of this value. May be null if the ContextInfo is being customized from a non-standard location.
      webRequest - Web call related information. Can be used to inspect request context information in order to make arbitrary decisions regarding customization. May be null if the ContextInfo is being customized from a non-standard location.