org.alfresco.rest.framework.webscripts

Class AbstractResourceWebScript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.rest.framework.webscripts.ApiWebScript

org.alfresco.rest.framework.webscripts.AbstractResourceWebScript

All Implemented Interfaces:

HttpMethodSupport, ActionExecutor, org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

ResourceWebScriptDelete, ResourceWebScriptGet, ResourceWebScriptPost, ResourceWebScriptPut

public abstract class AbstractResourceWebScript
extends ApiWebScript
implements HttpMethodSupport, ActionExecutor

Webscript that handles the request for and execution of a Resource 1) Finds a resource 2) Extracts params 3) Executes params on a resource 4) Post processes the response to add embeds or projected relationship 5) Renders the response

Nested Class Summary

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Nested classes/interfaces inherited from interface org.alfresco.rest.framework.resource.actions.ActionExecutor

ActionExecutor.ExecutionCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceWebScriptHelper	helper
protected ResourceLocator	locator

Fields inherited from class org.alfresco.rest.framework.webscripts.ApiWebScript

CACHE_NEVER, encryptTempFiles, jsonHelper, maxContentSize, memoryThreshold, streamFactory, tempDirectoryName, transactionService, UTF8

Constructor Summary

Constructors

Constructor and Description
AbstractResourceWebScript()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Api api, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res)
ActionExecutor	findExecutor(org.springframework.http.HttpMethod httpMethod, Params params, ResourceWithMetadata resource, java.lang.String contentType) Finds the action executor to execute actions on.
org.springframework.http.HttpMethod	getHttpMethod()
protected void	renderJsonResponse(org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.Object toSerialize) Renders the result of an execution.
void	setHelper(ResourceWebScriptHelper helper)
void	setHttpMethod(org.springframework.http.HttpMethod httpMethod)
void	setLocator(ResourceLocator locator)
void	setParamsExtractor(ParamsExtractor paramsExtractor)
void	setStreamer(ContentStreamer streamer)
protected void	setSuccessResponseStatus(org.springframework.extensions.webscripts.WebScriptResponse res) The response status must be set before the response is written by Jackson (which will by default close and commit the response).
protected void	streamResponse(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, BinaryResource resource)

Methods inherited from class org.alfresco.rest.framework.webscripts.ApiWebScript

execute, getRequest, getResponse, init, renderErrorResponse, resolveException, setContentInfoOnResponse, setDefaultResolver, setEncryptTempFiles, setJsonHelper, setMaxContentSize, setMemoryThreshold, setResolver, setStreamFactory, setTempDirectoryName, setTransactionService

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

Methods inherited from interface org.alfresco.rest.framework.resource.actions.ActionExecutor

execute

Field Detail

locator

protected ResourceLocator locator

helper

protected ResourceWebScriptHelper helper

Constructor Detail

AbstractResourceWebScript

public AbstractResourceWebScript()

Method Detail

execute

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

Specified by:

execute in class ApiWebScript

Throws:

java.io.IOException

streamResponse

protected void streamResponse(org.springframework.extensions.webscripts.WebScriptRequest req,
                  org.springframework.extensions.webscripts.WebScriptResponse res,
                  BinaryResource resource)
                       throws java.io.IOException

Throws:

java.io.IOException

renderJsonResponse

protected void renderJsonResponse(org.springframework.extensions.webscripts.WebScriptResponse res,
                      java.lang.Object toSerialize)
                           throws java.io.IOException

Renders the result of an execution.

Parameters:

res - WebScriptResponse

respons - result of an execution

Throws:

java.io.IOException

setSuccessResponseStatus

protected void setSuccessResponseStatus(org.springframework.extensions.webscripts.WebScriptResponse res)

The response status must be set before the response is written by Jackson (which will by default close and commit the response). In a r/w txn, web script buffered responses ensure that it doesn't really matter but for r/o txns this is important.

Parameters:

res -

findExecutor

public ActionExecutor findExecutor(org.springframework.http.HttpMethod httpMethod,
                          Params params,
                          ResourceWithMetadata resource,
                          java.lang.String contentType)

Finds the action executor to execute actions on.

Parameters:

httpMethod - - the http method

params - Params

resource -

contentType - Request content type

Returns:

ActionExecutor the action executor

setLocator

public void setLocator(ResourceLocator locator)

setHttpMethod

public void setHttpMethod(org.springframework.http.HttpMethod httpMethod)

setParamsExtractor

public void setParamsExtractor(ParamsExtractor paramsExtractor)

setHelper

public void setHelper(ResourceWebScriptHelper helper)

getHttpMethod

public org.springframework.http.HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface HttpMethodSupport

setStreamer

public void setStreamer(ContentStreamer streamer)