Skip to content

Fix: Complete description for Upload documentation #4445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 8, 2025
Merged

Fix: Complete description for Upload documentation #4445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c48f24a
docs: enhance description of TemporaryFileUploadHandler in file-handl…
fredpena Jul 25, 2025
d44f3dc
docs: Clarify Spring Boot multipart limits and stream handling in Upl…
fredpena Jul 25, 2025
f9a035b
Update articles/components/upload/index.adoc
fredpena Aug 1, 2025
b613337
Update file-handling.adoc
fredpena Aug 1, 2025
b1edb82
Merge branch 'latest' into latest
mshabarov Aug 6, 2025
728ba81
Merge branch 'v24' into latest
mshabarov Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion articles/components/upload/file-handling.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following built-in implementations of [classname]`UploadHandler` are availab

- [classname]`InMemoryUploadHandler`, stores uploaded files in memory
- [classname]`FileUploadHandler`, stores uploaded files to the file system
- [classname]`TemporaryFileUploadHandler`, stores uploaded files to temporary filestly even when
- [classname]`TemporaryFileUploadHandler`, stores uploaded files to temporary files, typically using the system's temporary directory. This handler is useful when dealing with large files or when memory usage needs to be minimized.

These are described in the sub-sections that follow.
All of the build-in implementations extend [classname]`TransferProgressAwareHandler` and support <<add-progress-listener, adding progress listeners>>.
Expand Down
23 changes: 23 additions & 0 deletions articles/components/upload/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,31 @@

.Revalidate Size Limit on Server
[NOTE]
====
This constraint is set on the client and is checked before contacting the server.

When using Java Flow with Spring Boot, file size limits are also affected by Spring’s multipart configuration.

By default, Spring Boot applies restrictive limits that may cause uploads to fail — typically for files larger than 1MB.

Check warning on line 280 in articles/components/upload/index.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.Units] Put a nonbreaking space between the number and the unit in '1MB' (Option+Space on macOS, Ctrl + Shift + Space on Windows).

Raw Output:
{"message": "[Vaadin.Units] Put a nonbreaking space between the number and the unit in '1MB' (Option+Space on macOS, Ctrl + Shift + Space on Windows).", "location": {"path": "articles/components/upload/index.adoc", "range": {"start": {"line": 280, "column": 117}}}, "severity": "WARNING"}
You can increase these limits in your `application.properties` or `application.yml` file:

[source,properties]
----
spring.servlet.multipart.max-file-size=50MB
spring.servlet.multipart.max-request-size=100MB
----

Additionally, if you're using an [interfacename]`UploadHandler` or [interfacename]`Receiver`, you may need to disable Spring’s multipart resolver entirely to allow the Upload component to handle the stream directly:

[source,properties]
----
spring.servlet.multipart.enabled=false
----

By default, Spring intercepts multipart requests and caches the file content before the Upload component receives it.
This behavior can prevent upload event listeners or stream receivers from working correctly.
====


== File Actions

Expand Down
Loading