Package io.jmix.flowui.component.upload.handler

Class FileTemporaryStorageUploadHandler

java.lang.Object

com.vaadin.flow.server.streams.TransferProgressAwareHandler<com.vaadin.flow.server.streams.UploadEvent,FileTemporaryStorageUploadHandler>

io.jmix.flowui.component.upload.handler.FileTemporaryStorageUploadHandler

All Implemented Interfaces:

com.vaadin.flow.server.streams.ElementRequestHandler, com.vaadin.flow.server.streams.UploadHandler, TransferProgressNotifier, SupportUploadSuccessHandler<TemporaryStorage.FileInfo>, Serializable

@Component("flowui_FileTemporaryStorageUploadHandler")
@Scope("prototype")
public class FileTemporaryStorageUploadHandler
extends com.vaadin.flow.server.streams.TransferProgressAwareHandler<com.vaadin.flow.server.streams.UploadEvent,FileTemporaryStorageUploadHandler>
implements com.vaadin.flow.server.streams.UploadHandler, TransferProgressNotifier, SupportUploadSuccessHandler<TemporaryStorage.FileInfo>

Upload handler for storing upload stream into a temporary storage.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.kit.component.upload.handler.SupportUploadSuccessHandler

SupportUploadSuccessHandler.UploadSuccessContext<V>, SupportUploadSuccessHandler.UploadSuccessHandler<V>

Nested classes/interfaces inherited from interface com.vaadin.flow.server.streams.UploadHandler

com.vaadin.flow.server.streams.UploadHandler.MixedUploadResponse, com.vaadin.flow.server.streams.UploadHandler.RejectedFilesResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected TemporaryStorage.FileInfo	fileInfo
protected SupportUploadSuccessHandler.UploadSuccessHandler<TemporaryStorage.FileInfo>	successCallback
protected final TemporaryStorage	temporaryStorage

Constructor Summary

Constructors

Constructor	Description
FileTemporaryStorageUploadHandler(TemporaryStorage temporaryStorage)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addTransferProgressListener(com.vaadin.flow.server.streams.TransferProgressListener listener)
protected File	createFile(com.vaadin.flow.server.streams.UploadMetadata metadata)
TemporaryStorage.FileInfo	getFileInfo()
protected com.vaadin.flow.server.streams.TransferContext	getTransferContext(com.vaadin.flow.server.streams.UploadEvent transferEvent)
void	handleUploadRequest(com.vaadin.flow.server.streams.UploadEvent event)
void	setUploadSuccessHandler(@Nullable SupportUploadSuccessHandler.UploadSuccessHandler<TemporaryStorage.FileInfo> handler)	Sets a handler to be invoked upon the successful completion of an upload operation.

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.ElementRequestHandler

getDisabledUpdateMode, getUrlPostfix, isAllowInert

Methods inherited from interface com.vaadin.flow.server.streams.UploadHandler

getFileCountMax, getFileSizeMax, getRequestSizeMax, handleRequest, responseHandled

Field Details

temporaryStorage

protected final TemporaryStorage temporaryStorage

successCallback

protected SupportUploadSuccessHandler.UploadSuccessHandler<TemporaryStorage.FileInfo> successCallback

fileInfo

protected TemporaryStorage.FileInfo fileInfo

Constructor Details

FileTemporaryStorageUploadHandler

public FileTemporaryStorageUploadHandler(TemporaryStorage temporaryStorage)

Method Details

handleUploadRequest

public void handleUploadRequest(com.vaadin.flow.server.streams.UploadEvent event)
                         throws IOException

Specified by:

handleUploadRequest in interface com.vaadin.flow.server.streams.UploadHandler

Throws:

IOException

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.UploadEvent,FileTemporaryStorageUploadHandler>

setUploadSuccessHandler

public void setUploadSuccessHandler(@Nullable SupportUploadSuccessHandler.UploadSuccessHandler<TemporaryStorage.FileInfo> handler)

Description copied from interface: SupportUploadSuccessHandler

Sets a handler to be invoked upon the successful completion of an upload operation.

If null is passed as the parameter, any previously set handler will be cleared.

Specified by:

setUploadSuccessHandler in interface SupportUploadSuccessHandler<TemporaryStorage.FileInfo>

Parameters:

handler - the handler to be executed on a successful upload; may be null to clear any existing handler

getFileInfo

public TemporaryStorage.FileInfo getFileInfo()

createFile

protected File createFile(com.vaadin.flow.server.streams.UploadMetadata metadata)

getTransferContext

protected com.vaadin.flow.server.streams.TransferContext getTransferContext(com.vaadin.flow.server.streams.UploadEvent transferEvent)

Specified by:

getTransferContext in class com.vaadin.flow.server.streams.TransferProgressAwareHandler<com.vaadin.flow.server.streams.UploadEvent,FileTemporaryStorageUploadHandler>