org.springframework.extensions.surf.webscripts

Class GetDeployedModules

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.springframework.extensions.surf.webscripts.GetDeployedModules

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.extensions.webscripts.WebScript

public class GetDeployedModules
extends org.springframework.extensions.webscripts.DeclarativeWebScript
implements org.springframework.context.ApplicationContextAware

This is the Java controller for the Module Deployment WebScript (/modules/deploy) that returns the status of the module deployment configuration. The corrent configuration is retrieved from the configured ModuleDeploymentService and converted into "stringified" JSON and added to the model for rendering by the template.

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
GetDeployedModules()

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) Builds a model containing lists of undeployed and deployed modules as JSONObject instances along with a list of the configured ExtensionModuleEvaluator instances and a timestamp of the last server update.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) Provided to satisfy the ApplicationContextAware interface and allows Spring to provide the ApplicationContext to this bean.
void	setModuleDeploymentService(ModuleDeploymentService moduleDeploymentService) Provided so that the Spring application context can set the ModuleDeploymentService to use.

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

GetDeployedModules

public GetDeployedModules()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Provided to satisfy the ApplicationContextAware interface and allows Spring to provide the ApplicationContext to this bean.

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setModuleDeploymentService

public void setModuleDeploymentService(ModuleDeploymentService moduleDeploymentService)

Provided so that the Spring application context can set the ModuleDeploymentService to use. It is essential that the Spring bean configuration has been set correctly otherwise this controller will not achieve anything.

Parameters:

moduleDeploymentService - ModuleDeploymentService

executeImpl

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

Builds a model containing lists of undeployed and deployed modules as JSONObject instances along with a list of the configured ExtensionModuleEvaluator instances and a timestamp of the last server update.

Overrides:

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