org.alfresco.rest.framework.webscripts

Class ApiWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.rest.framework.webscripts.ApiWebScript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

AbstractResourceWebScript, InfoWebScriptGet, WebScriptOptionsMetaData

public abstract class ApiWebScript
extends org.springframework.extensions.webscripts.AbstractWebScript

Entry point for API webscript. Supports version/scope as well as discovery.

Nested Class Summary

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.extensions.webscripts.Cache	CACHE_NEVER
protected JacksonHelper	jsonHelper
static java.lang.String	UTF8

Constructor Summary

Constructors

Constructor and Description
ApiWebScript()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
void	renderErrorResponse(ErrorResponse errorResponse, org.springframework.extensions.webscripts.WebScriptResponse res) Renders a JSON error response
protected ErrorResponse	resolveException(java.lang.Exception ex)
protected void	setContentInfoOnResponse(org.springframework.extensions.webscripts.WebScriptResponse res, ContentInfo contentInfo) Sets the response headers with any information we know about the content
void	setJsonHelper(JacksonHelper jsonHelper)
void	setResolver(ExceptionResolver resolver)

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

Field Detail

jsonHelper

protected JacksonHelper jsonHelper

UTF8

public static final java.lang.String UTF8

See Also:

Constant Field Values

CACHE_NEVER

public static final org.springframework.extensions.webscripts.Cache CACHE_NEVER

Constructor Detail

ApiWebScript

public ApiWebScript()

Method Detail

execute

public void execute(org.springframework.extensions.webscripts.WebScriptRequest req,
           org.springframework.extensions.webscripts.WebScriptResponse res)
             throws java.io.IOException

Throws:

java.io.IOException

resolveException

protected ErrorResponse resolveException(java.lang.Exception ex)

execute

public abstract void execute(Api api,
           org.springframework.extensions.webscripts.WebScriptRequest req,
           org.springframework.extensions.webscripts.WebScriptResponse res)
                      throws java.io.IOException

Throws:

java.io.IOException

renderErrorResponse

public void renderErrorResponse(ErrorResponse errorResponse,
                       org.springframework.extensions.webscripts.WebScriptResponse res)
                         throws java.io.IOException

Renders a JSON error response

Parameters:

errorResponse - The error

res - web script response

Throws:

java.io.IOException

setContentInfoOnResponse

protected void setContentInfoOnResponse(org.springframework.extensions.webscripts.WebScriptResponse res,
                            ContentInfo contentInfo)

Sets the response headers with any information we know about the content

Parameters:

res - WebScriptResponse

contentInfo - Content Information

setResolver

public void setResolver(ExceptionResolver resolver)

setJsonHelper

public void setJsonHelper(JacksonHelper jsonHelper)