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
-
-
Field Summary
Fields Modifier and Type Field Description protected ApiAssistant
assistant
protected boolean
encryptTempFiles
protected long
maxContentSize
protected int
memoryThreshold
protected TempOutputStreamFactory
responseStreamFactory
protected TempOutputStreamFactory
streamFactory
protected java.lang.String
tempDirectoryName
protected org.alfresco.service.transaction.TransactionService
transactionService
-
Constructor Summary
Constructors Constructor Description ApiWebScript()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method 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
setAssistant(ApiAssistant assistant)
void
setEncryptTempFiles(boolean encryptTempFiles)
void
setMaxContentSize(long maxContentSize)
void
setMemoryThreshold(int memoryThreshold)
void
setStreamFactory(TempOutputStreamFactory streamFactory)
void
setTempDirectoryName(java.lang.String tempDirectoryName)
void
setTransactionService(org.alfresco.service.transaction.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
-
-
-
-
Field Detail
-
assistant
protected ApiAssistant assistant
-
encryptTempFiles
protected boolean encryptTempFiles
-
tempDirectoryName
protected java.lang.String tempDirectoryName
-
memoryThreshold
protected int memoryThreshold
-
maxContentSize
protected long maxContentSize
-
streamFactory
protected TempOutputStreamFactory streamFactory
-
responseStreamFactory
protected TempOutputStreamFactory responseStreamFactory
-
transactionService
protected org.alfresco.service.transaction.TransactionService transactionService
-
-
Method Detail
-
setTransactionService
public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)
-
setAssistant
public void setAssistant(ApiAssistant assistant)
-
setTempDirectoryName
public void setTempDirectoryName(java.lang.String tempDirectoryName)
-
setEncryptTempFiles
public void setEncryptTempFiles(boolean encryptTempFiles)
-
setMemoryThreshold
public void setMemoryThreshold(int memoryThreshold)
-
setMaxContentSize
public void setMaxContentSize(long maxContentSize)
-
setStreamFactory
public void setStreamFactory(TempOutputStreamFactory streamFactory)
-
init
public void init()
-
execute
public void execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) throws java.io.IOException
- Throws:
java.io.IOException
-
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 java.io.IOException
- Throws:
java.io.IOException
-
-