Class StreamContent
java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.alfresco.repo.web.scripts.content.StreamContent
- All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
- Direct Known Subclasses:
ContentGet
,ContentInfo
,NodeContentGet
,StreamACP
,StreamJMXDump
,WorkflowInstanceDiagramGet
public class StreamContent
extends org.springframework.extensions.webscripts.AbstractWebScript
Web script 'type' that can be used when the binary data of a content property needs to be streamed back to the client
as the result of executing the web script.
Many of these methods have been moved into the ContentStreamer class so they can be reused by other webscripts.
- Author:
- Roy Wetherall
-
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 ContentStreamer
protected MimetypeService
protected NodeService
protected PermissionService
Servicesprotected Repository
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected org.alfresco.repo.web.scripts.content.StreamContent.ObjectReference
void
execute
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) executeImpl
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status) Deprecated.executeImpl
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Execute custom Java logicexecuteImpl
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptStatus status) Deprecated.protected final void
Render a template (of given format) to the Web Script Responseprotected void
setAttachment
(org.springframework.extensions.webscripts.WebScriptResponse res, boolean attach, String attachFileName) Set attachment headervoid
setDelegate
(ContentStreamer delegate) void
setMimetypeService
(MimetypeService mimetypeService) void
setNodeService
(NodeService nodeService) void
setPermissionService
(PermissionService permissionService) void
setRepository
(Repository repository) protected void
streamContent
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, File file) Streams content back to client from a given File.protected void
streamContent
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, File file, boolean attach, String attachFileName, Map<String, Object> model) Streams content back to client from a given File.protected void
streamContent
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, String attachFileName, Map<String, Object> model) Streams the content on a given node's content property to the response of the web script.protected void
streamContentImpl
(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, ContentReader reader, NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, Date modified, String eTag, String attachFileName, Map<String, Object> model) Stream content implementationMethods 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
-
permissionService
Services -
nodeService
-
mimetypeService
-
delegate
-
repository
-
-
Constructor Details
-
StreamContent
public StreamContent()
-
-
Method Details
-
setMimetypeService
- Parameters:
mimetypeService
- MimetypeService
-
setPermissionService
- Parameters:
permissionService
- PermissionService
-
setNodeService
- Parameters:
nodeService
- NodeService
-
setDelegate
- Parameters:
delegate
- ContentStreamer
-
setRepository
- Parameters:
repository
- Repository
-
execute
public void execute(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res) throws IOException - Throws:
IOException
- See Also:
-
WebScript.execute(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse)
-
setAttachment
protected void setAttachment(org.springframework.extensions.webscripts.WebScriptResponse res, boolean attach, String attachFileName) Set attachment header- Parameters:
res
- WebScriptResponseattach
- booleanattachFileName
- String
-
streamContent
protected void streamContent(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, File file) throws IOException Streams content back to client from a given File. The Last-Modified header will reflect the given file's modification timestamp.- Parameters:
req
- The requestres
- The responsefile
- The file whose content is to be streamed.- Throws:
IOException
-
streamContent
protected void streamContent(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, File file, boolean attach, String attachFileName, Map<String, Object> model) throws IOExceptionStreams content back to client from a given File. The Last-Modified header will reflect the given file's modification timestamp.- Parameters:
req
- The requestres
- The responsefile
- The file whose content is to be streamed.attach
- Indicates whether the content should be streamed as an attachment or notattachFileName
- Optional file name to use when attach istrue
- Throws:
IOException
-
streamContent
protected void streamContent(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, String attachFileName, Map<String, Object> model) throws IOExceptionStreams the content on a given node's content property to the response of the web script.- Parameters:
req
- Requestres
- ResponsenodeRef
- The node referencepropertyQName
- The content property nameattach
- Indicates whether the content should be streamed as an attachment or notattachFileName
- Optional file name to use when attach istrue
- Throws:
IOException
-
streamContentImpl
protected void streamContentImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, ContentReader reader, NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, Date modified, String eTag, String attachFileName, Map<String, Object> model) throws IOExceptionStream content implementation- Parameters:
req
- The requestres
- The responsereader
- The readernodeRef
- The content nodeRef if applicablepropertyQName
- The content property if applicableattach
- Indicates whether the content should be streamed as an attachment or notmodified
- Modified date of contenteTag
- ETag to useattachFileName
- Optional file name to use when attach istrue
- Throws:
IOException
-
executeImpl
protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptStatus status) Deprecated.Execute custom Java logic- Parameters:
req
- Web Script requeststatus
- Web Script status- Returns:
- custom service model
-
executeImpl
protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status) Deprecated.Execute custom Java logic- Parameters:
req
- Web Script requeststatus
- Web Script status- Returns:
- custom service model
-
executeImpl
protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Execute custom Java logic- Parameters:
req
- Web Script requeststatus
- Web Script statuscache
- Web Script cache- Returns:
- custom service model
-
renderFormatTemplate
Render a template (of given format) to the Web Script Response- Parameters:
format
- template format (null, default format)model
- data model to renderwriter
- where to output
-
createObjectReferenceFromUrl
-