Package com.vaadin.flow.server.communication

Class StreamRequestHandler

java.lang.Object

com.vaadin.flow.server.communication.StreamRequestHandler

All Implemented Interfaces:

RequestHandler, Serializable

public class StreamRequestHandler
extends Object
implements RequestHandler

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:

Serialized Form

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

Modifier and Type	Method	Description
static String	generateURI(String name, String id)	Generates URI string for a dynamic resource using its id and name.
boolean	handleRequest(VaadinSession session, VaadinRequest request, VaadinResponse response)	Called when a request needs to be handled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DYN_RES_PREFIX

public static final String DYN_RES_PREFIX

Dynamic resource URI prefix.

See Also:

Constant Field Values

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 using VaadinSession.accessSynchronously(Command) or UI.accessSynchronously(Command).

Specified by:

handleRequest in interface RequestHandler

Parameters:

session - The session for the request

request - The request to handle

response - 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

public static String generateURI(String name,
                                 String id)

Generates URI string for a dynamic resource using its id and name. [0] UIid, [1] sec key, [2] name

Parameters:

name - file or attribute name to use in path

id - unique resource id

Returns:

generated URI string