org.ocap.hn.upnp.client
Interface UPnPClientDevice

All Superinterfaces:

UPnPAdvertisedDevice, UPnPDevice

public interface UPnPClientDevice
extends UPnPAdvertisedDevice

This interface provides the client representation of a UPnP device, associated with a single IP address.

Method Summary

UPnPClientDevice[]	getEmbeddedDevices() Gets the embedded devices for this UPnP Device.
UPnPClientDeviceIcon[]	getIcons() Gets the icons of this device.
UPnPClientDevice	getParentDevice() Returns the parent UPnP Device of this device, if any.
UPnPClientService[]	getServices() Gets the services supported by this device.

Methods inherited from interface org.ocap.hn.upnp.common.UPnPAdvertisedDevice

getAdvertisedIcons, getAdvertisedServices, getEmbeddedAdvertisedDevices, getInetAddress, getPresentationURL, getURLBase, getXML

Methods inherited from interface org.ocap.hn.upnp.common.UPnPDevice

getDeviceType, getFriendlyName, getManufacturer, getManufacturerURL, getModelDescription, getModelName, getModelNumber, getModelURL, getSerialNumber, getSpecVersion, getUDN, getUPC, isRootDevice

Method Detail

getParentDevice

UPnPClientDevice getParentDevice()

Returns the parent UPnP Device of this device, if any.

Returns:

This device's parent device. Returns null if this device has no parent.

getEmbeddedDevices

UPnPClientDevice[] getEmbeddedDevices()

Gets the embedded devices for this UPnP Device.

Returns:

The embedded devices for this device. If this device has no embedded devices, returns a zero length array. Returns only the next level of embedded devices, not recursing through embedded devices for subsequent levels of embedded devices.

getServices

UPnPClientService[] getServices()

Gets the services supported by this device. Does not return services held in embedded devices.

Returns:

The services supported by this device. If the serviceList element in the device description is empty, this method returns a zero length array.

getIcons

UPnPClientDeviceIcon[] getIcons()

Gets the icons of this device. This returned array is derived from the icon elements within the iconList element of a device description. If the iconList element in the device description is empty or not present, returns a zero length array.

Returns:

The icons that the device declares.