net.sbbi.upnp.devices
Class UPNPDevice

java.lang.Object
  extended bynet.sbbi.upnp.devices.UPNPDevice
Direct Known Subclasses:
UPNPRootDevice

public class UPNPDevice
extends java.lang.Object

This class represents an UPNP device, this device contains a set of services that will be needed to access the device functionalities.

Version:
1.0
Author:
SuperBonBon

Constructor Summary
UPNPDevice()
           
 
Method Summary
 UPNPDevice getChildDevice(java.lang.String deviceURI)
          Looks for a child UPNP device definition file, the whole devices tree will be searched, starting from the current device node.
 java.util.List getChildDevices()
          Generates a list of all the child ( not only top level, full childrens hierarchy included ) UPNPDevice objects for this device.
 java.util.List getDeviceIcons()
          Access to the device icons definitions
 java.lang.String getDeviceType()
           
 UPNPDevice getDirectParent()
          Return the parent UPNPDevice, null if the device is an UPNPRootDevice
 java.lang.String getFriendlyName()
           
 java.lang.String getManufacturer()
           
 java.net.URL getManufacturerURL()
           
 java.lang.String getModelDescription()
           
 java.lang.String getModelName()
           
 java.lang.String getModelNumber()
           
 java.lang.String getModelURL()
           
 java.net.URL getPresentationURL()
          Presentation URL
 java.lang.String getSerialNumber()
           
 UPNPService getService(java.lang.String serviceURI)
          Looks for a UPNP device service definition object for the given service URI (Type)
 UPNPService getServiceByID(java.lang.String serviceID)
          Looks for a UPNP device service definition object for the given service ID
 java.util.List getServices()
          Looks for all UPNP device service definitions objects
 java.util.List getServices(java.lang.String serviceURI)
          Looks for the all the UPNP device service definition object for the current UPNP device object.
 java.util.List getTopLevelChildDevices()
          Generates a list of all the child ( only top level ) UPNPDevice objects for this device.
 java.lang.String getUDN()
           
 long getUPC()
           
 java.lang.String getUSN()
           
 boolean isRootDevice()
           
 java.lang.String toString()
          The toString return the device type
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UPNPDevice

public UPNPDevice()
Method Detail

getManufacturerURL

public java.net.URL getManufacturerURL()

getPresentationURL

public java.net.URL getPresentationURL()
Presentation URL

Returns:
URL the presenation URL, or null if the device does not provide such information

getModelDescription

public java.lang.String getModelDescription()

getModelName

public java.lang.String getModelName()

getModelNumber

public java.lang.String getModelNumber()

getModelURL

public java.lang.String getModelURL()

getSerialNumber

public java.lang.String getSerialNumber()

getUDN

public java.lang.String getUDN()

getUSN

public java.lang.String getUSN()

getUPC

public long getUPC()

getDeviceType

public java.lang.String getDeviceType()

getFriendlyName

public java.lang.String getFriendlyName()

getManufacturer

public java.lang.String getManufacturer()

isRootDevice

public boolean isRootDevice()

getDeviceIcons

public java.util.List getDeviceIcons()
Access to the device icons definitions

Returns:
a list containing DeviceIcon objects or null if no icons defined

getChildDevices

public java.util.List getChildDevices()
Generates a list of all the child ( not only top level, full childrens hierarchy included ) UPNPDevice objects for this device.

Returns:
the generated list or null if no child devices bound

getTopLevelChildDevices

public java.util.List getTopLevelChildDevices()
Generates a list of all the child ( only top level ) UPNPDevice objects for this device.

Returns:
the generated list or null if no child devices bound

getDirectParent

public UPNPDevice getDirectParent()
Return the parent UPNPDevice, null if the device is an UPNPRootDevice

Returns:
the parent device instance

getChildDevice

public UPNPDevice getChildDevice(java.lang.String deviceURI)
Looks for a child UPNP device definition file, the whole devices tree will be searched, starting from the current device node.

Parameters:
deviceURI - the device URI to search
Returns:
An UPNPDevice if anything matches or null

getServices

public java.util.List getServices()
Looks for all UPNP device service definitions objects

Returns:
A list of all device services

getService

public UPNPService getService(java.lang.String serviceURI)
Looks for a UPNP device service definition object for the given service URI (Type)

Parameters:
serviceURI - the URI of the service
Returns:
A matching UPNPService object or null

getServiceByID

public UPNPService getServiceByID(java.lang.String serviceID)
Looks for a UPNP device service definition object for the given service ID

Returns:
A matching UPNPService object or null

getServices

public java.util.List getServices(java.lang.String serviceURI)
Looks for the all the UPNP device service definition object for the current UPNP device object. This method can be used to retreive multiple same kind ( same service type ) of services with different services id on a device

Parameters:
serviceURI - the URI of the service
Returns:
A matching List of UPNPService objects or null

toString

public java.lang.String toString()
The toString return the device type

Returns:
the device type


Copyright © 2005 SuperBonBon Industries. All Rights Reserved.