net.sbbi.upnp.jmx
Interface UPNPDiscoveryMBean

All Superinterfaces:
javax.management.MBeanRegistration
All Known Implementing Classes:
UPNPDiscovery

public interface UPNPDiscoveryMBean
extends javax.management.MBeanRegistration

MBean to discover UPNP devices on the network and register the devices service as UPNPServiceMBean objects during the MBean registration. The registered UPNPServiceMBean will also be automatically unregistered when the device is leaving the network or when the UPNPDiscoveryMBean is unregistered from teh MBeans server.

Version:
1.0
Author:
SuperBonBon

Field Summary
static java.lang.String SSDP_ALIVE_NOTIFICATION
          Notification type for devices joining the network
static java.lang.String SSDP_BYEBYE_NOTIFICATION
          Notification type for devices leaving the network
 
Method Summary
 javax.management.ObjectName[] getRegisteredUPNPServiceMBeans(java.lang.String deviceUDN)
          Computes an array of object names of registered UPNPServiceMBeans for a given UPNP device UDN
 java.lang.String[] getRegisteredUPNPServiceMBeansUDNs()
          The list of registered devices UDN, the returned UDN can be used with the getRegisteredUPNPServiceMBeans(String deviceUDN) method to retreive UDN bound UPNPServiceMBean object names
 java.util.Set getSearchTargets()
          The registered devices search targets
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 

Field Detail

SSDP_ALIVE_NOTIFICATION

public static final java.lang.String SSDP_ALIVE_NOTIFICATION
Notification type for devices joining the network


SSDP_BYEBYE_NOTIFICATION

public static final java.lang.String SSDP_BYEBYE_NOTIFICATION
Notification type for devices leaving the network

Method Detail

getSearchTargets

public java.util.Set getSearchTargets()
The registered devices search targets

Returns:
a set of search targets

getRegisteredUPNPServiceMBeans

public javax.management.ObjectName[] getRegisteredUPNPServiceMBeans(java.lang.String deviceUDN)
                                                             throws javax.management.MalformedObjectNameException
Computes an array of object names of registered UPNPServiceMBeans for a given UPNP device UDN

Parameters:
deviceUDN - the UPNP device UDN ( unique id on the network )
Returns:
an array of object names or null if not matchs found for the given UDN
Throws:
javax.management.MalformedObjectNameException - if an object name cannot be computed for an UPNPServiceMBean

getRegisteredUPNPServiceMBeansUDNs

public java.lang.String[] getRegisteredUPNPServiceMBeansUDNs()
The list of registered devices UDN, the returned UDN can be used with the getRegisteredUPNPServiceMBeans(String deviceUDN) method to retreive UDN bound UPNPServiceMBean object names

Returns:
a string array of UDN or null if no UPNP device services registered as UPNPServiceMBean


Copyright © 2005 SuperBonBon Industries. All Rights Reserved.