com.vaadin.flow.server.StreamRegistration API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.server.

All Superinterfaces:

Serializable
```
public interface StreamRegistration
extends Serializable
```
Stream registration result.
Use getResourceUri() to get URI after StreamResource / StreamReceiver is registered.
Also allows resource unregistering.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

All Methods
Modifier and Type	Method	Description
`AbstractStreamResource`	`getResource()`	Get the stream resource whose registration result is represented by this `StreamRegistration` instance.
`URI`	`getResourceUri()`	Get resource URI for registered `StreamResource` instance.
`void`	`unregister()`	Unregister `StreamResource`.

- Method Detail
  - getResourceUri
```
URI getResourceUri()
```
    Get resource URI for registered StreamResource instance.
    The URI is relative to the application base URI.
    
    Returns:
    
    resource URI
  - unregister
```
void unregister()
```
    Unregister StreamResource.
    The resource will be removed from the session and its URI won't be served by the application anymore so that the resource becomes available for GC.
    It's the developer's responsibility to call this method at the appropriate time. Otherwise the resource instance will stay in memory until the session expires.
  - getResource
```
AbstractStreamResource getResource()
```
    Get the stream resource whose registration result is represented by this StreamRegistration instance.
    
    Returns:
    
    resource, or null if resource has been already unregistered