org.broadleafcommerce.core.web.processor

Class UncacheableDataProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.element.AbstractElementProcessor

org.broadleafcommerce.core.web.processor.UncacheableDataProcessor

All Implemented Interfaces:

Comparable<org.thymeleaf.processor.IProcessor>, org.thymeleaf.processor.IProcessor

public class UncacheableDataProcessor
extends org.thymeleaf.processor.element.AbstractElementProcessor

This processor outputs a SCRIPT tag with JSON data that can be used to update a mostly cached page followed by a call to a javascript function. The function name is "updateUncacheableData()" by default. Broadleaf provides this example but most clients with typical customizations will need to create a similar processor to meet their dynamic data caching needs. The Broadleaf processor works with the sample javacript function in HeatClinic found in heatClinic-UncacheableData.js work together to update the "In Cart", "Out of Stock", "Welcome {name}", and "Cart Qty" messages. By doing this, the category and product pages in HeatClinic can be aggressively cached using the BroadleafCacheProcessor. Example usage on cached pages with dynamic data. This would generally go after the footer for the page.

  <blc:uncacheableData />  
  
 

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.security.service.ExploitProtectionService	eps
protected UncacheableDataProcessorExtensionManager	extensionManager
protected InventoryService	inventoryService
protected boolean	useSku

Constructor Summary

Constructors

Constructor and Description
UncacheableDataProcessor() Sets the name of this processor to be used in Thymeleaf template

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCartData(Map<String,Object> attrMap)
protected void	addCustomerData(Map<String,Object> attrMap)
protected void	addProductInventoryData(Map<String,Object> attrMap, org.thymeleaf.Arguments arguments)
protected String	buildContentMap(org.thymeleaf.Arguments arguments)
String	getDefaultCallbackFunction()
int	getPrecedence()
String	getUncacheableDataFunction(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)
protected org.thymeleaf.processor.ProcessorResult	processElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)
void	setDefaultCallbackFunction(String defaultCallbackFunction)

Methods inherited from class org.thymeleaf.processor.element.AbstractElementProcessor

doProcess, getMatcher

Methods inherited from class org.thymeleaf.processor.AbstractProcessor

compareTo, getMessage, getMessageForProcessor, getMessageForTemplate, process

Methods inherited from class java.lang.Object

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

Field Detail

useSku

@Value(value="${solr.index.use.sku}")
protected boolean useSku

inventoryService

protected InventoryService inventoryService

eps

protected org.broadleafcommerce.common.security.service.ExploitProtectionService eps

extensionManager

protected UncacheableDataProcessorExtensionManager extensionManager

Constructor Detail

UncacheableDataProcessor

public UncacheableDataProcessor()

Sets the name of this processor to be used in Thymeleaf template

Method Detail

getPrecedence

public int getPrecedence()

Specified by:

getPrecedence in class org.thymeleaf.processor.AbstractProcessor

processElement

protected org.thymeleaf.processor.ProcessorResult processElement(org.thymeleaf.Arguments arguments,
                                                     org.thymeleaf.dom.Element element)

Specified by:

processElement in class org.thymeleaf.processor.element.AbstractElementProcessor

buildContentMap

protected String buildContentMap(org.thymeleaf.Arguments arguments)

addProductInventoryData

protected void addProductInventoryData(Map<String,Object> attrMap,
                           org.thymeleaf.Arguments arguments)

addCartData

protected void addCartData(Map<String,Object> attrMap)

addCustomerData

protected void addCustomerData(Map<String,Object> attrMap)

getUncacheableDataFunction

public String getUncacheableDataFunction(org.thymeleaf.Arguments arguments,
                                org.thymeleaf.dom.Element element)

getDefaultCallbackFunction

public String getDefaultCallbackFunction()

setDefaultCallbackFunction

public void setDefaultCallbackFunction(String defaultCallbackFunction)