public class StreamResourceRegistry extends Object implements Serializable
StreamResource
instances.Constructor and Description |
---|
StreamResourceRegistry(VaadinSession session)
Creates stream resource registry for provided
session . |
Modifier and Type | Method and Description |
---|---|
<T extends AbstractStreamResource> |
getResource(Class<T> type,
URI uri)
Get a registered resource of given type.
|
Optional<AbstractStreamResource> |
getResource(URI uri)
Get a registered resource for given
URI . |
URI |
getTargetURI(AbstractStreamResource resource)
Returns the URI path to the given resource in the context of this
registry (relevant in portlet context).
|
static URI |
getURI(AbstractStreamResource resource)
Gets the URI for the given
resource . |
StreamRegistration |
registerResource(AbstractStreamResource resource)
Registers a stream resource in the session and returns registration
handler.
|
void |
unregisterResource(StreamReceiver resource)
Unregister a stream receiver resource.
|
public StreamResourceRegistry(VaadinSession session)
session
.session
- vaadin sessionpublic StreamRegistration registerResource(AbstractStreamResource resource)
You can get resource URI to use it in the application (e.g. set an attribute value or property value) via the registration handler. The registration handler should be used to unregister resource when it's not needed anymore. Note that it is the developer's responsibility to unregister resources. Otherwise resources won't be garbage collected until the session expires which causes memory leak.
resource
- stream resource to registerpublic void unregisterResource(StreamReceiver resource)
resource
- stream receiver resource to unregisterpublic static URI getURI(AbstractStreamResource resource)
resource
.
The URI won't be handled (and won't work) if resource
is not
registered in the session.
resource
- stream resourceregisterResource(AbstractStreamResource)
public URI getTargetURI(AbstractStreamResource resource)
resource
- stream resourcepublic Optional<AbstractStreamResource> getResource(URI uri)
URI
.
Resource may be a StreamResource or a StreamReceiver
uri
- resource URIpublic <T extends AbstractStreamResource> Optional<T> getResource(Class<T> type, URI uri)
T
- resource extending AbstractStreamResourcetype
- resource class typeuri
- resource URICopyright © 2025. All rights reserved.