The core of the UPnP stack, keeping track of known devices and resources. More...

Inheritance diagram for de.yaacc.upnp.registry.Registry:

Collaboration diagram for de.yaacc.upnp.registry.Registry:

Public Member Functions
void	shutdown ()
	Typically called internally when the UPnP stack is stopping.

void	pause ()
	Stops background maintenance (thread) of registered items.

void	resume ()
	Resumes background maintenance (thread) of registered items.

boolean	isPaused ()

void	addListener (RegistryListener listener)

void	removeListener (RegistryListener listener)

Collection< RegistryListener >	getListeners ()

boolean	notifyDiscoveryStart (RemoteDevice device)
	Called internally by the UPnP stack when the discovery protocol starts.

void	notifyDiscoveryFailure (RemoteDevice device, Exception ex)
	Called internally by the UPnP stack when the discovery protocol stopped abnormally.

void	addDevice (LocalDevice localDevice) throws RegistrationException
	Call this method to add your local device metadata.

void	addDevice (LocalDevice localDevice, DiscoveryOptions options) throws RegistrationException
	Call this method to add your local device metadata.

void	setDiscoveryOptions (UDN udn, DiscoveryOptions options)
	Change the active `DiscoveryOptions` for the given (local device) UDN.

DiscoveryOptions	getDiscoveryOptions (UDN udn)
	Get the currently active `DiscoveryOptions` for the given (local device) UDN.

void	addDevice (RemoteDevice remoteDevice) throws RegistrationException
	Called internally by the UPnP discovery protocol.

boolean	update (RemoteDeviceIdentity rdIdentity)
	Called internally by the UPnP discovery protocol.

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	removeAllLocalDevices ()
	Clear the registry of all locally registered device metadata.

void	removeAllRemoteDevices ()
	Clear the registry of all discovered remote device metadata.

Device	getDevice (UDN udn, boolean rootOnly)

LocalDevice	getLocalDevice (UDN udn, boolean rootOnly)

RemoteDevice	getRemoteDevice (UDN udn, boolean rootOnly)

Collection< LocalDevice >	getLocalDevices ()

Collection< RemoteDevice >	getRemoteDevices ()

Collection< Device<?, ?, ?> >	getDevices ()

Collection< Device<?, ?, ?> >	getDevices (DeviceType deviceType)

Collection< Device<?, ?, ?> >	getDevices (ServiceType serviceType)

Service<?, ?>	getService (ServiceReference serviceReference)

void	addResource (Resource resource)
	Stores an arbitrary resource in the registry.

void	addResource (Resource resource, int maxAgeSeconds)
	Stores an arbitrary resource in the registry.

boolean	removeResource (Resource resource)
	Removes a resource from the registry.

Resource	getResource (URI pathQuery) throws IllegalArgumentException

public< T extends Resource > T	getResource (Class< T > resourceType, URI pathQuery) throws IllegalArgumentException

Collection< Resource >	getResources ()

public< T extends Resource > Collection< T >	getResources (Class< T > resourceType)

void	addLocalSubscription (LocalGENASubscription subscription)
	Called internally by the UPnP stack, during GENA protocol execution.

LocalGENASubscription	getLocalSubscription (String subscriptionId)
	Called internally by the UPnP stack, during GENA protocol execution.

boolean	updateLocalSubscription (LocalGENASubscription subscription)
	Called internally by the UPnP stack, during GENA protocol execution.

boolean	removeLocalSubscription (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.

RemoteGENASubscription	getRemoteSubscription (String subscriptionId)
	Called internally by the UPnP stack, during GENA protocol execution.

void	updateRemoteSubscription (RemoteGENASubscription 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.

void	registerPendingRemoteSubscription (RemoteGENASubscription subscription)
	Called internally by the UPnP stack, during GENA protocol execution.

void	unregisterPendingRemoteSubscription (RemoteGENASubscription subscription)
	Called internally by the UPnP stack, during GENA protocol execution.

RemoteGENASubscription	getWaitRemoteSubscription (String subscriptionId)
	Called internally by the UPnP stack, during GENA protocol execution.

void	advertiseLocalDevices ()
	Manually trigger advertisement messages for all local devices.

void	setAliveInterval (int intervalMillis)
	Set the interval for periodic ALIVE announcements.

UpnpProtocolHandler	getUpnpProtocolHandler ()

void	setUpnpProtocolHandler (UpnpProtocolHandler upnpProtocolHandler)

ExecutorService	getExecutorService ()

Detailed Description

The core of the UPnP stack, keeping track of known devices and resources.

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.

Author: Christian Bauer

Member Function Documentation

◆ addDevice() [1/3]

void de.yaacc.upnp.registry.Registry.addDevice ( LocalDevice localDevice ) throws RegistrationException

Call this method to add your local device metadata.

Parameters

localDevice The device to add and maintain.

Exceptions

RegistrationException If a conflict with an already registered device was detected.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addDevice() [2/3]

void de.yaacc.upnp.registry.Registry.addDevice	(	LocalDevice	localDevice,
		DiscoveryOptions	options
	)		throws RegistrationException

Call this method to add your local device metadata.

Parameters

localDevice	The device to add and maintain.
options	Immediately effective when this device is registered.

Exceptions

RegistrationException If a conflict with an already registered device was detected.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addDevice() [3/3]

void de.yaacc.upnp.registry.Registry.addDevice ( RemoteDevice remoteDevice ) throws RegistrationException

Called internally by the UPnP discovery protocol.

Exceptions

RegistrationException If a conflict with an already registered device was detected.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addLocalSubscription()

void de.yaacc.upnp.registry.Registry.addLocalSubscription ( LocalGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addRemoteSubscription()

void de.yaacc.upnp.registry.Registry.addRemoteSubscription ( RemoteGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addResource() [1/2]

void de.yaacc.upnp.registry.Registry.addResource ( Resource resource )

Stores an arbitrary resource in the registry.

Parameters

resource The resource to maintain indefinitely (until it is manually removed).

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ addResource() [2/2]

void de.yaacc.upnp.registry.Registry.addResource	(	Resource	resource,
		int	maxAgeSeconds
	)

Stores an arbitrary resource in the registry.

Call this method repeatedly to refresh and prevent expiration of the resource.

Parameters

resource	The resource to maintain.
maxAgeSeconds	The time after which the registry will automatically remove the resource.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ advertiseLocalDevices()

void de.yaacc.upnp.registry.Registry.advertiseLocalDevices ( )

Manually trigger advertisement messages for all local devices.

No messages will be send for devices with disabled advertisements, see DiscoveryOptions!

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getDevice()

Device de.yaacc.upnp.registry.Registry.getDevice	(	UDN	udn,
		boolean	rootOnly
	)

Parameters

udn	The device name to lookup.
rootOnly	If `true`, only matches of root devices are returned.

Returns: The registered root or embedded device metadata, or null.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getDevices() [1/3]

Collection< Device<?, ?, ?> > de.yaacc.upnp.registry.Registry.getDevices ( )

Returns: All device metadata, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getDevices() [2/3]

Collection< Device<?, ?, ?> > de.yaacc.upnp.registry.Registry.getDevices ( DeviceType deviceType )

Returns: All device metadata of devices which implement the given type, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getDevices() [3/3]

Collection< Device<?, ?, ?> > de.yaacc.upnp.registry.Registry.getDevices ( ServiceType serviceType )

Returns: All device metadata of devices which have a service that implements the given type, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getDiscoveryOptions()

DiscoveryOptions de.yaacc.upnp.registry.Registry.getDiscoveryOptions ( UDN udn )

Get the currently active DiscoveryOptions for the given (local device) UDN.

Returns: null if there are no active discovery options for the given UDN.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getLocalDevice()

LocalDevice de.yaacc.upnp.registry.Registry.getLocalDevice	(	UDN	udn,
		boolean	rootOnly
	)

Parameters

udn	The device name to lookup.
rootOnly	If `true`, only matches of root devices are returned.

Returns: The registered root or embedded device metadata, or null.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getLocalDevices()

Collection< LocalDevice > de.yaacc.upnp.registry.Registry.getLocalDevices ( )

Returns: All locally registered device metadata, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getLocalSubscription()

LocalGENASubscription de.yaacc.upnp.registry.Registry.getLocalSubscription ( String subscriptionId )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getRemoteDevice()

RemoteDevice de.yaacc.upnp.registry.Registry.getRemoteDevice	(	UDN	udn,
		boolean	rootOnly
	)

Parameters

udn	The device name to lookup.
rootOnly	If `true`, only matches of root devices are returned.

Returns: The registered root or embedded device metadata, or null.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getRemoteDevices()

Collection< RemoteDevice > de.yaacc.upnp.registry.Registry.getRemoteDevices ( )

Returns: All discovered remote device metadata, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getRemoteSubscription()

RemoteGENASubscription de.yaacc.upnp.registry.Registry.getRemoteSubscription ( String subscriptionId )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getResource() [1/2]

public< T extends Resource > T de.yaacc.upnp.registry.Registry.getResource	(	Class< T >	resourceType,
		URI	pathQuery
	)		throws IllegalArgumentException

Parameters

<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`.

Returns: Any registered resource that matches the given URI path and subtype.

Exceptions

IllegalArgumentException If the given URI was absolute, only path and query are allowed.

◆ getResource() [2/2]

Resource de.yaacc.upnp.registry.Registry.getResource ( URI pathQuery ) throws IllegalArgumentException

Parameters

pathQuery The path and optional query string of the resource's registration URI (e.g. /dev/somefile.xml?param=value)

Returns: Any registered resource that matches the given URI path.

Exceptions

IllegalArgumentException If the given URI was absolute, only path and query are allowed.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getResources() [1/2]

Collection< Resource > de.yaacc.upnp.registry.Registry.getResources ( )

Returns: All registered resources, in no particular order, or an empty collection.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getResources() [2/2]

public< T extends Resource > Collection< T > de.yaacc.upnp.registry.Registry.getResources ( Class< T > resourceType )

Parameters

<T>	The required subtype of the `Resource`.
resourceType	The required subtype of the `Resource`.

Returns: Any registered resource that matches the given subtype.

◆ getService()

Service<?, ?> de.yaacc.upnp.registry.Registry.getService ( ServiceReference serviceReference )

Returns: Complete service metadata for a service reference or null if no service for the given reference has been registered.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ getWaitRemoteSubscription()

RemoteGENASubscription de.yaacc.upnp.registry.Registry.getWaitRemoteSubscription ( String subscriptionId )

Called internally by the UPnP stack, during GENA protocol execution.

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.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ isPaused()

boolean de.yaacc.upnp.registry.Registry.isPaused ( )

Returns: true if the registry has currently no running background maintenance (thread).

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ notifyDiscoveryFailure()

void de.yaacc.upnp.registry.Registry.notifyDiscoveryFailure	(	RemoteDevice	device,
		Exception	ex
	)

Called internally by the UPnP stack when the discovery protocol stopped abnormally.

The registry will notify all registered listeners of this event.

Parameters

device	The half-hydrated (without services) metadata of the discovered device.
ex	The cause for the interruption of the discovery protocol.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ notifyDiscoveryStart()

boolean de.yaacc.upnp.registry.Registry.notifyDiscoveryStart ( RemoteDevice device )

Called internally by the UPnP stack when the discovery protocol starts.

The registry will notify all registered listeners of this event, unless the given device was already in the registry.

Parameters

device The half-hydrated (without services) metadata of the discovered device.

Returns: false if the device was already registered.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ pause()

void de.yaacc.upnp.registry.Registry.pause ( )

Stops background maintenance (thread) of registered items.

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.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ registerPendingRemoteSubscription()

void de.yaacc.upnp.registry.Registry.registerPendingRemoteSubscription ( RemoteGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

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.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeAllLocalDevices()

void de.yaacc.upnp.registry.Registry.removeAllLocalDevices ( )

Clear the registry of all locally registered device metadata.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeAllRemoteDevices()

void de.yaacc.upnp.registry.Registry.removeAllRemoteDevices ( )

Clear the registry of all discovered remote device metadata.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeDevice() [1/3]

boolean de.yaacc.upnp.registry.Registry.removeDevice ( LocalDevice localDevice )

Call this to remove your local device metadata.

Returns: true if the device was registered and has been removed.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeDevice() [2/3]

boolean de.yaacc.upnp.registry.Registry.removeDevice ( RemoteDevice remoteDevice )

Called internally by the UPnP discovery protocol.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeDevice() [3/3]

boolean de.yaacc.upnp.registry.Registry.removeDevice ( UDN udn )

Call this to remove any device metadata with the given UDN.

Returns: true if the device was registered and has been removed.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeLocalSubscription()

boolean de.yaacc.upnp.registry.Registry.removeLocalSubscription ( LocalGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeRemoteSubscription()

void de.yaacc.upnp.registry.Registry.removeRemoteSubscription ( RemoteGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ removeResource()

boolean de.yaacc.upnp.registry.Registry.removeResource ( Resource resource )

Removes a resource from the registry.

Parameters

resource The resource to remove.

Returns: true if the resource was registered and has been removed.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ resume()

void de.yaacc.upnp.registry.Registry.resume ( )

Resumes background maintenance (thread) of registered items.

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 org.fourthline.cling.model.gena.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.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ setAliveInterval()

void de.yaacc.upnp.registry.Registry.setAliveInterval ( int intervalMillis )

Set the interval for periodic ALIVE announcements.

Set to 0 to disable periodic announcements (devices will only announce on expiration). Recommended value: 5000ms (5 seconds) for better discovery by clients like Kodi.

Parameters

intervalMillis interval in milliseconds between ALIVE announcements

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ setDiscoveryOptions()

void de.yaacc.upnp.registry.Registry.setDiscoveryOptions	(	UDN	udn,
		DiscoveryOptions	options
	)

Change the active DiscoveryOptions for the given (local device) UDN.

Parameters

options Set to null to disable any options.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ shutdown()

void de.yaacc.upnp.registry.Registry.shutdown ( )

Typically called internally when the UPnP stack is stopping.

Unsubscribe all local devices and GENA subscriptions.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ unregisterPendingRemoteSubscription()

void de.yaacc.upnp.registry.Registry.unregisterPendingRemoteSubscription ( RemoteGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Notify that the subscription procedure has terminated.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ update()

boolean de.yaacc.upnp.registry.Registry.update ( RemoteDeviceIdentity rdIdentity )

Called internally by the UPnP discovery protocol.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ updateLocalSubscription()

boolean de.yaacc.upnp.registry.Registry.updateLocalSubscription ( LocalGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

◆ updateRemoteSubscription()

void de.yaacc.upnp.registry.Registry.updateRemoteSubscription ( RemoteGENASubscription subscription )

Called internally by the UPnP stack, during GENA protocol execution.

Implemented in de.yaacc.upnp.registry.RegistryImpl.

The documentation for this interface was generated from the following file:

/github/workspace/yaacc/src/main/java/de/yaacc/upnp/registry/Registry.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addDevice() [1/3]

◆ addDevice() [2/3]

◆ addDevice() [3/3]

◆ addLocalSubscription()

◆ addRemoteSubscription()

◆ addResource() [1/2]

◆ addResource() [2/2]

◆ advertiseLocalDevices()

◆ getDevice()

◆ getDevices() [1/3]

◆ getDevices() [2/3]

◆ getDevices() [3/3]

◆ getDiscoveryOptions()

◆ getLocalDevice()

◆ getLocalDevices()

◆ getLocalSubscription()

◆ getRemoteDevice()

◆ getRemoteDevices()

◆ getRemoteSubscription()

◆ getResource() [1/2]

◆ getResource() [2/2]

◆ getResources() [1/2]

◆ getResources() [2/2]

◆ getService()

◆ getWaitRemoteSubscription()

◆ isPaused()

◆ notifyDiscoveryFailure()

◆ notifyDiscoveryStart()

◆ pause()

◆ registerPendingRemoteSubscription()

◆ removeAllLocalDevices()

◆ removeAllRemoteDevices()

◆ removeDevice() [1/3]

◆ removeDevice() [2/3]

◆ removeDevice() [3/3]

◆ removeLocalSubscription()

◆ removeRemoteSubscription()

◆ removeResource()

◆ resume()

◆ setAliveInterval()

◆ setDiscoveryOptions()

◆ shutdown()

◆ unregisterPendingRemoteSubscription()

◆ update()

◆ updateLocalSubscription()

◆ updateRemoteSubscription()