Package com.vaadin.flow.server.streams

Class AbstractFileUploadHandler<R extends AbstractFileUploadHandler>

java.lang.Object

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

com.vaadin.flow.server.streams.AbstractUploadHandler<R>

com.vaadin.flow.server.streams.AbstractFileUploadHandler<R>

Type Parameters:

R - type of file upload handler

All Implemented Interfaces:

ElementRequestHandler, UploadHandler, Serializable

Direct Known Subclasses:

FileUploadHandler, TemporaryFileUploadHandler

public abstract class AbstractFileUploadHandler<R extends AbstractFileUploadHandler>
extends AbstractUploadHandler<R>

Abstract class for file upload handler.

Since:

24.8

See Also:

• Serialized Form

Nested Class Summary

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

UploadHandler.MixedUploadResponse, UploadHandler.RejectedFilesResponse

Constructor Summary

Constructors

Constructor	Description
AbstractFileUploadHandler(FileUploadCallback successCallback, FileFactory fileFactory)	Creates an upload callback that stores the incoming stream into a File that is generated by the given FileFactory.

Method Summary

Modifier and Type	Method	Description
protected TransferContext	getTransferContext(UploadEvent transferEvent)	This method is used to get the transfer context from the transfer events (e.g.
void	handleUploadRequest(UploadEvent event)	Method that is called when the client wants to upload data to the url stored for this specific handler registration.

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

applyHeaderValidators, hasValidators, runCompleteValidators, runMetadataValidators, validateComplete, validateHeader, validateMetadata, withValidator

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

addTransferProgressListener, 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

Constructor Details

AbstractFileUploadHandler

public AbstractFileUploadHandler(FileUploadCallback successCallback,
 FileFactory fileFactory)

Creates an upload callback that stores the incoming stream into a File that is generated by the given FileFactory.

Parameters:

successCallback - consumer to be called for successful upload

fileFactory - factory that generates the File to store data

Method Details

handleUploadRequest

public void handleUploadRequest(UploadEvent event)
                         throws IOException

Description copied from interface: UploadHandler

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

After upload of all files is done the method UploadHandler.responseHandled(UploadResult) will be called.

Parameters:

event - upload event containing the necessary data for getting the request

Throws:

IOException - if an error occurs during upload

getTransferContext

protected TransferContext getTransferContext(UploadEvent transferEvent)

Description copied from class: TransferProgressAwareHandler

This method is used to get the transfer context from the transfer events (e.g. DownloadEvent).

Overrides:

getTransferContext in class AbstractUploadHandler<R extends AbstractFileUploadHandler>

Parameters:

transferEvent - the transfer event

Returns:

the transfer context