org.broadleafcommerce.common.resource.service

Interface ResourceBundlingService

All Known Implementing Classes:

ResourceBundlingServiceImpl

public interface ResourceBundlingService

This service is responsible for interaction with the ResourceBundleProcessor to generate bundles for static resources.

Author:

Andre Azzolini (apazzolini), Brian Polster (bpolster)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkForRegisteredBundleFile(String versionedBundleName) Returns true if the passed in name represents a versionedBundle
List<String>	getAdditionalBundleFiles(String bundleName) Through configuration, you can provide additional files that will be automatically included for any bundle.
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.

Method Detail

rebuildBundledResource

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

Parameters:

requestedBundleName -

Returns:

resolveBundleResourceName

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

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.

Parameters:

requestedBundleName -

Returns:

resolveBundleResource

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

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)

Parameters:

versionedBundleResourceName -

Returns:

getAdditionalBundleFiles

List<String> getAdditionalBundleFiles(String bundleName)

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

Parameters:

bundleName -

Returns:

checkForRegisteredBundleFile

boolean checkForRegisteredBundleFile(String versionedBundleName)

Returns true if the passed in name represents a versionedBundle

Parameters:

versionedBundleName -

Returns: