org.springframework.extensions.directives

Class MessagesDependencyDirective

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

org.springframework.extensions.directives.MessagesDependencyDirective

All Implemented Interfaces:

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

public class MessagesDependencyDirective
extends JavaScriptDependencyDirective

This directive is used to address the problem of browsers caching stale i18n messages for the application. It modifies the WebScript URL requested to include an checksum generated from the WebScript results to ensure that when those results change that 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	LOCALE_REQ_PARM

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

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
MessagesDependencyDirective(String directiveName, org.springframework.extensions.surf.extensibility.ExtensibilityModel model)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body) Processes a request to generate i18n messages.
protected String	getResourceControllerMapping() Overrides the default value which is mapped to the ResourceController and instead returns the value which is mapped to WebScript processing.
void	setMessagesWebScript(MessagesWebScript messagesWebScript) Sets the MessagesWebScript.

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

addLegacyDependencyRequest, createDependencyDirectiveData, createExtensibilityDirectiveData, getDependencySource, getTargetElement

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

getModelObject, getRequestContext, 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

LOCALE_REQ_PARM

public static final String LOCALE_REQ_PARM

See Also:

Constant Field Values

Constructor Detail

MessagesDependencyDirective

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

Method Detail

setMessagesWebScript

public void setMessagesWebScript(MessagesWebScript messagesWebScript)

Sets the MessagesWebScript.

Parameters:

messagesWebScript - MessagesWebScript

getResourceControllerMapping

protected String getResourceControllerMapping()

Overrides the default value which is mapped to the ResourceController and instead returns the value which is mapped to WebScript processing.

Overrides:

getResourceControllerMapping in class AbstractDependencyExtensibilityDirective

Returns:

String

execute

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

Processes a request to generate i18n messages. This is specifically designed to work with the WebScript backed by MessagesWebScript. It will output a request to import a JavaScript via the WebScript but will include a checksum as part of the filename to ensure that the browser does not use stale cached data.

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Overrides:

execute in class JavaScriptDependencyDirective

Throws:

freemarker.template.TemplateException

IOException