org.springframework.extensions.directives

Class ProcessJsonModelDirective

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.ProcessJsonModelDirective

All Implemented Interfaces:

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

public class ProcessJsonModelDirective
extends JavaScriptDependencyDirective

The purpose of this widget is to allow "New Share" pages to be created via a single WebScript. This directive processes the contents of the model defined by the JavaScript controller into the client-side JavaScript required to define a new page.

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	DIRECTIVE_NAME
static String	GROUP_MEMBERSHIPS_KEY
static String	MODEL_KEY
static Pattern	pattern This is a custom token matching pattern to use to override the default one defined in UriUtils.
static String	PUB_SUB_SCOPE_KEY
static String	TARGET_DOM_ID_KEY

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

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildConstantsForPage() Builds a Dojo cache JavaScript object containing the output from the /constants/Default WebScript that includes the context specific data (such as user information).
protected String	buildI18nForPage(Map<String,DojoDependencies> dependenciesForCurrentRequest, freemarker.template.TemplateHashModel model) Constructs the i18n properties JavaScript content for the page.
protected String	buildJavaScriptForPage(String checksum, String servicesJSONStr, String widgetsJSONStr, String publishOnLoadJSONStr, String rootDomId, String pubSubScope, String groupMemberships, Map<String,DojoDependencies> dependenciesForCurrentRequest, freemarker.template.TemplateHashModel model) Constructs the JavaScript required to create a page object.
org.springframework.extensions.surf.extensibility.ExtensibilityDirectiveData	createExtensibilityDirectiveData(String id, String action, String target, Map params, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env) Looks up the object from the model defined by the WebScript controller and processes all the dependencies that it declares.
protected void	runWebScript(String uri, Writer writer) Run a WebScript against the supplied Writer.
void	setConfigService(org.springframework.extensions.config.ConfigService configService)
void	setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)
void	setI18nDependencyHandler(I18nDependencyHandler i18nDependencyHandler)
void	setWebScriptsContainer(LocalWebScriptRuntimeContainer webScriptsContainer)

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

addLegacyDependencyRequest, createDependencyDirectiveData, execute, getDependencySource, getTargetElement

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

DIRECTIVE_NAME

public static final String DIRECTIVE_NAME

See Also:

Constant Field Values

MODEL_KEY

public static final String MODEL_KEY

See Also:

Constant Field Values

TARGET_DOM_ID_KEY

public static final String TARGET_DOM_ID_KEY

See Also:

Constant Field Values

PUB_SUB_SCOPE_KEY

public static final String PUB_SUB_SCOPE_KEY

See Also:

Constant Field Values

GROUP_MEMBERSHIPS_KEY

public static final String GROUP_MEMBERSHIPS_KEY

See Also:

Constant Field Values

pattern

public static Pattern pattern

This is a custom token matching pattern to use to override the default one defined in UriUtils. It is roughly the same but uses double curly braces {{ }} rather than single to avoid potential clashes within the JSON structure.

Constructor Detail

ProcessJsonModelDirective

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

Method Detail

setDojoDependencyHandler

public void setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)

setI18nDependencyHandler

public void setI18nDependencyHandler(I18nDependencyHandler i18nDependencyHandler)

setWebScriptsContainer

public void setWebScriptsContainer(LocalWebScriptRuntimeContainer webScriptsContainer)

setConfigService

public void setConfigService(org.springframework.extensions.config.ConfigService configService)

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

Looks up the object from the model defined by the WebScript controller and processes all the dependencies that it declares. When running in aggregation mode (which should be used for production) it generates the JavaScript source that simulates a Dojo build layer and creates the JavaScript code to create the root Dojo page object (defined in the Surf Dojo configuration) and places a requirement on that generated build layer.

Overrides:

createExtensibilityDirectiveData in class JavaScriptDependencyDirective

Throws:

freemarker.template.TemplateException

buildI18nForPage

protected String buildI18nForPage(Map<String,DojoDependencies> dependenciesForCurrentRequest,
                      freemarker.template.TemplateHashModel model)

Constructs the i18n properties JavaScript content for the page. This will be loaded into the page as a separate resource.

Parameters:

dependenciesForCurrentRequest - Map

model - TemplateHashModel

Returns:

String

buildJavaScriptForPage

protected String buildJavaScriptForPage(String checksum,
                            String servicesJSONStr,
                            String widgetsJSONStr,
                            String publishOnLoadJSONStr,
                            String rootDomId,
                            String pubSubScope,
                            String groupMemberships,
                            Map<String,DojoDependencies> dependenciesForCurrentRequest,
                            freemarker.template.TemplateHashModel model)

Constructs the JavaScript required to create a page object.

Parameters:

servicesJSONStr - A JSON string containing all the services required on the page.

widgetsJSONStr - A JSON string containing all the widgets required on the page.

rootDomId - The ID of the DOM node to bind the page widget to

pubSubScope - A pubSubScope to apply to the page widget

groupMemberships - The group membership data for the current user (to set on the page object)

dependenciesForCurrentRequest - The dependencies for this page

model - The Freemarker model

Returns:

The

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method