Package com.vaadin.flow.server
Class StreamReceiver
- java.lang.Object
-
- com.vaadin.flow.server.AbstractStreamResource
-
- com.vaadin.flow.server.StreamReceiver
-
- All Implemented Interfaces:
Serializable
public class StreamReceiver extends AbstractStreamResource
Represents a receiver for data upload from the client.The instance should be registered via
StreamResourceRegistry.registerResource(AbstractStreamResource)
. This method returns an object which may be used to get resource URI.- Since:
- 1.0
- Author:
- Vaadin Ltd
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description StreamReceiver(StateNode node, String resourceName, StreamVariable streamVariable)
CreatesStreamReceiver
instance forstreamVariable
as a data receiver.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Get the resource name.StateNode
getNode()
Get the node that this stream receiver is linked to.StreamVariable
getStreamVariable()
Get theStreamVariable
for this stream receiver.-
Methods inherited from class com.vaadin.flow.server.AbstractStreamResource
getCacheTime, getId, setCacheTime
-
-
-
-
Constructor Detail
-
StreamReceiver
public StreamReceiver(StateNode node, String resourceName, StreamVariable streamVariable)
CreatesStreamReceiver
instance forstreamVariable
as a data receiver.resourceName
parameter value will be used in URI (generated when resource is registered) in a way that theresourceName
is the last segment of the path. So this is synthetic file name (not real one).- Parameters:
node
- receiver noderesourceName
- resource name for registration URIstreamVariable
- stream variable for controlling the upload stream
-
-
Method Detail
-
getNode
public StateNode getNode()
Get the node that this stream receiver is linked to.- Returns:
- bound node
-
getStreamVariable
public StreamVariable getStreamVariable()
Get theStreamVariable
for this stream receiver.- Returns:
- stream variable for this receiver
-
getName
public String getName()
Description copied from class:AbstractStreamResource
Get the resource name.The value will be used in URI (generated when resource is registered) in a way that the
name
is the last segment of the path. So this is a synthetic name.- Specified by:
getName
in classAbstractStreamResource
- Returns:
- resource name
-
-