org.springframework.extensions.directives

Class JavaScriptDependencyDirective

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

org.springframework.extensions.directives.JavaScriptDependencyDirective

All Implemented Interfaces:

freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel, org.springframework.extensions.surf.extensibility.ExtensibilityDirective

Direct Known Subclasses:

AddInlineJavaScriptDirective, CreateWebScriptWidgetsDirective, CssDependencyDirective, MessagesDependencyDirective, ProcessJsonModelDirective

public class JavaScriptDependencyDirective
extends AbstractDependencyExtensibilityDirective

This directive is used to address the problem of browsers caching stale JavaScript resources. It modifies the source file requested to include an MD5 checksum generated from the file contents to ensure that when a file is updated the browser will be forced to request the updated version (because the browser cached version will be stored against a different URL).

Author:

David Draper

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

AbstractDependencyExtensibilityDirective.ProcessedDependency

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE_AGGREGATED_OUTPUT_PARAM

Fields inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

dependencyAggregator, dependencyHandler

Fields inherited from interface org.springframework.extensions.surf.extensibility.ExtensibilityDirective

ACTION, ACTION_AFTER, ACTION_BEFORE, ACTION_MERGE, ACTION_MODIFY, ACTION_REMOVE, ACTION_REPLACE, DIRECTIVE_ID, TARGET

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
JavaScriptDependencyDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLegacyDependencyRequest(Map params) Provides support for making dependency requests when there isn't a DeferredContentTargetModelElement to add content to.
protected DependencyDirectiveData	createDependencyDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env, String dependencyToAdd, String group) Creates the DependencyDirectiveData.
org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData	createExtensibilityDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env)
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body)
protected String	getDependencySource(Map params) Gets the parameter that defines the dependency source file.
protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement	getTargetElement() Gets the DeferredContentTargetModelElement to associate with the directive.

Methods inherited from class org.springframework.extensions.directives.AbstractDependencyExtensibilityDirective

getModelObject, getRequestContext, getResourceControllerMapping, getToInsert, getUpdatedSrc, getWebFrameworkConfig, processDependency, setDependencyAggregator, setDependencyHandler, setModelObject, setRequestContext, setWebFrameworkConfig

Methods inherited from class org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

after, before, getId, getModel, merge, remove, replace

Methods inherited from class org.springframework.extensions.surf.extensibility.impl.AbstractFreeMarkerDirective

getBooleanProperty, getDirectiveName, getStringProperty

Methods inherited from class java.lang.Object

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

Field Detail

FORCE_AGGREGATED_OUTPUT_PARAM

public static final String FORCE_AGGREGATED_OUTPUT_PARAM

See Also:

Constant Field Values

Constructor Detail

JavaScriptDependencyDirective

public JavaScriptDependencyDirective(String directiveName,
                             org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

Method Detail

execute

public void execute(freemarker.core.Environment env,
           Map params,
           freemarker.template.TemplateModel[] loopVars,
           freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException,
                    IOException

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Overrides:

execute in class org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

Throws:

freemarker.template.TemplateException

IOException

addLegacyDependencyRequest

protected void addLegacyDependencyRequest(Map params)
                                   throws freemarker.template.TemplateModelException

Provides support for making dependency requests when there isn't a DeferredContentTargetModelElement to add content to. This will occur when processing the .head.ftl files of a WebScript and is considered the "legacy" approach to making dependency requests. The preferred approach is to move the requests to the *.html.ftl file and use the new <@script> and <@link> directive implementations.

Parameters:

params - Map

Throws:

freemarker.template.TemplateModelException

getDependencySource

protected String getDependencySource(Map params)
                              throws freemarker.template.TemplateModelException

Gets the parameter that defines the dependency source file. By default this is "src".

Parameters:

params - The map of parameters to search through.

Returns:

The parameter defining the dependency source file.

Throws:

freemarker.template.TemplateModelException - When the target parameter cannot be found.

getTargetElement

protected org.springframework.extensions.surf.extensibility.DeferredContentTargetModelElement getTargetElement()

Gets the DeferredContentTargetModelElement to associate with the directive. By default this is the OutputJavaScriptContentModelElement.

Returns:

DeferredContentTargetModelElement

createExtensibilityDirectiveData

public org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData createExtensibilityDirectiveData(String id,
                                                                                                            String action,
                                                                                                            String target,
                                                                                                            Map params,
                                                                                                            freemarker.template.TemplateDirectiveBody body,
                                                                                                            freemarker.core.Environment env)
                                                                                                              throws freemarker.template.TemplateException

Overrides:

createExtensibilityDirectiveData in class org.springframework.extensions.surf.extensibility.impl.AbstractExtensibilityDirective

Throws:

freemarker.template.TemplateException

createDependencyDirectiveData

protected DependencyDirectiveData createDependencyDirectiveData(String id,
                                                    String action,
                                                    String target,
                                                    Map params,
                                                    freemarker.template.TemplateDirectiveBody body,
                                                    freemarker.core.Environment env,
                                                    String dependencyToAdd,
                                                    String group)
                                                         throws freemarker.template.TemplateModelException

Creates the DependencyDirectiveData.

Parameters:

id - String

action - String

target - String

params - Map

body - TemplateDirectiveBody

env - Environment

dependencyToAdd - String

group - String

Returns:

DependencyDirectiveData

Throws:

freemarker.template.TemplateModelException