Class RootDevice


  • public class RootDevice
    extends Device
    Root UPNP device that is contained in a device definition file. Slightly differs from a simple UPNPDevice object. This object will contains all the child devices, this is the top objet in the UPNP device devices hierarchy.
    • Field Detail

      • specVersionMajor

        public final int specVersionMajor
      • specVersionMinor

        public final int specVersionMinor
      • deviceDefLoc

        public final java.net.URL deviceDefLoc
      • vendorFirmware

        public final java.lang.String vendorFirmware
      • discoveryUSN

        public final java.lang.String discoveryUSN
      • discoveryUDN

        public final java.lang.String discoveryUDN
    • Constructor Detail

      • RootDevice

        public RootDevice​(org.w3c.dom.Document doc,
                          java.net.URL urlBase,
                          java.lang.String maxAge,
                          java.net.URL deviceDefinition,
                          java.lang.String vendorFirmware,
                          java.lang.String discoveryUSN,
                          java.lang.String discoveryUDN)
                   throws java.lang.IllegalStateException,
                          javax.xml.xpath.XPathExpressionException
        Parameters:
        doc -
        urlBase -
        maxAge -
        deviceDefinition -
        vendorFirmware -
        discoveryUSN -
        discoveryUDN -
        Throws:
        java.lang.IllegalStateException
        javax.xml.xpath.XPathExpressionException
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.net.MalformedURLException
        Parameters:
        args -
        Throws:
        java.net.MalformedURLException
      • build

        public static RootDevice build​(java.net.URL deviceDef,
                                       java.lang.String maxAge,
                                       java.lang.String vendorFirmware,
                                       java.lang.String discoveryUSN,
                                       java.lang.String discoveryUDN)
        Parameters:
        deviceDef -
        maxAge -
        vendorFirmware -
        discoveryUSN -
        discoveryUDN -
        Returns:
        a new RootDevice, or null
      • getValidityTime

        public long getValidityTime()
        The validity time for this device in milliseconds,
        Returns:
        the number of milliseconds remaining before the device object that has been build is considered to be outdated, after this delay the UPNP device should resend an advertisement message or a negative value if the device is outdated
      • resetValidityTime

        public void resetValidityTime​(java.lang.String newMaxAge)
        Resets the device validity time
        Parameters:
        newMaxAge - the maximum age in secs of this UPNP device before considered to be outdated
      • getDeviceDefinitionXML

        public java.lang.String getDeviceDefinitionXML()
        Retrieves the device definition XML data
        Returns:
        the device definition XML data as a String