Package io.jmix.flowui.download

Class DownloaderExportHandler

java.lang.Object

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

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

io.jmix.flowui.download.DownloaderExportHandler

All Implemented Interfaces:

com.vaadin.flow.server.streams.DownloadHandler, com.vaadin.flow.server.streams.ElementRequestHandler, SupportDownloadSuccessHandler, TransferProgressNotifier, Serializable

@Component("flowui_DownloaderExportHandler")
@Scope("prototype")
public class DownloaderExportHandler
extends com.vaadin.flow.server.streams.AbstractDownloadHandler<DownloaderExportHandler>
implements TransferProgressNotifier, SupportDownloadSuccessHandler

A handler for managing file download/view requests triggered by Downloader.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DownloaderExportHandler.FileNotFoundContext	Represents context information about a file not found error during download.

Nested classes/interfaces inherited from interface io.jmix.flowui.download.SupportDownloadSuccessHandler

SupportDownloadSuccessHandler.DownloadSuccessContext, SupportDownloadSuccessHandler.DownloadSuccessHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final DownloadContext	downloadContext
protected Predicate<DownloaderExportHandler.FileNotFoundContext>	fileNotFoundExceptionHandler
protected SupportDownloadSuccessHandler.DownloadSuccessHandler	successHandler

Constructor Summary

Constructors

Constructor	Description
DownloaderExportHandler(DownloadContext downloadContext)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addTransferProgressListener(com.vaadin.flow.server.streams.TransferProgressListener listener)
protected void	applyErrorHeaders(com.vaadin.flow.server.VaadinResponse response)
void	handleDownloadRequest(com.vaadin.flow.server.streams.DownloadEvent event)
DownloaderExportHandler	inline()
boolean	isAllowInert()
boolean	isInline()
void	setDownloadSuccessHandler(SupportDownloadSuccessHandler.DownloadSuccessHandler handler)	Sets a handler that is invoked when a download operation completes successfully.
void	setFileNotFoundExceptionHandler(Predicate<DownloaderExportHandler.FileNotFoundContext> handler)

Methods inherited from class com.vaadin.flow.server.streams.AbstractDownloadHandler

getContentType, getTransferContext

Methods inherited from class com.vaadin.flow.server.streams.TransferProgressAwareHandler

getListeners, notifyError, onProgress, onProgress, onProgress, onProgress, setTransferUI, uiAccess, 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

Field Details

downloadContext

protected final DownloadContext downloadContext

successHandler

protected SupportDownloadSuccessHandler.DownloadSuccessHandler successHandler

fileNotFoundExceptionHandler

protected Predicate<DownloaderExportHandler.FileNotFoundContext> fileNotFoundExceptionHandler

Constructor Details

DownloaderExportHandler

public DownloaderExportHandler(DownloadContext downloadContext)

Method Details

setDownloadSuccessHandler

public void setDownloadSuccessHandler(@Nullable
 SupportDownloadSuccessHandler.DownloadSuccessHandler handler)

Description copied from interface: SupportDownloadSuccessHandler

Sets a handler that is invoked when a download operation completes successfully.

Specified by:

setDownloadSuccessHandler in interface SupportDownloadSuccessHandler

Parameters:

handler - the handler to be invoked on successful download, or null to remove the current handler

setFileNotFoundExceptionHandler

public void setFileNotFoundExceptionHandler(@Nullable
 Predicate<DownloaderExportHandler.FileNotFoundContext> handler)

handleDownloadRequest

public void handleDownloadRequest(com.vaadin.flow.server.streams.DownloadEvent event)
                           throws IOException

Specified by:

handleDownloadRequest in interface com.vaadin.flow.server.streams.DownloadHandler

Throws:

IOException

applyErrorHeaders

protected void applyErrorHeaders(com.vaadin.flow.server.VaadinResponse response)

addTransferProgressListener

public com.vaadin.flow.shared.Registration addTransferProgressListener(com.vaadin.flow.server.streams.TransferProgressListener listener)

Specified by:

addTransferProgressListener in interface TransferProgressNotifier

Overrides:

addTransferProgressListener in class com.vaadin.flow.server.streams.TransferProgressAwareHandler<com.vaadin.flow.server.streams.DownloadEvent,DownloaderExportHandler>

isInline

public boolean isInline()

Overrides:

isInline in class com.vaadin.flow.server.streams.AbstractDownloadHandler<DownloaderExportHandler>

inline

public DownloaderExportHandler inline()

Overrides:

inline in class com.vaadin.flow.server.streams.AbstractDownloadHandler<DownloaderExportHandler>

isAllowInert

public boolean isAllowInert()

Specified by:

isAllowInert in interface com.vaadin.flow.server.streams.ElementRequestHandler