Package org.springframework.extensions.webscripts

Class DeclarativeWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

All Implemented Interfaces:

WebScript

public class DeclarativeWebScript
extends AbstractWebScript

Script/template driven based implementation of an Web Script

Author:

davidc

Nested Class Summary

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

AbstractWebScript.ScriptDetails

Constructor Summary

Constructors

Constructor	Description
DeclarativeWebScript()

Method Summary

Modifier and Type	Method	Description
void	execute(WebScriptRequest req, WebScriptResponse res)	Execute the Service
protected void	executeFinallyImpl(WebScriptRequest req, Status status, Cache cache, java.util.Map<java.lang.String,java.lang.Object> model)	Execute custom Java logic to clean up any resources
protected java.util.Map<java.lang.String,java.lang.Object>	executeImpl(WebScriptRequest req, Status status)	Deprecated.
protected java.util.Map<java.lang.String,java.lang.Object>	executeImpl(WebScriptRequest req, Status status, Cache cache)	Execute custom Java logic
protected java.util.Map<java.lang.String,java.lang.Object>	executeImpl(WebScriptRequest req, WebScriptStatus status)	Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getTemplateModel(WebScriptRequest req, WebScriptResponse res)	Get map of template parameters that are available with given request.
protected void	renderFormatTemplate(java.lang.String format, java.util.Map<java.lang.String,java.lang.Object> model, java.io.Writer writer)	Render a template (of given format) to the Web Script Response

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

DeclarativeWebScript

public DeclarativeWebScript()

Method Detail

execute

public final void execute(WebScriptRequest req,
                          WebScriptResponse res)
                   throws java.io.IOException

Description copied from interface: WebScript

Execute the Service

Parameters:

req - WebScriptRequest representing the request to this service

res - WebScriptResponse encapsulating the result of this service

Throws:

java.io.IOException

executeImpl

protected java.util.Map<java.lang.String,java.lang.Object> executeImpl(WebScriptRequest req,
                                                                             WebScriptStatus status)

Deprecated.

Execute custom Java logic

Parameters:

req - Web Script request

status - Web Script status

Returns:

custom service model

executeImpl

protected java.util.Map<java.lang.String,java.lang.Object> executeImpl(WebScriptRequest req,
                                                                             Status status)

Deprecated.

Execute custom Java logic

Parameters:

req - Web Script request

status - Web Script status

Returns:

custom service model

executeImpl

protected java.util.Map<java.lang.String,java.lang.Object> executeImpl(WebScriptRequest req,
                                                                             Status status,
                                                                             Cache cache)

Execute custom Java logic

Parameters:

req - Web Script request

status - Web Script status

cache - Web Script cache

Returns:

custom service model

executeFinallyImpl

protected void executeFinallyImpl(WebScriptRequest req,
                                  Status status,
                                  Cache cache,
                                  java.util.Map<java.lang.String,java.lang.Object> model)

Execute custom Java logic to clean up any resources

Parameters:

req - Web Script request

status - Web Script status

cache - Web Script cache

model - model

renderFormatTemplate

protected final void renderFormatTemplate(java.lang.String format,
                                          java.util.Map<java.lang.String,java.lang.Object> model,
                                          java.io.Writer writer)

Render a template (of given format) to the Web Script Response

Parameters:

format - template format (null, default format)

model - data model to render

writer - where to output

getTemplateModel

public java.util.Map<java.lang.String,java.lang.Object> getTemplateModel(WebScriptRequest req,
                                                                               WebScriptResponse res)
                                                                        throws java.io.IOException

Get map of template parameters that are available with given request. This method is for FreeMarker Editor Extension plugin of Surf Dev Tools.

Parameters:

req - webscript request

res - webscript response

Returns:

Map

Throws:

java.io.IOException