com.vaadin.flow.server.communication.
Class StreamRequestHandler
- java.lang.Object
-
- com.vaadin.flow.server.communication.StreamRequestHandler
-
All Implemented Interfaces:
public class StreamRequestHandler extends Object implements RequestHandler
Handles
StreamResource
andStreamReceiver
instances registered inVaadinSession
.For internal use only. May be renamed or removed in a future release.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Field Summary
Fields Modifier and Type Field Description static String
DYN_RES_PREFIX
Dynamic resource URI prefix.
-
Constructor Summary
Constructors Modifier Constructor Description StreamRequestHandler()
Create a new stream request handler with the default StreamReceiverHandler.
protected
StreamRequestHandler(StreamReceiverHandler receiverHandler)
-
Method Summary
All Methods Modifier and Type Method Description static String
generateURI(String name, String id)
Generates URI string for a dynamic resource using its
id
andname
.boolean
handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)
Called when a request needs to be handled.
-
-
-
Field Detail
-
DYN_RES_PREFIX
public static final String DYN_RES_PREFIX
Dynamic resource URI prefix.
See Also:
-
-
Constructor Detail
-
StreamRequestHandler
public StreamRequestHandler()
Create a new stream request handler with the default StreamReceiverHandler.
-
StreamRequestHandler
protected StreamRequestHandler(StreamReceiverHandler receiverHandler)
-
-
Method Detail
-
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
-
-