org.ocap.hn.upnp.common

Interface UPnPDevice

All Known Subinterfaces:

UPnPAdvertisedDevice, UPnPClientDevice, UPnPManagedDevice

public interface UPnPDevice

This interface is an abstract representation of a UPnP device. It provides the data constituting a UPnP device that is independent of the network interface on which the device is advertised.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDeviceType() Gets the UPnP deviceType of this device.
String	getFriendlyName() Gets the UPnP "friendly name" of this device.
String	getManufacturer() Gets the UPnP manufacturer of this device.
String	getManufacturerURL() Gets the UPnP manufacturer URL of this device.
String	getModelDescription() Gets the UPnP model description of this device.
String	getModelName() Gets the UPnP model name of this device.
String	getModelNumber() Gets the UPnP model number of this device.
String	getModelURL() Gets the UPnP model URL of this device.
String	getSerialNumber() Gets the UPnP serial number of this device.
String	getSpecVersion() Gets the UPnP specVersion major and minor values of this UPnP device, or of the root UPnP device containing this device.
String	getUDN() Gets the UPnP Unique Device Name of this device.
String	getUPC() Gets the UPnP Universal Product Code of this device.
boolean	isRootDevice() Reports whether this UPnP device is a UPnP root device.

Method Detail

getDeviceType

String getDeviceType()

Gets the UPnP deviceType of this device. This value is taken from the value of the deviceType element within the device description.

Returns:

The type of this device. If the deviceType is empty or not present, returns the empty String.

getFriendlyName

String getFriendlyName()

Gets the UPnP "friendly name" of this device. This value is taken from the value of the friendlyName element within the device description.

Returns:

The friendlyName of this device. If the friendlyName is empty or not present, returns the empty String.

getManufacturer

String getManufacturer()

Gets the UPnP manufacturer of this device. This value is taken from the value of the manufacturer element within the device description.

Returns:

The manufacturer of this device. If the manufacturer is empty or not present, returns the empty String.

getManufacturerURL

String getManufacturerURL()

Gets the UPnP manufacturer URL of this device. This value is taken from the value of the manufacturerURL element within the device description. If the manufacturerURL is empty or not present, returns the empty String.

Returns:

The manufacturerURL of this device.

getModelDescription

String getModelDescription()

Gets the UPnP model description of this device. This value is taken from the value of the modelDescription element within the device description. If the modelDescription is empty or not present, returns the empty String.

Returns:

The modelDescription of this device.

getModelName

String getModelName()

Gets the UPnP model name of this device. This value is taken from the value of the modelName element within the device description.

Returns:

The modelName of this device. If the modelName is empty or not present, returns the empty String.

getModelNumber

String getModelNumber()

Gets the UPnP model number of this device. This value is taken from the value of the modelNumber element within the device description. If the modelNumber is empty or not present, returns the empty String.

Returns:

The modelNumber of this device.

getModelURL

String getModelURL()

Gets the UPnP model URL of this device. This value is taken from the value of the modelURL element within the device description. If the modelURL is empty or not present, returns the empty String.

Returns:

The modelURL of this device.

getSerialNumber

String getSerialNumber()

Gets the UPnP serial number of this device. This value is taken from the value of the serialNumber element within the device description. If the serialNumber is empty or not present, returns the empty String.

Returns:

The serialNumber of this device.

getSpecVersion

String getSpecVersion()

Gets the UPnP specVersion major and minor values of this UPnP device, or of the root UPnP device containing this device. This value is taken from the value of the major and minor sub elements of the specVersion element within the device description. The format of the returned String is the <major> value, followed by '.', followed by the <minor> value.

Returns:

The UPnP specVersion of this device.

getUDN

String getUDN()

Gets the UPnP Unique Device Name of this device. This value is taken from the value of the UDN element within the device description.

Returns:

The UDN of this device. If the UDN is empty or not present, returns the empty String.

getUPC

String getUPC()

Gets the UPnP Universal Product Code of this device. This value is taken from the value of the UPC element within the device description. If the UPC is empty or not present, returns the empty String.

Returns:

The UPC of this device.

isRootDevice

boolean isRootDevice()

Reports whether this UPnP device is a UPnP root device.

Returns:

true if this UPnP device represents a root device, false if not.