|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.extensions.webscripts.AbstractWebScript
public abstract class AbstractWebScript
Abstract implementation of a Web Script
Nested Class Summary | |
---|---|
protected static class |
AbstractWebScript.ScriptDetails
The combination of a ScriptContent and a request MIME type. |
Constructor Summary | |
---|---|
AbstractWebScript()
|
Method Summary | |
---|---|
protected Map<String,String> |
createArgs(WebScriptRequest req)
Create a map of arguments from Web Script Request (for scripting) |
protected Map<String,String[]> |
createArgsM(WebScriptRequest req)
Create a map of (array) arguments from Web Script Request (for scripting) |
protected Map<String,String> |
createHeaders(WebScriptRequest req)
Create a map of headers from Web Script Request (for scripting) |
protected Map<String,String[]> |
createHeadersM(WebScriptRequest req)
Create a map of (array) headers from Web Script Request (for scripting) |
protected Map<String,Object> |
createScriptParameters(WebScriptRequest req,
WebScriptResponse res,
Map<String,Object> customParams)
Create a model for script usage |
protected WebScriptException |
createStatusException(Throwable e,
WebScriptRequest req,
WebScriptResponse res)
Create an exception whose associated message is driven from a status template and model |
protected Map<String,Object> |
createTemplateParameters(WebScriptRequest req,
WebScriptResponse res,
Map<String,Object> customParams)
Create a model for template usage |
protected void |
executeScript(ScriptContent location,
Map<String,Object> model)
Execute a script |
protected Container |
getContainer()
|
Description |
getDescription()
Gets the Service Description |
protected AbstractWebScript.ScriptDetails |
getExecuteScript(String mimetype)
Find execute script for given request format Note: This method caches the script to request format mapping |
ResourceBundle |
getResources()
Gets the Service Resources |
protected StatusTemplate |
getStatusTemplate(String scriptId,
int statusCode,
String format)
Find status template Note: This method caches template search results |
void |
init(Container container,
Description description)
Initialise Web Script |
protected void |
renderString(String template,
Map<String,Object> model,
Writer writer)
Render a template (contents as string) |
protected void |
renderString(String template,
Map<String,Object> model,
Writer writer,
String extension)
Render a template (contents as string) |
protected void |
renderTemplate(String templatePath,
Map<String,Object> model,
Writer writer)
Render a template (identified by path) |
protected void |
sendStatus(WebScriptRequest req,
WebScriptResponse res,
Status status,
Cache cache,
String format,
Map<String,Object> model)
Render an explicit response status template |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.springframework.extensions.webscripts.WebScript |
---|
execute |
Constructor Detail |
---|
public AbstractWebScript()
Method Detail |
---|
public void init(Container container, Description description)
scriptRegistry
- protected final Container getContainer()
public final Description getDescription()
WebScript
getDescription
in interface WebScript
public final ResourceBundle getResources()
WebScript
getResources
in interface WebScript
protected AbstractWebScript.ScriptDetails getExecuteScript(String mimetype)
mimetype
-
protected Map<String,Object> createScriptParameters(WebScriptRequest req, WebScriptResponse res, Map<String,Object> customParams)
req
- web script requestres
- web script responsecustomModel
- custom model entries
protected Map<String,Object> createTemplateParameters(WebScriptRequest req, WebScriptResponse res, Map<String,Object> customParams)
req
- web script requestres
- web script responsecustomModel
- custom model entries
protected final Map<String,String> createArgs(WebScriptRequest req)
req
- Web Script Request
protected final Map<String,String[]> createArgsM(WebScriptRequest req)
req
- Web Script Request
protected final Map<String,String> createHeaders(WebScriptRequest req)
req
- Web Script Request
protected final Map<String,String[]> createHeadersM(WebScriptRequest req)
req
- Web Script Request
protected final void renderTemplate(String templatePath, Map<String,Object> model, Writer writer)
templatePath
- template pathmodel
- modelwriter
- output writerprotected final void renderString(String template, Map<String,Object> model, Writer writer)
template
- the templatemodel
- modelwriter
- output writerprotected final void renderString(String template, Map<String,Object> model, Writer writer, String extension)
template
- the templatemodel
- modelwriter
- output writerextension
- optional template extension type (i.e. ftl, php)protected final void sendStatus(WebScriptRequest req, WebScriptResponse res, Status status, Cache cache, String format, Map<String,Object> model) throws IOException
req
- web script requestres
- web script responsestatus
- web script statusformat
- formatmodel
- model
IOException
protected final WebScriptException createStatusException(Throwable e, WebScriptRequest req, WebScriptResponse res)
e
- exceptionreq
- web script requestres
- web script response
protected StatusTemplate getStatusTemplate(String scriptId, int statusCode, String format)
scriptId
- statusCode
- format
-
protected void executeScript(ScriptContent location, Map<String,Object> model)
location
- script locationmodel
- modelpublic String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |