com.vaadin.flow.server.communication.
Class StreamRequestHandler
All Implemented Interfaces:
Handles StreamResource
and StreamReceiver
instances
registered in VaadinSession
.
For internal use only. May be renamed or removed in a future release.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a new stream request handler with the default StreamReceiverHandler.
protected
StreamRequestHandler
(StreamReceiverHandler receiverHandler) -
Method Summary
Modifier and TypeMethodDescriptionstatic String
generateURI
(String name, String id) Generates URI string for a dynamic resource using its
id
andname
.protected long
Returns maximum file part count for upload.
protected long
Returns maximum file size for upload.
protected long
Returns maximum request size for upload.
boolean
handleRequest
(VaadinSession session, VaadinRequest request, VaadinResponse response) Called when a request needs to be handled.
-
Field Details
-
DYN_RES_PREFIX
Dynamic resource URI prefix.
See Also:
-
-
Constructor Details
-
StreamRequestHandler
public StreamRequestHandler()Create a new stream request handler with the default StreamReceiverHandler.
-
StreamRequestHandler
-
-
Method Details
-
handleRequest
public boolean handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response) throws IOException Description copied from interface:
RequestHandler
Called when a request needs to be handled. If a response is written, this method should return
true
to indicate that no more request handlers should be invoked for the request.Note that request handlers by default do not lock the session. If you are using VaadinSession or anything inside the VaadinSession you must ensure the session is locked. This can be done by extending
SynchronizedRequestHandler
or by usingVaadinSession.accessSynchronously(Command)
orUI.accessSynchronously(Command)
.Specified by:
handleRequest
in interfaceRequestHandler
Parameters:
session
- The session for the requestrequest
- The request to handleresponse
- The response object to which a response can be written.Returns:
true if a response has been written and no further request handlers should be called, otherwise false
Throws:
IOException
- If an IO error occurred -
generateURI
Generates URI string for a dynamic resource using its
id
andname
. [0] UIid, [1] sec key, [2] nameParameters:
name
- file or attribute name to use in pathid
- unique resource idReturns:
generated URI string
-
getRequestSizeMax
protected long getRequestSizeMax()Returns maximum request size for upload. Override this to increase the default. Defaults to -1 (no limit).
Returns:
maximum request size for upload
-
getFileSizeMax
protected long getFileSizeMax()Returns maximum file size for upload. Override this to increase the default. Defaults to -1 (no limit).
Returns:
maximum file size for upload
-
getFileCountMax
protected long getFileCountMax()Returns maximum file part count for upload. Override this to increase the default. Defaults to 10000.
Returns:
maximum file part count for upload
-