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, NetworksWebScriptGet, NetworkWebScriptGet, WebScriptOptionsMetaData

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

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

Author:

Gethin James

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 boolean	encryptTempFiles
protected JacksonHelper	jsonHelper
protected long	maxContentSize
protected int	memoryThreshold
protected org.apache.chemistry.opencmis.server.shared.ThresholdOutputStreamFactory	streamFactory
protected String	tempDirectoryName
protected TransactionService	transactionService
static 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)
protected BufferedRequest	getRequest(org.springframework.extensions.webscripts.WebScriptRequest req)
protected BufferedResponse	getResponse(org.springframework.extensions.webscripts.WebScriptResponse resp)
void	init()
void	renderErrorResponse(ErrorResponse errorResponse, org.springframework.extensions.webscripts.WebScriptResponse res) Renders a JSON error response
protected ErrorResponse	resolveException(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	setDefaultResolver(ExceptionResolver<Exception> defaultResolver)
void	setEncryptTempFiles(boolean encryptTempFiles)
void	setJsonHelper(JacksonHelper jsonHelper)
void	setMaxContentSize(long maxContentSize)
void	setMemoryThreshold(int memoryThreshold)
void	setResolver(ExceptionResolver<Exception> resolver)
void	setStreamFactory(org.apache.chemistry.opencmis.server.shared.ThresholdOutputStreamFactory streamFactory)
void	setTempDirectoryName(String tempDirectoryName)
void	setTransactionService(TransactionService transactionService)

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

encryptTempFiles

protected boolean encryptTempFiles

tempDirectoryName

protected String tempDirectoryName

memoryThreshold

protected int memoryThreshold

maxContentSize

protected long maxContentSize

streamFactory

protected org.apache.chemistry.opencmis.server.shared.ThresholdOutputStreamFactory streamFactory

transactionService

protected TransactionService transactionService

UTF8

public static final 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

setTransactionService

public void setTransactionService(TransactionService transactionService)

setDefaultResolver

public void setDefaultResolver(ExceptionResolver<Exception> defaultResolver)

setTempDirectoryName

public void setTempDirectoryName(String tempDirectoryName)

setEncryptTempFiles

public void setEncryptTempFiles(boolean encryptTempFiles)

setMemoryThreshold

public void setMemoryThreshold(int memoryThreshold)

setMaxContentSize

public void setMaxContentSize(long maxContentSize)

setStreamFactory

public void setStreamFactory(org.apache.chemistry.opencmis.server.shared.ThresholdOutputStreamFactory streamFactory)

init

public void init()

execute

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

Throws:

IOException

resolveException

protected ErrorResponse resolveException(Exception ex)

getRequest

protected BufferedRequest getRequest(org.springframework.extensions.webscripts.WebScriptRequest req)

getResponse

protected BufferedResponse getResponse(org.springframework.extensions.webscripts.WebScriptResponse resp)

execute

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

Throws:

IOException

renderErrorResponse

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

Renders a JSON error response

Parameters:

errorResponse - The error

res - web script response

Throws:

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<Exception> resolver)

setJsonHelper

public void setJsonHelper(JacksonHelper jsonHelper)