org.broadleafcommerce.common.resource.service

Class ResourceBundlingServiceImpl

java.lang.Object

org.broadleafcommerce.common.resource.service.ResourceBundlingServiceImpl

All Implemented Interfaces:

ResourceBundlingService

@Service(value="blResourceBundlingService")
public class ResourceBundlingServiceImpl
extends Object
implements ResourceBundlingService

Author:

Andre Azzolini (apazzolini), Brian Polster (bpolster)

See Also:

ResourceBundlingService

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<String>>	additionalBundleFiles
protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler	cssResourceHandler
protected BroadleafFileService	fileService
protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler	jsResourceHandler
protected static org.apache.commons.logging.Log	LOG
protected StatisticsService	statisticsService

Constructor Summary

Constructors

Constructor and Description
ResourceBundlingServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	addVersion(String requestPath, String version) Copied from Spring 4.1 AbstractVersionStrategy
boolean	checkForRegisteredBundleFile(String versionedBundleName) Returns true if the passed in name represents a versionedBundle
protected org.springframework.core.io.Resource	createBundle(String versionedBundleName, List<String> filePaths, org.springframework.web.servlet.resource.ResourceResolverChain resolverChain, List<org.springframework.core.io.Resource> locations)
protected void	createBundleIfNeeded(String versionedBundleName, List<String> filePaths, org.springframework.web.servlet.resource.ResourceResolverChain resolverChain, List<org.springframework.core.io.Resource> locations)
protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler	findResourceHttpRequestHandler(String resourceName)
List<String>	getAdditionalBundleFiles(String bundleName) Through configuration, you can provide additional files that will be automatically included for any bundle.
protected org.springframework.core.io.Resource	getBundledResource(String versionedBundleName)
protected String	getBundleName(String bundleName, String version)
protected String	getBundleVersion(LinkedHashMap<String,org.springframework.core.io.Resource> foundResources)
protected String	getCacheKey(String unversionedBundleName, List<String> files)
protected String	getResourcePath(String name) Returns the resource path for the given name in URL-format (meaning, / separators)
protected boolean	isCSSResource(String resourceName)
protected boolean	isJavaScriptResource(String resourceName)
protected String	lookupBundlePath(String requestPath)
protected org.springframework.core.io.Resource	readBundle(String versionedBundleName)
org.springframework.core.io.Resource	rebuildBundledResource(String requestedBundleName) Returns a newly rebuilt bundled resource given that the passed requestedBundleName had previously been built and cached/persisted via the resolveBundleResourceName method
org.springframework.core.io.Resource	resolveBundleResource(String versionedBundleResourceName) Returns a Resource for passed in versionedBundleResourceName.
String	resolveBundleResourceName(String requestedBundleName, String mappingPrefix, List<String> files) Returns a file name representing a versioned copy of the bundle.
protected void	saveBundle(org.springframework.core.io.Resource resource)
void	setAdditionalBundleFiles(Map<String,List<String>> additionalBundleFiles)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

additionalBundleFiles

protected Map<String,List<String>> additionalBundleFiles

fileService

protected BroadleafFileService fileService

jsResourceHandler

@Autowired(required=false)
@Qualifier(value="blJsResources")
protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler jsResourceHandler

cssResourceHandler

@Autowired(required=false)
@Qualifier(value="blCssResources")
protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler cssResourceHandler

statisticsService

protected StatisticsService statisticsService

Constructor Detail

ResourceBundlingServiceImpl

public ResourceBundlingServiceImpl()

Method Detail

rebuildBundledResource

public org.springframework.core.io.Resource rebuildBundledResource(String requestedBundleName)

Description copied from interface: ResourceBundlingService

Returns a newly rebuilt bundled resource given that the passed requestedBundleName had previously been built and cached/persisted via the resolveBundleResourceName method

Specified by:

rebuildBundledResource in interface ResourceBundlingService

Returns:

resolveBundleResourceName

public String resolveBundleResourceName(String requestedBundleName,
                               String mappingPrefix,
                               List<String> files)

Description copied from interface: ResourceBundlingService

Returns a file name representing a versioned copy of the bundle.

First computes the bundle version by checking examining the files in the bundle.

If the bundle does not exist, this method will make a call to create it.

Specified by:

resolveBundleResourceName in interface ResourceBundlingService

Returns:

resolveBundleResource

public org.springframework.core.io.Resource resolveBundleResource(String versionedBundleResourceName)

Description copied from interface: ResourceBundlingService

Returns a Resource for passed in versionedBundleResourceName. If the bundle does not exist, this method will attempt to create it by using the list of files that were registered with the initial call to #getBundleResourceName(String, List)

Specified by:

resolveBundleResource in interface ResourceBundlingService

Returns:

checkForRegisteredBundleFile

public boolean checkForRegisteredBundleFile(String versionedBundleName)

Description copied from interface: ResourceBundlingService

Returns true if the passed in name represents a versionedBundle

Specified by:

checkForRegisteredBundleFile in interface ResourceBundlingService

Returns:

getBundledResource

protected org.springframework.core.io.Resource getBundledResource(String versionedBundleName)

lookupBundlePath

protected String lookupBundlePath(String requestPath)

createBundleIfNeeded

protected void createBundleIfNeeded(String versionedBundleName,
                        List<String> filePaths,
                        org.springframework.web.servlet.resource.ResourceResolverChain resolverChain,
                        List<org.springframework.core.io.Resource> locations)

createBundle

protected org.springframework.core.io.Resource createBundle(String versionedBundleName,
                                                List<String> filePaths,
                                                org.springframework.web.servlet.resource.ResourceResolverChain resolverChain,
                                                List<org.springframework.core.io.Resource> locations)

saveBundle

protected void saveBundle(org.springframework.core.io.Resource resource)

getCacheKey

protected String getCacheKey(String unversionedBundleName,
                 List<String> files)

getBundleName

protected String getBundleName(String bundleName,
                   String version)

getBundleVersion

protected String getBundleVersion(LinkedHashMap<String,org.springframework.core.io.Resource> foundResources)
                           throws IOException

Throws:

IOException

getAdditionalBundleFiles

public List<String> getAdditionalBundleFiles(String bundleName)

Description copied from interface: ResourceBundlingService

Through configuration, you can provide additional files that will be automatically included for any bundle.

Specified by:

getAdditionalBundleFiles in interface ResourceBundlingService

Returns:

setAdditionalBundleFiles

public void setAdditionalBundleFiles(Map<String,List<String>> additionalBundleFiles)

addVersion

protected String addVersion(String requestPath,
                String version)

Copied from Spring 4.1 AbstractVersionStrategy

Parameters:

requestPath -

version -

Returns:

readBundle

protected org.springframework.core.io.Resource readBundle(String versionedBundleName)

findResourceHttpRequestHandler

protected org.springframework.web.servlet.resource.ResourceHttpRequestHandler findResourceHttpRequestHandler(String resourceName)

isJavaScriptResource

protected boolean isJavaScriptResource(String resourceName)

isCSSResource

protected boolean isCSSResource(String resourceName)

getResourcePath

protected String getResourcePath(String name)

Returns the resource path for the given name in URL-format (meaning, / separators)

Parameters:

name -

Returns: