org.broadleafcommerce.common.web.request

Class ResourcesRequest

java.lang.Object

org.broadleafcommerce.common.web.request.ResourcesRequest

@RequestScope
 @Component(value="blResourcesRequest")
public class ResourcesRequest
extends Object

Keeps track of the resources needed for <blc:bundle> and <blc:bundlepreload> tags so that the list of files does not need to be duplicated across both tags.

If bundling is enabled and appropriate, use the getBundleForBundleName(String) and saveBundleForBundleName(String, String) to fetch and store the bundled file for the bundle name.

If not using bundling, use getFilesForBundleName(String) and saveFilesForBundleName(String, List) to fetch and store the files associated with the bundle name.

Author:

Jacob Mitash

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	bundlesRequested
protected Map<String,List<String>>	filesRequested

Constructor Summary

Constructors

Constructor and Description
ResourcesRequest()

Method Summary

Modifier and Type	Method and Description
String	getBundleForBundleName(String name) Gets the bundle for the bundle name if previously used on this request
List<String>	getFilesForBundleName(String name) Gets the files included in a bundle if previously used on this request
void	saveBundleForBundleName(String name, String bundle) Saves the bundle with the given name to the request so it can be recalled later in the template
void	saveFilesForBundleName(String name, List<String> files) Saves the bundle with the given name and files so it can be recalled later in the template

Methods inherited from class java.lang.Object

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

Field Detail

bundlesRequested

protected Map<String,String> bundlesRequested

filesRequested

protected Map<String,List<String>> filesRequested

Constructor Detail

ResourcesRequest

public ResourcesRequest()

Method Detail

getBundleForBundleName

public String getBundleForBundleName(String name)

Gets the bundle for the bundle name if previously used on this request

Parameters:

name - the name of the bundle to search for

Returns:

the bundle if found, otherwise null

saveBundleForBundleName

public void saveBundleForBundleName(String name,
                                    String bundle)

Saves the bundle with the given name to the request so it can be recalled later in the template

Parameters:

name - the name of the bundle to save

bundle - the path of the bundle

getFilesForBundleName

public List<String> getFilesForBundleName(String name)

Gets the files included in a bundle if previously used on this request

Parameters:

name - the name of the bundle to search for

Returns:

the list of files in the bundle if found, otherwise null

saveFilesForBundleName

public void saveFilesForBundleName(String name,
                                   List<String> files)

Saves the bundle with the given name and files so it can be recalled later in the template

Parameters:

name - the name of the bundle to save

files - the files to include in the bundle