org.springframework.extensions.surf

Class DojoDependencyHandler

java.lang.Object

org.springframework.extensions.surf.DojoDependencyHandler

All Implemented Interfaces:

CacheReporter

public class DojoDependencyHandler
extends Object
implements CacheReporter

This bean provides a way of ensuring that Dojo requested dependency file contents are modified to reference MD5 checksum codes

Author:

David Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_PACKAGES
static String	WIDGET_CONFIG
static String	WIDGET_NAME
static String	WIDGETS_LIST

Constructor Summary

Constructors

Constructor and Description
DojoDependencyHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCaches() Clears the caches stored in the cachedDeps and generatedResourceCache maps.
protected static String	getBuildKeyForDependencies(Map<String,DojoDependencies> dependencies) Construct the hash lookup key for a Map of Dojo dependencies.
String	getCachedResource(String path) Attempts to retrieve a generated JavaScript resource that has been previously cached.
String	getChecksumForDependencies(Map<String,DojoDependencies> dependencies, String pagePath, DojoDependencies pageDeps) Return the checksum for a set of dependencies.
String	getChecksumPathForDependencies(String source) This method is used to both generate the checksum for the supplied JavaScript source code and also to cache that generated source code against the checksum generated.
DojoDependencies	getDependencies(String path) Gets the DojoDependencies for the supplied path.
String	getPath(String sourcePath, String dependencyPath) Calculates the path of the dependency relative to the path of the supplied source path.
Map<String,String>	getRequestDojoPackages() This returns the Dojo packages for the current request (that will include all dynamic configuration extensions) if available, otherwise returns the spring injected value (the static configuration).
StringBuilder	outputAggregateResource(Map<String,DojoDependencies> depsToOutput, String baseUrl) This method builds the equivalent of a Dojo build layer from the Map of supplied DojoDependencies.
StringBuilder	outputDependency(String name, String path, DojoDependencies deps) This method is used to generate the output for a single dependency in a way that replicates what would be generated from building a Dojo layer.
void	processControllerWidgets(List widgets, Map<String,DojoDependencies> dependenciesForCurrentRequest) Recursively processes lists of widgets that are defined in the WebScript model.
void	processCssDependencies(Map<String,DojoDependencies> dependenciesForCurrentRequest, OutputCSSContentModelElement outputCss, String prefix, String group) This method iterates through the dependencies provided in reverse.
void	processNonAmdDependencies(Map<String,DojoDependencies> dependenciesForCurrentRequest, OutputJavaScriptContentModelElement outputJs, String prefix, String group) This method iterates through the dependencies provided in reverse.
void	processString(String contents, DojoDependencies dependencies, Map<String,DojoDependencies> dependenciesForCurrentRequest) Performs analysis on the supplied String and updates the supplied DojoDependencies object.
void	recursivelyProcessDependencies(DojoDependencies deps, Map<String,DojoDependencies> allDeps) Recursively processes all the JavaScript dependencies in the supplied DojoDependencies object.
List<CacheReport>	report()
protected String	reverseAlias(String path) Calculates the configured Dojo package from the supplied path.
void	setDependencyAggregator(DependencyAggregator dependencyAggregator) Setter provided to allow the Spring application context to set a DependencyAggregator.
void	setDependencyHandler(DependencyHandler dependencyHandler) Setter provided to allow the Spring application context to set a DependencyHandler.
void	setDependencyRules(List<DojoDependencyRule> dependencyRules) Setter provided to allow the Spring application context to set the DojoDependencyRule list.
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement) Setter provided to allow the Spring application context to set a WebFrameworkConfigElement.

Methods inherited from class java.lang.Object

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

Field Detail

WIDGET_NAME

public static final String WIDGET_NAME

See Also:

Constant Field Values

WIDGET_CONFIG

public static final String WIDGET_CONFIG

See Also:

Constant Field Values

WIDGETS_LIST

public static final String WIDGETS_LIST

See Also:

Constant Field Values

REQUEST_PACKAGES

public static final String REQUEST_PACKAGES

See Also:

Constant Field Values

Constructor Detail

DojoDependencyHandler

public DojoDependencyHandler()

Method Detail

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

Setter provided to allow the Spring application context to set a DependencyHandler.

Parameters:

dependencyHandler - DependencyHandler

setDependencyAggregator

public void setDependencyAggregator(DependencyAggregator dependencyAggregator)

Setter provided to allow the Spring application context to set a DependencyAggregator.

Parameters:

dependencyAggregator - DependencyAggregator

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

Setter provided to allow the Spring application context to set a WebFrameworkConfigElement.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

setDependencyRules

public void setDependencyRules(List<DojoDependencyRule> dependencyRules)

Setter provided to allow the Spring application context to set the DojoDependencyRule list.

Parameters:

dependencyRules - List

clearCaches

public void clearCaches()

Clears the caches stored in the cachedDeps and generatedResourceCache maps. This method has been provided to allow a WebScript to clear the caches of running systems.

Specified by:

clearCaches in interface CacheReporter

report

public List<CacheReport> report()

Specified by:

report in interface CacheReporter

processString

public void processString(String contents,
                 DojoDependencies dependencies,
                 Map<String,DojoDependencies> dependenciesForCurrentRequest)

Performs analysis on the supplied String and updates the supplied DojoDependencies object.

Parameters:

contents - String

dependencies - DojoDependencies

dependenciesForCurrentRequest - Map

getDependencies

public DojoDependencies getDependencies(String path)

Gets the DojoDependencies for the supplied path. The cache is checked first to make sure that the processing hasn't already been done before but if it hasn't been processed the path will be processed. All the JavaScript dependencies found for the supplied path should be processed by the calling code.

Returns:

The DojoDependencies for the supplied path

recursivelyProcessDependencies

public void recursivelyProcessDependencies(DojoDependencies deps,
                                  Map<String,DojoDependencies> allDeps)

Recursively processes all the JavaScript dependencies in the supplied DojoDependencies object. All dependency paths found are added to the supplied Map so that all the dependencies for the current request can be tracked and used to prevent infinite loops.

Parameters:

deps - The DojoDependencies to process.

allDeps - A Map of all the dependencies processed so far.

getCachedResource

public String getCachedResource(String path)

Attempts to retrieve a generated JavaScript resource that has been previously cached. The resource will be present if it has been cached via a call from a ProcessJsonModelDirective instance to the getChecksumPathForDependencies method.

Parameters:

path - The path to look up in the cache.

Returns:

A String containing the generated resource content or null if it couldn't be found.

getChecksumPathForDependencies

public String getChecksumPathForDependencies(String source)

This method is used to both generate the checksum for the supplied JavaScript source code and also to cache that generated source code against the checksum generated. This is done so that when the ResourceController looks for the resource it can be retrieved. The path returned is mapped to the "surf" Dojo package. This package should always exist as it is defined in the core Surf configuration.

Parameters:

source - The JavaScript source to generate the checksum for and to be cached.

Returns:

The path including the checksum.

getChecksumForDependencies

public String getChecksumForDependencies(Map<String,DojoDependencies> dependencies,
                                String pagePath,
                                DojoDependencies pageDeps)

Return the checksum for a set of dependencies. The checksum for a set is cached. The checksum will be resolved based on the aggregated resource output for the dependencies if it has not already been generated.

Parameters:

dependencies - Map of dependencies for a page - the keys are used as the overall hashkey

Returns:

checksum

getBuildKeyForDependencies

protected static String getBuildKeyForDependencies(Map<String,DojoDependencies> dependencies)

Construct the hash lookup key for a Map of Dojo dependencies. The large maps of dependencies will be indentical generally - there will be one per major construct per Dojo page e.g. a header or an entire page. We ensure the same cached JS set is cached and looked up per set of dependencies.

The key must be based on the keys for each of the dependencies in the list - but not the values e.g. not based on the common HashMap Entry algorithm getKey.hashCode() ^ getValue().hashCode() as we cannot guarantee that the value objects will return the same hash each time.

Parameters:

dependencies - Map of DojoDependencies

Returns:

hash key

reverseAlias

protected String reverseAlias(String path)

Calculates the configured Dojo package from the supplied path. The Dojo packages are defined in the Surf configuration which is also used to bootstrap Dojo (assuming that the correct Dojo bootstrap WebScript has been used on the current page).

Parameters:

path - The path to find the Dojo package for.

Returns:

The package for the supplied path (or the unchanged path if it is not part of package).

outputAggregateResource

public StringBuilder outputAggregateResource(Map<String,DojoDependencies> depsToOutput,
                                    String baseUrl)

This method builds the equivalent of a Dojo build layer from the Map of supplied DojoDependencies.

Returns:

A String representing a simulated Dojo built layer.

outputDependency

public StringBuilder outputDependency(String name,
                             String path,
                             DojoDependencies deps)
                               throws IOException

This method is used to generate the output for a single dependency in a way that replicates what would be generated from building a Dojo layer. Effectively the supplied file is added to a cache object that prevents Dojo from needing to explicitly load the file when it is required by another file.

Parameters:

name - The (short) name of the dependency (relative to the Dojo AMD package configuration).

path - The full path of the file

deps - A list of the dependencies known to the current dependency. This is primarily used for processing text dependencies.

Returns:

StringBuilder

Throws:

IOException

getRequestDojoPackages

public Map<String,String> getRequestDojoPackages()

This returns the Dojo packages for the current request (that will include all dynamic configuration extensions) if available, otherwise returns the spring injected value (the static configuration).

Returns:

Map

getPath

public String getPath(String sourcePath,
             String dependencyPath)

Calculates the path of the dependency relative to the path of the supplied source path. If dependency path is mapped to a Dojo package alias then that package is used to calculate the path.

Parameters:

sourcePath - The path of the file from which the dependency is referenced.

dependencyPath - The path of the dependency as referenced in the source file.

Returns:

String

processControllerWidgets

public void processControllerWidgets(List widgets,
                            Map<String,DojoDependencies> dependenciesForCurrentRequest)

Recursively processes lists of widgets that are defined in the WebScript model. This works on the assumption that nested widgets will be configured as follows:

    name: <widget-name>
    config: {
       widgets: [
          {
             name: <widget-name>
             <etc...>
          }
       ]
    }
 

Parameters:

widgets - The List of widgets currently being processed.

dependenciesForCurrentRequest - The dependencies processed on the current request.

processCssDependencies

public void processCssDependencies(Map<String,DojoDependencies> dependenciesForCurrentRequest,
                          OutputCSSContentModelElement outputCss,
                          String prefix,
                          String group)

This method iterates through the dependencies provided in reverse. This is so that the dependency CSS resources are output before the widget that places the dependency. This is done so that overrides will occur as expected. This is only relevant for CSS files. The remaining dependencies are all handled in their own ways.

Parameters:

dependenciesForCurrentRequest - Map

outputCss - OutputCSSContentModelElement

prefix - String

group - String

processNonAmdDependencies

public void processNonAmdDependencies(Map<String,DojoDependencies> dependenciesForCurrentRequest,
                             OutputJavaScriptContentModelElement outputJs,
                             String prefix,
                             String group)

This method iterates through the dependencies provided in reverse. This is so that the non AMD resources are output before the widget that places the dependency.

Parameters:

dependenciesForCurrentRequest - Map

outputJs - OutputJavaScriptContentModelElement

prefix - String

group - String