com.vaadin.flow.server.streams.InputStreamDownloadHandler API 24.8.4 | Vaadin

com.vaadin.flow.server.streams.

java.lang.Object

com.vaadin.flow.server.streams.TransferProgressAwareHandler<DownloadEvent,R>

com.vaadin.flow.server.streams.AbstractDownloadHandler<InputStreamDownloadHandler>

com.vaadin.flow.server.streams.InputStreamDownloadHandler

All Implemented Interfaces:

DownloadHandler, ElementRequestHandler, Serializable

public class InputStreamDownloadHandler extends AbstractDownloadHandler<InputStreamDownloadHandler>

Download handler for serving an input stream for client download.

Since:

24.8

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

InputStreamDownloadHandler(InputStreamDownloadCallback callback)

Create an input stream download handler for given event -> response function.
Method Summary

Modifier and Type

Method

Description

void

handleDownloadRequest(DownloadEvent downloadEvent)

Method that is called when the client wants to download from the url stored for this specific handler registration.

Methods inherited from class com.vaadin.flow.server.streams.AbstractDownloadHandler
getContentType, getTransferContext, inline, isInline

Methods inherited from class com.vaadin.flow.server.streams.TransferProgressAwareHandler
addTransferProgressListener, getListeners, notifyError, onProgress, onProgress, onProgress, onProgress, whenComplete, whenComplete, whenStart, whenStart

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.server.streams.DownloadHandler
handleRequest

Methods inherited from interface com.vaadin.flow.server.streams.ElementRequestHandler
getDisabledUpdateMode, getUrlPostfix, isAllowInert

Constructor Details
- InputStreamDownloadHandler
  
  public InputStreamDownloadHandler(InputStreamDownloadCallback callback)
  
  Create an input stream download handler for given event -> response function.
  
  Parameters:
  
  callback - serializable function for handling download
Method Details
- handleDownloadRequest
  
  public void handleDownloadRequest(DownloadEvent downloadEvent) throws IOException
  
  Description copied from interface: DownloadHandler
  
  Method that is called when the client wants to download from the url stored for this specific handler registration.
  
  Parameters:
  
  downloadEvent - download event containing the necessary data for writing the response
  
  Throws:
  
  IOException - if an IO error occurred during download