Package org.alfresco.repo.web.scripts.content

Class ContentStreamer

  • All Implemented Interfaces:
    org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware
    public class ContentStreamer
extends java.lang.Object
implements org.springframework.context.ResourceLoaderAware
    Can be used when the binary data of a content property needs to be streamed back to the client as the result of executing a web script. These methods are taken from the StreamContent class so they can be reused by other webscripts.

    • Constructor Summary

      Constructors 
      Constructor Description
      ContentStreamer()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.String filterNameForQuotedString​(java.lang.String s)  
      protected boolean isValidQuotedStringHeaderParamChar​(char c)  
      void setAttachment​(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, boolean attach, java.lang.String attachFileName)
      Set attachment header
      void setContentService​(org.alfresco.service.cmr.repository.ContentService contentService)  
      void setEventPublisher​(org.alfresco.sync.repo.events.EventPublisher eventPublisher)  
      void setMimetypeService​(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)  
      void setNodeService​(org.alfresco.service.cmr.repository.NodeService nodeService)  
      void setResourceLoader​(org.springframework.core.io.ResourceLoader resourceLoader)  
      protected void setResponseCache​(org.springframework.extensions.webscripts.WebScriptResponse res, java.util.Date modified, java.lang.String eTag, java.util.Map<java.lang.String,​java.lang.Object> model)
      Set the cache settings on the response
      void setSiteService​(org.alfresco.service.cmr.site.SiteService siteService)  
      void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.io.File file, java.lang.Long modifiedTime, boolean attach, java.lang.String attachFileName, java.util.Map<java.lang.String,​java.lang.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, java.lang.String resourcePath, boolean attach, java.lang.String attachFileName, java.util.Map<java.lang.String,​java.lang.Object> model)
      Streams content back to client from a given resource path.
      void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, java.lang.String resourcePath, boolean attach, java.util.Map<java.lang.String,​java.lang.Object> model)
      Streams content back to client from a given resource path.
      void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, java.lang.String attachFileName, java.util.Map<java.lang.String,​java.lang.Object> model)
      Streams the content on a given node's content property to the response of the web script.
      void streamContentImpl​(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, org.alfresco.service.cmr.repository.ContentReader reader, org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, boolean attach, java.util.Date modified, java.lang.String eTag, java.lang.String attachFileName, java.util.Map<java.lang.String,​java.lang.Object> model)
      Stream content implementation

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • KEY_ALLOW_BROWSER_TO_CACHE

        public static final java.lang.String KEY_ALLOW_BROWSER_TO_CACHE
        See Also:
        Constant Field Values

      • KEY_CACHE_DIRECTIVE

        public static final java.lang.String KEY_CACHE_DIRECTIVE
        See Also:
        Constant Field Values

      • nodeService

        protected org.alfresco.service.cmr.repository.NodeService nodeService
        Services

      • contentService

        protected org.alfresco.service.cmr.repository.ContentService contentService

      • mimetypeService

        protected org.alfresco.service.cmr.repository.MimetypeService mimetypeService

      • resourceLoader

        protected org.springframework.core.io.ResourceLoader resourceLoader

      • eventPublisher

        protected org.alfresco.sync.repo.events.EventPublisher eventPublisher

      • siteService

        protected org.alfresco.service.cmr.site.SiteService siteService

    • Constructor Detail

      • ContentStreamer

        public ContentStreamer()

    • Method Detail

      • setMimetypeService

        public void setMimetypeService​(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)
        Parameters:
        mimetypeService - MimetypeService

      • setNodeService

        public void setNodeService​(org.alfresco.service.cmr.repository.NodeService nodeService)
        Parameters:
        nodeService - NodeService

      • setEventPublisher

        public void setEventPublisher​(org.alfresco.sync.repo.events.EventPublisher eventPublisher)
        Parameters:
        eventPublisher - EventPublisher

      • setSiteService

        public void setSiteService​(org.alfresco.service.cmr.site.SiteService siteService)
        Parameters:
        siteService - SiteService

      • setResourceLoader

        public void setResourceLoader​(org.springframework.core.io.ResourceLoader resourceLoader)
        Specified by:
        setResourceLoader in interface org.springframework.context.ResourceLoaderAware

      • setContentService

        public void setContentService​(org.alfresco.service.cmr.repository.ContentService contentService)
        Parameters:
        contentService - ContentService

      • streamContent

        public void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req,
                          org.springframework.extensions.webscripts.WebScriptResponse res,
                          java.io.File file,
                          java.lang.Long modifiedTime,
                          boolean attach,
                          java.lang.String attachFileName,
                          java.util.Map<java.lang.String,​java.lang.Object> model)
                   throws java.io.IOException
        Streams content back to client from a given File.
        Parameters:
        req - The request
        res - The response
        file - The file whose content is to be streamed.
        modifiedTime - The modified datetime to use for the streamed content. If null the file's timestamp will be used.
        attach - Indicates whether the content should be streamed as an attachment or not
        attachFileName - Optional file name to use when attach is true
        Throws:
        java.io.IOException

      • streamContent

        public void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req,
                          org.springframework.extensions.webscripts.WebScriptResponse res,
                          org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          org.alfresco.service.namespace.QName propertyQName,
                          boolean attach,
                          java.lang.String attachFileName,
                          java.util.Map<java.lang.String,​java.lang.Object> model)
                   throws java.io.IOException
        Streams the content on a given node's content property to the response of the web script.
        Parameters:
        req - Request
        res - Response
        nodeRef - The node reference
        propertyQName - The content property name
        attach - Indicates whether the content should be streamed as an attachment or not
        attachFileName - Optional file name to use when attach is true
        Throws:
        java.io.IOException

      • streamContent

        public void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req,
                          org.springframework.extensions.webscripts.WebScriptResponse res,
                          java.lang.String resourcePath,
                          boolean attach,
                          java.util.Map<java.lang.String,​java.lang.Object> model)
                   throws java.io.IOException
        Streams content back to client from a given resource path.
        Parameters:
        req - The request
        res - The response
        resourcePath - The classpath resource path the content is required for
        attach - Indicates whether the content should be streamed as an attachment or not
        Throws:
        java.io.IOException

      • streamContent

        protected void streamContent​(org.springframework.extensions.webscripts.WebScriptRequest req,
                             org.springframework.extensions.webscripts.WebScriptResponse res,
                             java.lang.String resourcePath,
                             boolean attach,
                             java.lang.String attachFileName,
                             java.util.Map<java.lang.String,​java.lang.Object> model)
                      throws java.io.IOException
        Streams content back to client from a given resource path.
        Parameters:
        req - The request
        res - The response
        resourcePath - The classpath resource path the content is required for.
        attach - Indicates whether the content should be streamed as an attachment or not
        attachFileName - Optional file name to use when attach is true
        Throws:
        java.io.IOException

      • streamContentImpl

        public void streamContentImpl​(org.springframework.extensions.webscripts.WebScriptRequest req,
                              org.springframework.extensions.webscripts.WebScriptResponse res,
                              org.alfresco.service.cmr.repository.ContentReader reader,
                              org.alfresco.service.cmr.repository.NodeRef nodeRef,
                              org.alfresco.service.namespace.QName propertyQName,
                              boolean attach,
                              java.util.Date modified,
                              java.lang.String eTag,
                              java.lang.String attachFileName,
                              java.util.Map<java.lang.String,​java.lang.Object> model)
                       throws java.io.IOException
        Stream content implementation
        Parameters:
        req - The request
        res - The response
        reader - The reader
        nodeRef - The content nodeRef if applicable
        propertyQName - The content property if applicable
        attach - Indicates whether the content should be streamed as an attachment or not
        modified - Modified date of content
        eTag - ETag to use
        attachFileName - Optional file name to use when attach is true
        Throws:
        java.io.IOException

      • setAttachment

        public void setAttachment​(org.springframework.extensions.webscripts.WebScriptRequest req,
                          org.springframework.extensions.webscripts.WebScriptResponse res,
                          boolean attach,
                          java.lang.String attachFileName)
        Set attachment header
        Parameters:
        req - WebScriptRequest
        res - WebScriptResponse
        attach - boolean
        attachFileName - String

      • filterNameForQuotedString

        protected java.lang.String filterNameForQuotedString​(java.lang.String s)

      • isValidQuotedStringHeaderParamChar

        protected boolean isValidQuotedStringHeaderParamChar​(char c)

      • setResponseCache

        protected void setResponseCache​(org.springframework.extensions.webscripts.WebScriptResponse res,
                                java.util.Date modified,
                                java.lang.String eTag,
                                java.util.Map<java.lang.String,​java.lang.Object> model)
        Set the cache settings on the response
        Parameters:
        res - WebScriptResponse
        modified - Date
        eTag - String