Package org.jupnp.protocol

Klasse RetrieveRemoteDescriptors

java.lang.Object

org.jupnp.protocol.RetrieveRemoteDescriptors

Alle implementierten Schnittstellen:

Runnable

public class RetrieveRemoteDescriptors
extends Object
implements Runnable

Retrieves all remote device XML descriptors, parses them, creates an immutable device and service metadata graph.

This implementation encapsulates all steps which are necessary to create a fully usable and populated device metadata graph of a particular UPnP device. It starts with an unhydrated and typically just discovered RemoteDevice, the only property that has to be available is its RemoteDeviceIdentity.

This protocol implementation will then retrieve the device's XML descriptor, parse it, and retrieve and parse all service descriptors until all device and service metadata has been retrieved. The fully hydrated device is then added to the Registry.

Any descriptor retrieval, parsing, or validation error of the metadata will abort this protocol with a warning message in the log.

Autor:

Christian Bauer, Kai Kreuzer - fixed service and embedded device processing

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected List<UDN>	errorsAlreadyLogged

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
RetrieveRemoteDescriptors(UpnpService upnpService, RemoteDevice rd)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	describe()
protected void	describe(String descriptorXML)
protected RemoteService	describeService(RemoteService service)
protected RemoteDevice	describeServices(RemoteDevice currentDevice)
protected List<RemoteService>	filterExclusiveServices(RemoteService[] services)
UpnpService	getUpnpService()
static boolean	isRetrievalInProgress(RemoteDevice rd)	Check if the descriptor that is going to be retrieved by this task is already being retrieved by another task.
void	run()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

errorsAlreadyLogged

protected List<UDN> errorsAlreadyLogged

Konstruktordetails

RetrieveRemoteDescriptors

public RetrieveRemoteDescriptors(UpnpService upnpService,
 RemoteDevice rd)

Methodendetails

getUpnpService

public UpnpService getUpnpService()

run

public void run()

Angegeben von:

run in Schnittstelle Runnable

describe

protected void describe()
                 throws RouterException

Löst aus:

RouterException

describe

protected void describe(String descriptorXML)
                 throws RouterException

Löst aus:

RouterException

describeServices

protected RemoteDevice describeServices(RemoteDevice currentDevice)
                                 throws RouterException,
DescriptorBindingException,
ValidationException

Löst aus:

RouterException

DescriptorBindingException

ValidationException

describeService

protected RemoteService describeService(RemoteService service)
                                 throws RouterException,
DescriptorBindingException,
ValidationException

Löst aus:

RouterException

DescriptorBindingException

ValidationException

filterExclusiveServices

protected List<RemoteService> filterExclusiveServices(RemoteService[] services)

isRetrievalInProgress

public static boolean isRetrievalInProgress(RemoteDevice rd)

Check if the descriptor that is going to be retrieved by this task is already being retrieved by another task. Can be used for optimization to prevent submitting tasks that are not going to retrieve a new descriptor.

Parameter:

rd - The remote device to check

Gibt zurück:

true the descriptor is currently being retrieved, otherwise false

Löst aus:

IllegalArgumentException - if the remote device is null