Class StreamACP
java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.alfresco.repo.web.scripts.content.StreamContent
org.alfresco.repo.web.scripts.content.StreamACP
- All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
Base class for Java backed webscripts that wish to generate an ACP and
stream the contents back to the caller.
The default implementation generates an ACP file containing the provided NodeRefs and all their respective children.
- Author:
- Gavin Cornwell
-
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 ExporterService
protected static final String
protected static final String
protected static final String
protected static final String
Fields inherited from class org.alfresco.repo.web.scripts.content.StreamContent
delegate, mimetypeService, nodeService, permissionService, repository
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected File
createACP
(ExporterCrawlerParameters params, String extension, boolean keepFolderStructure) Returns an ACP file containing the nodes represented by the given list of NodeRefs.void
execute
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) protected NodeRef[]
getNodeRefs
(String nodeRefsParam) Converts the given comma delimited string of NodeRefs to an array of NodeRefs.protected NodeRef[]
getNodeRefs
(org.json.JSONObject json) Attempts to retrieve and convert a JSON array of NodeRefs from the given JSON object.void
setExporterService
(ExporterService exporterService) Sets the ExporterService to useMethods inherited from class org.alfresco.repo.web.scripts.content.StreamContent
createObjectReferenceFromUrl, executeImpl, executeImpl, executeImpl, renderFormatTemplate, setAttachment, setDelegate, setMimetypeService, setNodeService, setPermissionService, setRepository, streamContent, streamContent, streamContent, streamContentImpl
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
-
TEMP_FILE_PREFIX
- See Also:
-
MULTIPART_FORMDATA
- See Also:
-
ZIP_EXTENSION
- See Also:
-
PARAM_NODE_REFS
- See Also:
-
exporterService
-
-
Constructor Details
-
StreamACP
public StreamACP()
-
-
Method Details
-
setExporterService
Sets the ExporterService to use- Parameters:
exporterService
- The ExporterService
-
execute
public void execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) throws IOException - Specified by:
execute
in interfaceorg.springframework.extensions.webscripts.WebScript
- Overrides:
execute
in classStreamContent
- Throws:
IOException
- See Also:
-
WebScript.execute(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse)
-
getNodeRefs
Converts the given comma delimited string of NodeRefs to an array of NodeRefs. If the string is null a WebScriptException is thrown.- Parameters:
nodeRefsParam
- Comma delimited string of NodeRefs- Returns:
- Array of NodeRef objects
-
getNodeRefs
Attempts to retrieve and convert a JSON array of NodeRefs from the given JSON object. If the nodeRefs property is not present a WebScriptException is thrown.- Parameters:
json
- JSONObject- Returns:
- Array of NodeRef objects
- Throws:
org.json.JSONException
-
createACP
protected File createACP(ExporterCrawlerParameters params, String extension, boolean keepFolderStructure) Returns an ACP file containing the nodes represented by the given list of NodeRefs.- Parameters:
params
- The parameters for the ACP exporterextension
- The file extenstion to use for the ACP filekeepFolderStructure
- Determines whether the folder structure is maintained for the content inside the ACP file- Returns:
- File object representing the created ACP
-