org.broadleafcommerce.common.web.processor

Class ResourceBundleProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.element.AbstractElementProcessor

org.broadleafcommerce.common.web.processor.ResourceBundleProcessor

All Implemented Interfaces:

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

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

Works with the blc:bundle tag.

This processor does not do the actual bundling. It merely changes the URL which causes the other bundling components to be invoked through the normal static resource handling processes.

This processor relies bundle.enabled. If this property is false (typical for dev) then the list of resources will be output as individual SCRIPT or LINK elements for each JavaScript or CSS file respectively.

To use this processor, supply a name, mapping prefix, and list of files.

 
 <blc:bundle name="lib.js" 
             mapping-prefix="/js/"
             files="plugins.js,
                    libs/jquery.MetaData.js,
                    libs/jquery.rating.pack.js,
                    libs/jquery.dotdotdot-1.5.1.js" />
  
 

With bundling enabled this will turn into:

 
 
  <script type="text/javascript" src="/js/lib-blbundle12345.js" />
 
 

Where the -blbundle12345 is used by the BundleUrlResourceResolver to determine the actual bundle name.

With bundling disabled this turns into:

 
  <script type="text/javascript" src="/js/plugins.js" />
  <script type="text/javascript" src="/js/jquery.MetaData.js" />
  <script type="text/javascript" src="/js/jquery.rating.pack.js.js" />
  <script type="text/javascript" src="/js/jquery.dotdotdot-1.5.1.js" />
 
 

This processor also supports producing the 'async' and 'defer' attributes for Javascript files. For instance:

 
 <blc:bundle name="lib.js" 
             async="true"
             defer="true"
             mapping-prefix="/js/"
             files="plugins.js,
                    libs/jquery.MetaData.js,
                    libs/jquery.rating.pack.js,
                    libs/jquery.dotdotdot-1.5.1.js" />
  
 

If bundling is turned on, the single output file contains the 'async' and 'defer' name-only attributes. When bundling is turned off, then those name-only attributes are applied to each individual file reference.

This processor only supports files that end in .js and .css

Author:

apazzolini, bpolster

See Also:

ResourceBundlingService}

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceBundlingService	bundlingService

Constructor Summary

Constructors

Constructor and Description
ResourceBundleProcessor()

Method Summary

Modifier and Type	Method and Description
protected boolean	getBundleEnabled()
protected String	getBundleUrl(org.thymeleaf.Arguments arguments, String bundleName) Adds the context path to the bundleUrl.
protected org.thymeleaf.dom.Element	getElement(String src, boolean async, boolean defer)
protected org.thymeleaf.dom.Element	getLinkElement(String src)
int	getPrecedence()
protected org.thymeleaf.dom.Element	getScriptElement(String src, boolean async, boolean defer)
protected org.thymeleaf.processor.ProcessorResult	processElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)

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

bundlingService

protected ResourceBundlingService bundlingService

Constructor Detail

ResourceBundleProcessor

public ResourceBundleProcessor()

Method Detail

getBundleEnabled

protected boolean getBundleEnabled()

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

getBundleUrl

protected String getBundleUrl(org.thymeleaf.Arguments arguments,
                              String bundleName)

Adds the context path to the bundleUrl. We don't use the Thymeleaf "@" syntax or any other mechanism to encode this URL as the resolvers could have a conflict. For example, resolving a bundle named "style.css" that has a file also named "style.css" creates problems as the TF or version resolvers both want to version this file.

Parameters:

arguments -

bundleName -

Returns:

getScriptElement

protected org.thymeleaf.dom.Element getScriptElement(String src,
                                                     boolean async,
                                                     boolean defer)

getLinkElement

protected org.thymeleaf.dom.Element getLinkElement(String src)

getElement

protected org.thymeleaf.dom.Element getElement(String src,
                                               boolean async,
                                               boolean defer)