Package io.jmix.flowui.download

Class ByteArrayDownloadDataProvider

java.lang.Object

io.jmix.flowui.download.ByteArrayDownloadDataProvider

All Implemented Interfaces:

DownloadDataProvider

public class ByteArrayDownloadDataProvider
extends Object
implements DownloadDataProvider

A data provider implementation of DownloadDataProvider designed to supply data from a byte array.

Field Summary

Fields

Modifier and Type	Field	Description
protected Supplier<InputStream>	supplier

Constructor Summary

Constructors

Constructor	Description
ByteArrayDownloadDataProvider(byte[] data, int saveExportedByteArrayDataThresholdBytes, String tempDir)	Constructor.

Method Summary

Modifier and Type	Method	Description
InputStream	getStream()	Provides an input stream for data downloading purposes.
protected InputStream	readFromTempStorage(File file)
protected File	saveToTempStorage(byte[] data, String tempDir)

Methods inherited from class java.lang.Object

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

Field Details

supplier

protected Supplier<InputStream> supplier

Constructor Details

ByteArrayDownloadDataProvider

public ByteArrayDownloadDataProvider(byte[] data,
 int saveExportedByteArrayDataThresholdBytes,
 String tempDir)

Constructor.

Parameters:

data - byte array

saveExportedByteArrayDataThresholdBytes - threshold in bytes on which downloaded byte array will be saved to a temporary file to prevent HTTP session memory leaks. Use UiProperties.getSaveExportedByteArrayDataThresholdBytes().

tempDir - where to store the temporary file if saveExportedByteArrayDataThresholdBytes is exceeded. Use CoreProperties.getTempDir().

Method Details

saveToTempStorage

protected File saveToTempStorage(byte[] data,
 String tempDir)

readFromTempStorage

@Nullable
protected InputStream readFromTempStorage(File file)

getStream

public InputStream getStream()

Description copied from interface: DownloadDataProvider

Provides an input stream for data downloading purposes.

Specified by:

getStream in interface DownloadDataProvider

Returns:

an InputStream containing the data to be downloaded