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 java.lang.Object
implements ResourceBundlingService

Author:

Andre Azzolini (apazzolini)

See Also:

ResourceBundlingService

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	additionalBundleFiles
protected java.lang.String	assetFileSystemPath
protected java.util.Map<java.lang.String,java.util.Collection<org.springframework.core.io.Resource>>	bundles
protected net.sf.ehcache.Cache	bundleVersionsCache
protected static java.lang.String	DEFAULT_STORAGE_DIRECTORY
protected static org.apache.commons.logging.Log	LOG
protected ResourceMinificationService	minifyService

Constructor Summary

Constructors

Constructor and Description
ResourceBundlingServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.core.io.Resource	createBundle(java.lang.String versionedBundleName)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getAdditionalBundleFiles()
java.util.List<java.lang.String>	getAdditionalBundleFiles(java.lang.String bundleName)
org.springframework.core.io.Resource	getBundle(java.lang.String versionedBundleName) For the given versioned bundle name, returns a Resource that holds the contents of the combined, and possibly minified (if enabled) bundle.
protected java.lang.String	getBundleName(java.lang.String bundleName, java.lang.String version)
protected java.lang.String	getBundleVersion(java.util.LinkedHashMap<java.lang.String,org.springframework.core.io.Resource> foundResources)
protected net.sf.ehcache.Cache	getBundleVersionsCache()
protected java.lang.String	getFilePath(java.lang.String name)
java.lang.String	getVersionedBundleName(java.lang.String unversionedBundleName) For a given unversioned bundle name, such as "global.js", returns the currently known versioned bundle name, such as "global12345.js".
boolean	hasBundle(java.lang.String versionedBundle)
protected org.springframework.core.io.Resource	readBundle(java.lang.String versionedBundleName)
java.lang.String	registerBundle(java.lang.String bundleName, java.util.List<java.lang.String> files, BroadleafResourceHttpRequestHandler handler) Registers a new bundle with the given name to its files.
protected void	saveBundle(org.springframework.core.io.Resource resource)
void	setAdditionalBundleFiles(java.util.Map<java.lang.String,java.util.List<java.lang.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

DEFAULT_STORAGE_DIRECTORY

protected static final java.lang.String DEFAULT_STORAGE_DIRECTORY

bundles

protected java.util.Map<java.lang.String,java.util.Collection<org.springframework.core.io.Resource>> bundles

bundleVersionsCache

protected net.sf.ehcache.Cache bundleVersionsCache

additionalBundleFiles

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> additionalBundleFiles

assetFileSystemPath

@Value(value="${asset.server.file.system.path}")
protected java.lang.String assetFileSystemPath

minifyService

protected ResourceMinificationService minifyService

Constructor Detail

ResourceBundlingServiceImpl

public ResourceBundlingServiceImpl()

Method Detail

getBundle

public org.springframework.core.io.Resource getBundle(java.lang.String versionedBundleName)

Description copied from interface: ResourceBundlingService

For the given versioned bundle name, returns a Resource that holds the contents of the combined, and possibly minified (if enabled) bundle.

Specified by:

getBundle in interface ResourceBundlingService

Returns:

the Resource

readBundle

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

getFilePath

protected java.lang.String getFilePath(java.lang.String name)

createBundle

protected org.springframework.core.io.Resource createBundle(java.lang.String versionedBundleName)

saveBundle

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

getVersionedBundleName

public java.lang.String getVersionedBundleName(java.lang.String unversionedBundleName)

Description copied from interface: ResourceBundlingService

For a given unversioned bundle name, such as "global.js", returns the currently known versioned bundle name, such as "global12345.js".

Specified by:

getVersionedBundleName in interface ResourceBundlingService

Returns:

the versioned bundle name

hasBundle

public boolean hasBundle(java.lang.String versionedBundle)

Specified by:

hasBundle in interface ResourceBundlingService

Returns:

whether or not the given versioned bundle name is currently registered in the system

registerBundle

public java.lang.String registerBundle(java.lang.String bundleName,
                                       java.util.List<java.lang.String> files,
                                       BroadleafResourceHttpRequestHandler handler)
                                throws java.io.IOException

Description copied from interface: ResourceBundlingService

Registers a new bundle with the given name to its files. Will utilize the locations map in handler as well as any configured generated resource handlers in the handler to determine legitimate paths for each of the files in the list.

Specified by:

registerBundle in interface ResourceBundlingService

Returns:

the versioned bundle name

Throws:

java.io.IOException

getBundleName

protected java.lang.String getBundleName(java.lang.String bundleName,
                                         java.lang.String version)

getBundleVersion

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

Throws:

java.io.IOException

getAdditionalBundleFiles

public java.util.List<java.lang.String> getAdditionalBundleFiles(java.lang.String bundleName)

Specified by:

getAdditionalBundleFiles in interface ResourceBundlingService

Returns:

a list of additional files that are registered for the given bundle name

getAdditionalBundleFiles

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAdditionalBundleFiles()

setAdditionalBundleFiles

public void setAdditionalBundleFiles(java.util.Map<java.lang.String,java.util.List<java.lang.String>> additionalBundleFiles)

getBundleVersionsCache

protected net.sf.ehcache.Cache getBundleVersionsCache()