Module org.cybergarage.upnp
Package org.cybergarage.upnp

Class Device

java.lang.Object
org.cybergarage.upnp.Device
All Implemented Interfaces:
org.cybergarage.http.HTTPRequestListener, org.cybergarage.upnp.device.SearchListener
Direct Known Subclasses:
MediaServer
public class Device extends Object implements org.cybergarage.http.HTTPRequestListener, org.cybergarage.upnp.device.SearchListener

  • Field Details

  • Constructor Details

    • Device

      public Device(org.cybergarage.xml.Node root, org.cybergarage.xml.Node device)

    • Device

      public Device()

    • Device

      public Device(org.cybergarage.xml.Node device)

    • Device

      public Device(File descriptionFile) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException

    • Device

      public Device(InputStream input) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException
      Since:
      1.8.0

    • Device

      public Device(String descriptionFileName) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException

  • Method Details

    • getRootNode

      public org.cybergarage.xml.Node getRootNode()

    • getDeviceNode

      public org.cybergarage.xml.Node getDeviceNode()

    • setRootNode

      public void setRootNode(org.cybergarage.xml.Node node)

    • setDeviceNode

      public void setDeviceNode(org.cybergarage.xml.Node node)

    • lock

      public void lock()

    • unlock

      public void unlock()

    • getAbsoluteURL

      public String getAbsoluteURL(String urlString, String baseURLStr, String locationURLStr)

    • getAbsoluteURL

      public String getAbsoluteURL(String urlString)

    • setNMPRMode

      public void setNMPRMode(boolean flag)

    • isNMPRMode

      public boolean isNMPRMode()

    • setWirelessMode

      public void setWirelessMode(boolean flag)

    • isWirelessMode

      public boolean isWirelessMode()

    • getSSDPAnnounceCount

      public int getSSDPAnnounceCount()

    • getUUID

      public String getUUID()

    • getBootId

      public int getBootId()

    • updateConfigId

      public void updateConfigId()

    • getConfigId

      public int getConfigId()

    • getRootDevice

      public Device getRootDevice()

    • getParentDevice

      public Device getParentDevice()
      Returns:
      A Device that contain this object.
      Return null if this is a root device.

    • addService

      public void addService(Service s)
      Add a Service to device without checking for duplicate or syntax error
      Parameters:
      s - Add Service s to the Device

    • addDevice

      public void addDevice(Device d)
      Add a Device to device without checking for duplicate or syntax error. This method set or reset the root node of the Device and itself

      Note: This method should be used to create a dynamic
      Device withtout writing any XML that describe the device
      .
      Parameters:
      d - Add Device d to the Device

    • getDescriptionFile

      public File getDescriptionFile()

    • getDescriptionFilePath

      public String getDescriptionFilePath()

    • loadDescription

      public boolean loadDescription(InputStream input) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException
      Since:
      1.8.0

    • loadDescription

      public boolean loadDescription(String descString) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException

    • loadDescription

      public boolean loadDescription(File file) throws org.cybergarage.upnp.device.InvalidDescriptionException
      Throws:
      org.cybergarage.upnp.device.InvalidDescriptionException

    • isDeviceNode

      public static boolean isDeviceNode(org.cybergarage.xml.Node node)

    • isRootDevice

      public boolean isRootDevice()

    • setSSDPPacket

      public void setSSDPPacket(org.cybergarage.upnp.ssdp.SSDPPacket packet)

    • getSSDPPacket

      public org.cybergarage.upnp.ssdp.SSDPPacket getSSDPPacket()

    • setLocation

      public void setLocation(String value)

    • getLocation

      public String getLocation()

    • setLeaseTime

      public void setLeaseTime(int value)

    • getLeaseTime

      public int getLeaseTime()

    • getTimeStamp

      public long getTimeStamp()

    • getElapsedTime

      public long getElapsedTime()

    • isExpired

      public boolean isExpired()

    • getURLBase

      public String getURLBase()

    • setDeviceType

      public void setDeviceType(String value)

    • getDeviceType

      public String getDeviceType()

    • isDeviceType

      public boolean isDeviceType(String value)

    • setFriendlyName

      public void setFriendlyName(String value)

    • getFriendlyName

      public String getFriendlyName()

    • setManufacture

      public void setManufacture(String value)

    • getManufacture

      public String getManufacture()

    • setManufactureURL

      public void setManufactureURL(String value)

    • getManufactureURL

      public String getManufactureURL()

    • setModelDescription

      public void setModelDescription(String value)

    • getModelDescription

      public String getModelDescription()

    • setModelName

      public void setModelName(String value)

    • getModelName

      public String getModelName()

    • setModelNumber

      public void setModelNumber(String value)

    • getModelNumber

      public String getModelNumber()

    • setModelURL

      public void setModelURL(String value)

    • getModelURL

      public String getModelURL()

    • setSerialNumber

      public void setSerialNumber(String value)

    • getSerialNumber

      public String getSerialNumber()

    • setUDN

      public void setUDN(String value)

    • getUDN

      public String getUDN()

    • hasUDN

      public boolean hasUDN()

    • setUPC

      public void setUPC(String value)

    • getUPC

      public String getUPC()

    • setPresentationURL

      public void setPresentationURL(String value)

    • getPresentationURL

      public String getPresentationURL()

    • removePresentationURL

      public boolean removePresentationURL()

    • setPresentationListener

      public void setPresentationListener(org.cybergarage.upnp.device.PresentationListener listener)

    • hasPresentationListener

      public boolean hasPresentationListener()

    • getPresentationListener

      public org.cybergarage.upnp.device.PresentationListener getPresentationListener()

    • getDeviceList

      public DeviceList getDeviceList()

    • isDevice

      public boolean isDevice(String name)

    • getDevice

      public Device getDevice(String name)

    • getDeviceByDescriptionURI

      public Device getDeviceByDescriptionURI(String uri)

    • getServiceList

      public ServiceList getServiceList()

    • getService

      public Service getService(String name)

    • getServiceBySCPDURL

      public Service getServiceBySCPDURL(String searchUrl)

    • getServiceByControlURL

      public Service getServiceByControlURL(String searchUrl)

    • getServiceByEventSubURL

      public Service getServiceByEventSubURL(String searchUrl)

    • getSubscriberService

      public Service getSubscriberService(String uuid)

    • getStateVariable

      public StateVariable getStateVariable(String serviceType, String name)

    • getStateVariable

      public StateVariable getStateVariable(String name)

    • getAction

      public Action getAction(String name)

    • isIconBytesURI

      public boolean isIconBytesURI(String uri)

    • getIconByURI

      public Icon getIconByURI(String uri)

    • addIcon

      public boolean addIcon(Icon icon)

    • getIconList

      public IconList getIconList()

    • getIcon

      public Icon getIcon(int n)

    • getSmallestIcon

      public Icon getSmallestIcon()

    • getLocationURL

      public String getLocationURL(String host)

    • notifyWait

      public static final void notifyWait()

    • announce

      public void announce(String bindAddr)

    • announce

      public void announce()

    • byebye

      public void byebye(String bindAddr)

    • byebye

      public void byebye()

    • postSearchResponse

      public boolean postSearchResponse(org.cybergarage.upnp.ssdp.SSDPPacket ssdpPacket, String st, String usn)

    • deviceSearchResponse

      public void deviceSearchResponse(org.cybergarage.upnp.ssdp.SSDPPacket ssdpPacket)

    • deviceSearchReceived

      public void deviceSearchReceived(org.cybergarage.upnp.ssdp.SSDPPacket ssdpPacket)
      Specified by:
      deviceSearchReceived in interface org.cybergarage.upnp.device.SearchListener

    • setHTTPPort

      public void setHTTPPort(int port)

    • getHTTPPort

      public int getHTTPPort()

    • setHTTPBindAddress

      public void setHTTPBindAddress(InetAddress[] inets)

    • getHTTPBindAddress

      public InetAddress[] getHTTPBindAddress()

    • getSSDPIPv4MulticastAddress

      public String getSSDPIPv4MulticastAddress()
      Returns:
      Since:
      1.8

    • getSSDPIPv4MulticastAddress

      public void getSSDPIPv4MulticastAddress(String ip)
      Parameters:
      ip -
      Since:
      1.8

    • getSSDPIPv6MulticastAddress

      public String getSSDPIPv6MulticastAddress()
      Returns:
      Since:
      1.8

    • getSSDPIPv6MulticastAddress

      public void getSSDPIPv6MulticastAddress(String ip)
      Parameters:
      ip -
      Since:
      1.8

    • httpRequestRecieved

      public void httpRequestRecieved(org.cybergarage.http.HTTPRequest httpReq)
      Specified by:
      httpRequestRecieved in interface org.cybergarage.http.HTTPRequestListener

    • setSSDPPort

      public void setSSDPPort(int port)
      Parameters:
      port - The port to use for binding the SSDP service

    • getSSDPPort

      public int getSSDPPort()
      Returns:
      The port to use for binding the SSDP service

    • setSSDPBindAddress

      public void setSSDPBindAddress(InetAddress[] inets)
      Parameters:
      inets - The IP that will be used for binding the SSDP service. Use null to get the default beahvior

    • getSSDPBindAddress

      public InetAddress[] getSSDPBindAddress()
      Returns:
      inets The IP that will be used for binding the SSDP service. null means the default setted by the class UPnP

    • setMulticastIPv4Address

      public void setMulticastIPv4Address(String ip)
      Parameters:
      ip - The IPv4 address used for Multicast comunication

    • getMulticastIPv4Address

      public String getMulticastIPv4Address()
      Returns:
      The IPv4 address used for Multicast comunication

    • setMulticastIPv6Address

      public void setMulticastIPv6Address(String ip)
      Parameters:
      ip - The IPv address used for Multicast comunication

    • getMulticastIPv6Address

      public String getMulticastIPv6Address()
      Returns:
      The IPv address used for Multicast comunication

    • start

      public boolean start()

    • stop

      public boolean stop()

    • isRunning

      public boolean isRunning()

    • getInterfaceAddress

      public String getInterfaceAddress()

    • setActionListener

      public void setActionListener(org.cybergarage.upnp.control.ActionListener listener)

    • setQueryListener

      public void setQueryListener(org.cybergarage.upnp.control.QueryListener listener)

    • setActionListener

      public void setActionListener(org.cybergarage.upnp.control.ActionListener listener, boolean includeSubDevices)

    • setQueryListener

      public void setQueryListener(org.cybergarage.upnp.control.QueryListener listener, boolean includeSubDevices)

    • setUserData

      public void setUserData(Object data)

    • getUserData

      public Object getUserData()