public interface Registry
A running UPnP stack has one Registry
. Any discovered device is added
to this registry, as well as any exposed local device. The registry then maintains
these devices continuously (see RegistryMaintainer
) and when needed refreshes
their announcements on the network or removes them when they have expired. The registry
also keeps track of GENA event subscriptions.
UPnP client applications typically monitor activity of the registry
via RegistryListener
, they are inherently asynchronous.
The registry has to be shutdown()
properly, so it can notify all participants
on the network that local devices will no longer be available and cancel all
GENA subscriptions.
An implementation has to be thread-safe.
Modifier and Type | Method and Description |
---|---|
void |
addDevice(LocalDevice localDevice)
Call this method to add your local device metadata.
|
void |
addDevice(LocalDevice localDevice,
DiscoveryOptions options)
Call this method to add your local device metadata.
|
void |
addDevice(RemoteDevice remoteDevice)
Called internally by the UPnP discovery protocol.
|
void |
addListener(RegistryListener listener) |
void |
addLocalSubscription(LocalGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
void |
addRemoteSubscription(RemoteGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
void |
addResource(Resource resource)
Stores an arbitrary resource in the registry.
|
void |
addResource(Resource resource,
int maxAgeSeconds)
Stores an arbitrary resource in the registry.
|
void |
advertiseLocalDevices()
Manually trigger advertisement messages for all local devices.
|
UpnpServiceConfiguration |
getConfiguration() |
Device |
getDevice(UDN udn,
boolean rootOnly) |
Collection<Device> |
getDevices() |
Collection<Device> |
getDevices(DeviceType deviceType) |
Collection<Device> |
getDevices(ServiceType serviceType) |
DiscoveryOptions |
getDiscoveryOptions(UDN udn)
Get the currently active
DiscoveryOptions for the given (local device) UDN. |
Collection<RegistryListener> |
getListeners() |
LocalDevice |
getLocalDevice(UDN udn,
boolean rootOnly) |
Collection<LocalDevice> |
getLocalDevices() |
LocalGENASubscription |
getLocalSubscription(String subscriptionId)
Called internally by the UPnP stack, during GENA protocol execution.
|
ProtocolFactory |
getProtocolFactory() |
RemoteDevice |
getRemoteDevice(UDN udn,
boolean rootOnly) |
Collection<RemoteDevice> |
getRemoteDevices() |
RemoteGENASubscription |
getRemoteSubscription(String subscriptionId)
Called internally by the UPnP stack, during GENA protocol execution.
|
<T extends Resource> |
getResource(Class<T> resourceType,
URI pathQuery) |
Resource |
getResource(URI pathQuery) |
Collection<Resource> |
getResources() |
<T extends Resource> |
getResources(Class<T> resourceType) |
Service |
getService(ServiceReference serviceReference) |
UpnpService |
getUpnpService() |
RemoteGENASubscription |
getWaitRemoteSubscription(String subscriptionId)
Called internally by the UPnP stack, during GENA protocol execution.
|
boolean |
isPaused() |
void |
notifyDiscoveryFailure(RemoteDevice device,
Exception ex)
Called internally by the UPnP stack when the discovery protocol stopped abnormally.
|
boolean |
notifyDiscoveryStart(RemoteDevice device)
Called internally by the UPnP stack when the discovery protocol starts.
|
void |
pause()
Stops background maintenance (thread) of registered items.
|
void |
registerPendingRemoteSubscription(RemoteGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
void |
removeAllLocalDevices()
Clear the registry of all locally registered device metadata.
|
void |
removeAllRemoteDevices()
Clear the registry of all discovered remote device metadata.
|
boolean |
removeDevice(LocalDevice localDevice)
Call this to remove your local device metadata.
|
boolean |
removeDevice(RemoteDevice remoteDevice)
Called internally by the UPnP discovery protocol.
|
boolean |
removeDevice(UDN udn)
Call this to remove any device metadata with the given UDN.
|
void |
removeListener(RegistryListener listener) |
boolean |
removeLocalSubscription(LocalGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
void |
removeRemoteSubscription(RemoteGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
boolean |
removeResource(Resource resource)
Removes a resource from the registry.
|
void |
resume()
Resumes background maintenance (thread) of registered items.
|
void |
setDiscoveryOptions(UDN udn,
DiscoveryOptions options)
Change the active
DiscoveryOptions for the given (local device) UDN. |
void |
shutdown()
Typically called internally when the UPnP stack is stopping.
|
void |
unregisterPendingRemoteSubscription(RemoteGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
boolean |
update(RemoteDeviceIdentity rdIdentity)
Called internally by the UPnP discovery protocol.
|
boolean |
updateLocalSubscription(LocalGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
void |
updateRemoteSubscription(RemoteGENASubscription subscription)
Called internally by the UPnP stack, during GENA protocol execution.
|
UpnpService getUpnpService()
UpnpServiceConfiguration getConfiguration()
ProtocolFactory getProtocolFactory()
void shutdown()
Unsubscribe all local devices and GENA subscriptions.
void pause()
When paused, the registry will no longer remove expired remote devices if their discovery announcements stop for some reason (device was turned off). Your local control point will now see potentially unavailable remote devices. Outbound GENA subscriptions from your local control point to remote services will not be renewed automatically anymore, a remote service might drop your subscriptions if you don't resume maintenance within the subscription's expiration timeout.
Local devices and services will not be announced periodically anymore to remote control points, only when they are manually added are removed from the registry. The registry will also no longer remove expired inbound GENA subscriptions to local service from remote control points, if that control point for some reason stops sending subscription renewal messages.
void resume()
A local control point has to handle the following situations when resuming registry maintenance:
A remote device registration might have expired. This is the case when the remote device stopped sending announcements while the registry was paused (maybe because the device was switched off) and the registry was paused longer than the device advertisement's maximum age. The registry will not know if the device is still available when it resumes maintenance. However, it will simply assume that the remote device is still available and restart its expiration check cycle. That means a device will finally be removed from the registry, if no further announcements from the device are received, when the maximum age of the device has elapsed after the registry resumed operation.
Secondly, a remote device registration might not have expired but some of your
outbound GENA subscriptions to its services have not been renewed within the expected renewal
period. Therefore your outbound subscriptions might be invalid, because the remote
service can drop subscriptions when you don't renew them. On resume, the registry
will attempt to send renewals for all outbound GENA subscriptions that require
renewal, on devices that still haven't expired. If renewal fails, your subscription will
end with CancelReason.RENEWAL_FAILED
. Although
you then might conclude that the remote device is no longer available, a GENA renewal
can also fail for other reasons. The remote device will be kept and maintained in the
registry until it announces itself or it expires, even after a failed GENA renewal.
If you are providing local devices and services, resuming registry maintenance has the following effects:
Local devices and their services are announced again immediately if the registry has been paused for longer than half of the device's maximum age. Remote control points will either see this as a new device advertisement (if they have dropped your device while you paused maintenance) or as a regular update if you didn't pause longer than the device's maximum age/expiration timeout.
Inbound GENA subscriptions to your local services are active, even in paused state - remote control points should continue renewing the subscription. If a remote control point stopped renewing a subscription without unsubscribing (hard power off), an outdated inbound subscription will be detected when you resume maintenance. This subscription will be cleaned up immediately on resume.
boolean isPaused()
true
if the registry has currently no running background
maintenance (thread).void addListener(RegistryListener listener)
void removeListener(RegistryListener listener)
Collection<RegistryListener> getListeners()
boolean notifyDiscoveryStart(RemoteDevice device)
The registry will notify all registered listeners of this event, unless the given device was already in the registry.
device
- The half-hydrated (without services) metadata of the discovered device.false
if the device was already registered.void notifyDiscoveryFailure(RemoteDevice device, Exception ex)
The registry will notify all registered listeners of this event.
device
- The half-hydrated (without services) metadata of the discovered device.ex
- The cause for the interruption of the discovery protocol.void addDevice(LocalDevice localDevice) throws RegistrationException
localDevice
- The device to add and maintain.RegistrationException
- If a conflict with an already registered device was detected.void addDevice(LocalDevice localDevice, DiscoveryOptions options) throws RegistrationException
localDevice
- The device to add and maintain.options
- Immediately effective when this device is registered.RegistrationException
- If a conflict with an already registered device was detected.void setDiscoveryOptions(UDN udn, DiscoveryOptions options)
DiscoveryOptions
for the given (local device) UDN.options
- Set to null
to disable any options.DiscoveryOptions getDiscoveryOptions(UDN udn)
DiscoveryOptions
for the given (local device) UDN.null
if there are no active discovery options for the given UDN.void addDevice(RemoteDevice remoteDevice) throws RegistrationException
RegistrationException
- If a conflict with an already registered device was detected.boolean update(RemoteDeviceIdentity rdIdentity)
boolean removeDevice(LocalDevice localDevice)
true
if the device was registered and has been removed.boolean removeDevice(RemoteDevice remoteDevice)
boolean removeDevice(UDN udn)
true
if the device was registered and has been removed.void removeAllLocalDevices()
void removeAllRemoteDevices()
Device getDevice(UDN udn, boolean rootOnly)
udn
- The device name to lookup.rootOnly
- If true
, only matches of root devices are returned.null
.LocalDevice getLocalDevice(UDN udn, boolean rootOnly)
udn
- The device name to lookup.rootOnly
- If true
, only matches of root devices are returned.null
.RemoteDevice getRemoteDevice(UDN udn, boolean rootOnly)
udn
- The device name to lookup.rootOnly
- If true
, only matches of root devices are returned.null
.Collection<LocalDevice> getLocalDevices()
Collection<RemoteDevice> getRemoteDevices()
Collection<Device> getDevices()
Collection<Device> getDevices(DeviceType deviceType)
Collection<Device> getDevices(ServiceType serviceType)
Service getService(ServiceReference serviceReference)
null
if no service
for the given reference has been registered.void addResource(Resource resource)
resource
- The resource to maintain indefinitely (until it is manually removed).void addResource(Resource resource, int maxAgeSeconds)
Call this method repeatedly to refresh and prevent expiration of the resource.
resource
- The resource to maintain.maxAgeSeconds
- The time after which the registry will automatically remove the resource.boolean removeResource(Resource resource)
resource
- The resource to remove.true
if the resource was registered and has been removed.Resource getResource(URI pathQuery) throws IllegalArgumentException
pathQuery
- The path and optional query string of the resource's
registration URI (e.g. /dev/somefile.xml?param=value
)IllegalArgumentException
- If the given URI was absolute, only path and query are allowed.<T extends Resource> T getResource(Class<T> resourceType, URI pathQuery) throws IllegalArgumentException
T
- The required subtype of the Resource
.pathQuery
- The path and optional query string of the resource's
registration URI (e.g. /dev/somefile.xml?param=value
)resourceType
- The required subtype of the Resource
.IllegalArgumentException
- If the given URI was absolute, only path and query are allowed.Collection<Resource> getResources()
<T extends Resource> Collection<T> getResources(Class<T> resourceType)
void addLocalSubscription(LocalGENASubscription subscription)
LocalGENASubscription getLocalSubscription(String subscriptionId)
boolean updateLocalSubscription(LocalGENASubscription subscription)
boolean removeLocalSubscription(LocalGENASubscription subscription)
void addRemoteSubscription(RemoteGENASubscription subscription)
RemoteGENASubscription getRemoteSubscription(String subscriptionId)
void updateRemoteSubscription(RemoteGENASubscription subscription)
void removeRemoteSubscription(RemoteGENASubscription subscription)
void registerPendingRemoteSubscription(RemoteGENASubscription subscription)
When subscribing with a remote host, the remote host might send the initial event message faster than the response for the subscription request. This method register that the subscription procedure is executing.
void unregisterPendingRemoteSubscription(RemoteGENASubscription subscription)
Notify that the subscription procedure has terminated.
RemoteGENASubscription getWaitRemoteSubscription(String subscriptionId)
Get a remote subscription from its subscriptionId. If the subscription can't be found, wait for one of the pending remote subscription procedures from the registry background maintainer to terminate, until the subscription has been found or until there are no more pending subscription procedures.
void advertiseLocalDevices()
No messages will be send for devices with disabled advertisements, see
DiscoveryOptions
!
Copyright © 2016 4th Line GmbH, Switzerland. All rights reserved.