Class InboxDataDownloadServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.omnifaces.servlet.FileServlet
de.xima.fc.servlet.InboxDataDownloadServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
@WebServlet(urlPatterns="/export/inbox-data/get/*") public class InboxDataDownloadServlet extends org.omnifaces.servlet.FileServlet
Servlet for delivering inbox exports.
Since:
8.5.4
Author:
XIMA MEDIA GmbH
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    InboxDataDownloadServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
    Does some request verification and, if successful, delegates the delivery of the requested export ZIP file to the parent class, see FileServlet.doGet(HttpServletRequest, HttpServletResponse).
    protected File
    getFile(javax.servlet.http.HttpServletRequest request)
    Returns the requested export ZIP file (null if this file is no longer available for download because the TTL of the related InboxDataDownloadServlet.DownloadReference is up).
    protected boolean
    isAttachment(javax.servlet.http.HttpServletRequest request, String contentType)
    Always returns true.
    static String
    registerDownloadRequest(Path exportZipPath)
     

    Methods inherited from class org.omnifaces.servlet.FileServlet

    doHead, getAttachmentName, getContentType, getExpireTime, handleFileNotFound

    Methods inherited from class javax.servlet.http.HttpServlet

    doDelete, doOptions, doPost, doPut, doTrace, getLastModified, service, service

    Methods inherited from class javax.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

    Methods inherited from class Object

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

  • Constructor Details

    • InboxDataDownloadServlet

      public InboxDataDownloadServlet()

  • Method Details

    • getFile

      protected File getFile(javax.servlet.http.HttpServletRequest request)
      Returns the requested export ZIP file (null if this file is no longer available for download because the TTL of the related InboxDataDownloadServlet.DownloadReference is up). This method may return a File reference pointing to a non-existent file because the export file might have been deleted in the meantime (explicitly by user action or implicitly by the system). However, these cases are handled by the parent class, see FileServlet.getFile(HttpServletRequest).
      Specified by:
      getFile in class org.omnifaces.servlet.FileServlet
      Parameters:
      request - The involved HTTP servlet request.
      Returns:
      A File reference or null.

    • isAttachment

      protected boolean isAttachment(javax.servlet.http.HttpServletRequest request, String contentType)
      Always returns true.
      Overrides:
      isAttachment in class org.omnifaces.servlet.FileServlet
      Returns:
      true

    • doGet

      protected void doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, IOException
      Does some request verification and, if successful, delegates the delivery of the requested export ZIP file to the parent class, see FileServlet.doGet(HttpServletRequest, HttpServletResponse).
      Overrides:
      doGet in class org.omnifaces.servlet.FileServlet
      Throws:
      javax.servlet.ServletException
      IOException

    • registerDownloadRequest

      public static String registerDownloadRequest(Path exportZipPath)