Package org.opencms.loader

Interface I_CmsStaticExportStreamLoader

All Known Implementing Classes:
CmsDumpLoader, CmsImageLoader, CmsPointerLoader
public interface I_CmsStaticExportStreamLoader
Capability interface for resource loaders which can static export directly to an output stream.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    exportTo(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, OutputStream exportOut)
    Static exports the contents of the requested resource to an output stream, optionally also to the response.

  • Method Details

    • exportTo

      void exportTo(CmsObject cms, CmsResource resource, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res, OutputStream exportOut) throws jakarta.servlet.ServletException, IOException, CmsException
      Static exports the contents of the requested resource to an output stream, optionally also to the response.

      Parameters:
      cms - the initialized CmsObject which provides user permissions
      resource - the requested OpenCms VFS resource
      req - the servlet request
      res - the servlet response
      exportOut - the export output stream
      Throws:
      jakarta.servlet.ServletException - might be thrown in the process of writing the response
      IOException - might be thrown in the process of writing the streams
      CmsException - in case something goes wrong