Class SandboxVisibleCacheEnabledContextInfoCustomizer
java.lang.Object
com.broadleafcommerce.data.tracking.core.cache.SandboxVisibleCacheEnabledContextInfoCustomizer
- All Implemented Interfaces:
ContextInfoCustomizer
,org.springframework.core.Ordered
public class SandboxVisibleCacheEnabledContextInfoCustomizer
extends Object
implements ContextInfoCustomizer
Establish the cache context for this request. This will aid in the determination of whether or
not caches sensitive to
CacheContext
will be enabled. More specifically, disable the
cache context if the current user is an admin user, or if the current request is a valid
storefront preview request.- Author:
- Jeff Fischer
-
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
ConstructorDescriptionSandboxVisibleCacheEnabledContextInfoCustomizer
(org.springframework.core.convert.converter.Converter<org.springframework.security.core.Authentication, Map<String, Object>> authenticationAttributesConverter) -
Method Summary
Modifier and TypeMethodDescriptionvoid
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 inContextInfo
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
-
SandboxVisibleCacheEnabledContextInfoCustomizer
-
-
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 inContextInfo
instance.- Specified by:
customize
in interfaceContextInfoCustomizer
- Parameters:
contextInfo
- The instance to customizerouteKey
- Analogous to the key identified byDataRouteByKey
. 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 thisrouteKey
to the catalog service'sRouteConstants.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.
-