org.springframework.extensions.surf.webscripts

Class XHRDojoDependencies

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.springframework.extensions.surf.webscripts.XHRDojoDependencies

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class XHRDojoDependencies
extends org.springframework.extensions.webscripts.DeclarativeWebScript

This backs the /surf/dojo/xhr/dependencies WebScript and should be used to build resource files containing all the required CSS and JavaScript dependencies for a set of widgets defined in a stringified JSON object passed as a request parameter.

Author:

David Draper

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Constructor Summary

Constructors

Constructor and Description
XHRDojoDependencies()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
Map<String,String>	generateCssMediaToResourceMap(Map<String,DojoDependencies> dependenciesForCurrentRequest)
DependencyAggregator	getDependencyAggregator()
DependencyHandler	getDependencyHandler()
DojoDependencyHandler	getDojoDependencyHandler()
I18nDependencyHandler	getI18nDependencyHandler()
WebFrameworkConfigElement	getWebFrameworkConfig()
void	processDependency(String name, Map<String,DojoDependencies> dependenciesForCurrentRequest) Processes an individual dependency.
void	processServices(org.json.simple.JSONObject json, Map<String,DojoDependencies> dependenciesForCurrentRequest)
void	processWidgets(org.json.simple.JSONObject widgets, Map<String,DojoDependencies> dependenciesForCurrentRequest) This method recursively processes JSON objects defining widgets updating the supplied Map of dependencies.
void	setDependencyAggregator(DependencyAggregator dependencyAggregator)
void	setDependencyHandler(DependencyHandler dependencyHandler)
void	setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)
void	setI18nDependencyHandler(I18nDependencyHandler i18nDependencyHandler)
void	setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)

Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XHRDojoDependencies

public XHRDojoDependencies()

Method Detail

executeImpl

protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
                             org.springframework.extensions.webscripts.Status status,
                             org.springframework.extensions.webscripts.Cache cache)

Overrides:

executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript

processServices

public void processServices(org.json.simple.JSONObject json,
                   Map<String,DojoDependencies> dependenciesForCurrentRequest)

Parameters:

json - A JSONObject containing the services configuration to be processed.

dependenciesForCurrentRequest - A Map of the dependencies processed for the current request

processDependency

public void processDependency(String name,
                     Map<String,DojoDependencies> dependenciesForCurrentRequest)

Processes an individual dependency.

Parameters:

name - The name of the widget/service to be processed.

dependenciesForCurrentRequest - A Map of the dependencies processed for the current request

processWidgets

public void processWidgets(org.json.simple.JSONObject widgets,
                  Map<String,DojoDependencies> dependenciesForCurrentRequest)

This method recursively processes JSON objects defining widgets updating the supplied Map of dependencies.

Parameters:

widgets - A JSONObject containing the widget configuration to be processed.

dependenciesForCurrentRequest - A Map of the dependencies processed for the current request

generateCssMediaToResourceMap

public Map<String,String> generateCssMediaToResourceMap(Map<String,DojoDependencies> dependenciesForCurrentRequest)

Parameters:

dependenciesForCurrentRequest - Map

Returns:

Map

getDependencyHandler

public DependencyHandler getDependencyHandler()

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

getDojoDependencyHandler

public DojoDependencyHandler getDojoDependencyHandler()

setDojoDependencyHandler

public void setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)

getDependencyAggregator

public DependencyAggregator getDependencyAggregator()

setDependencyAggregator

public void setDependencyAggregator(DependencyAggregator dependencyAggregator)

getI18nDependencyHandler

public I18nDependencyHandler getI18nDependencyHandler()

setI18nDependencyHandler

public void setI18nDependencyHandler(I18nDependencyHandler i18nDependencyHandler)

getWebFrameworkConfig

public WebFrameworkConfigElement getWebFrameworkConfig()

setWebFrameworkConfig

public void setWebFrameworkConfig(WebFrameworkConfigElement webFrameworkConfig)