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
FieldsModifier and TypeFieldDescriptionprotected ApiAssistant
protected boolean
protected long
protected int
protected Supplier<TempOutputStream>
protected String
protected TransactionService
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract 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
(Supplier<TempOutputStream> 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
-
Field Details
-
assistant
-
encryptTempFiles
protected boolean encryptTempFiles -
tempDirectoryName
-
memoryThreshold
protected int memoryThreshold -
maxContentSize
protected long maxContentSize -
streamFactory
-
transactionService
-
-
Constructor Details
-
ApiWebScript
public ApiWebScript()
-
-
Method Details
-
setTransactionService
-
setAssistant
-
setTempDirectoryName
-
setEncryptTempFiles
public void setEncryptTempFiles(boolean encryptTempFiles) -
setMemoryThreshold
public void setMemoryThreshold(int memoryThreshold) -
setMaxContentSize
public void setMaxContentSize(long maxContentSize) -
setStreamFactory
-
init
public void init() -
execute
public void execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) throws IOException - Throws:
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 IOException - Throws:
IOException
-