com.prosyst.mprm.admin.devices.inventory

Interface DeviceInventory

public interface DeviceInventory

This interface (available as service on the mPRM) provides access to FunctionalItems connected to the mPRM and the Gateways through which they are connected.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addEventSubscription(java.lang.String gatewayID, org.osgi.service.event.EventHandler handler, java.lang.String[] topics, java.lang.String filter) Add subscription for Functional Item events.
java.lang.String	addGlobalEventSubscription(java.lang.String nodePath, org.osgi.service.event.EventHandler handler, java.lang.String[] topics, java.lang.String filter) Add subscription for Functional Item events.
com.prosyst.mbs.services.fim.metadata.BeanMetadata	getBeanMetadata(java.lang.String gatewayID, java.lang.String className) Returns bean meta-data given a bean class name.
com.prosyst.mbs.services.fim.metadata.CreationMetadata	getCreationMetadata(java.lang.String gatewayID, java.lang.String className) Returns bean creation meta-data given a bean class name.
FunctionalItemEx	getFunctionalItem(FunctionalItemGUID guid) Returns the functional item with the given GUID or null if such functional item is not found.
Gateway	getGateway(java.lang.String gatewayID) Get gateway with given ID.
java.util.Collection<com.prosyst.mbs.services.fim.metadata.CreationMetadata>	getItemCreationMetadata(java.lang.String gatewayID, java.lang.String objectClass) Returns all item creation meta-data available through FunctionalItemFactory on the given gateway.
com.prosyst.mbs.services.fim.metadata.CreationMetadata	getItemCreationMetadata(java.lang.String gatewayID, java.lang.String objectClass, java.lang.String factoryUID) Returns item creation meta-data for given class provided by the specified FunctionalItemFactory on the given gateway.
com.prosyst.mbs.services.fim.metadata.ItemMetadata	getItemMetadata(java.lang.String gatewayID, java.lang.String className) Returns meta-data for given functional item class.
boolean	isItemType(java.lang.String className) Check if given class name corresponds to a known Functional Item type.
<any>	listBeanTypes(java.lang.String gatewayID) List all available bean types' class names on given gateway.
<any>	listCreationTypes(java.lang.String gatewayID) List all available for creation bean types' class names on given gateway.
<any>	listFunctionalItems(java.lang.String objectClass, java.lang.String filter) List functional items connected to the mPRM.
<any>	listFunctionalItemStates(java.lang.String objectClass, java.lang.String filter) Similar to {listFunctionalItems(String, String), but returns FunctionalItemEx instances, instead of IDs.
<any>	listGateways(java.lang.String filter) List IDs of gateways connected to the mPRM.
<any>	listItemCreationMetadata(java.lang.String gatewayID) Returns creation meta-data IDs for all item types supported by functional item factories on the given gateway.
<any>	listItemTypes(java.lang.String gatewayID) List all available item types' class names on given gateway.
void	removeEventSubscription(java.lang.String subscriptionID) Remove previously registered with addEventSubscription(String, EventHandler, String[], String) method subscription.

Method Detail

listGateways

<any> listGateways(java.lang.String filter)
            throws ManagementException

List IDs of gateways connected to the mPRM. Optional control unit filter can be used to limit the amount of gateways returned. The returned IDs can be used as parameters to the {getGateway(String) method.

Parameters:

filter - control unit filter or null, if all connected gateways should be returned

Returns:

enumerator of gateway IDs

Throws:

ManagementException - if system error occurs

getGateway

Gateway getGateway(java.lang.String gatewayID)
            throws ManagementException

Get gateway with given ID.

Parameters:

gatewayID - gateway ID

Returns:

gateway of null, if gateway with the given ID is not found

Throws:

ManagementException - if system error occurs

listFunctionalItems

<any> listFunctionalItems(java.lang.String objectClass,
                          java.lang.String filter)
                   throws ManagementException

List functional items connected to the mPRM. Optional object class name and filter can be used to limit the amount device IDs returned.

Parameters:

objectClass - fully qualified object class name (for example "com.prosyst.mbs.services.hdm.HomeDevice"), or null if functional items from all classes should be returned

filter - control unit or LDAP filter or null, if all connected functional items should be returned

Returns:

FunctionalItemGUIDs of connected FunctionalItemEx

Throws:

ManagementException - if system error occurs

listFunctionalItemStates

<any> listFunctionalItemStates(java.lang.String objectClass,
                               java.lang.String filter)
                        throws ManagementException

Similar to {listFunctionalItems(String, String), but returns FunctionalItemEx instances, instead of IDs.

Parameters:

objectClass - fully qualified object class name (for example "com.prosyst.mbs.services.hdm.HomeDevice"), or null if functional items from all classes should be returned

filter - control unit or LDAP filter or null, if all connected functional items should be returned

Returns:

enumeration of FunctionalItemEx objects

Throws:

ManagementException - is system error occurs

getFunctionalItem

FunctionalItemEx getFunctionalItem(FunctionalItemGUID guid)
                            throws ManagementException

Returns the functional item with the given GUID or null if such functional item is not found.

Parameters:

guid - functional item GUID

Returns:

functional item with the given GUID or null if not found

Throws:

ManagementException - if system error occurs

getItemMetadata

com.prosyst.mbs.services.fim.metadata.ItemMetadata getItemMetadata(java.lang.String gatewayID,
                                                                   java.lang.String className)
                                                            throws java.lang.Exception

Returns meta-data for given functional item class.

Parameters:

gatewayID - id of the gateway from which the item meta-data is requested or null for back-end functional item meta-data

className - class name

Returns:

item meta-data or null if the given item class is not found on this gateway

Throws:

ManagementException - is system error occurs

java.lang.Exception

getBeanMetadata

com.prosyst.mbs.services.fim.metadata.BeanMetadata getBeanMetadata(java.lang.String gatewayID,
                                                                   java.lang.String className)
                                                            throws java.lang.Exception

Returns bean meta-data given a bean class name.

Parameters:

gatewayID - id of the gateway from which the bean meta-data is requested or null for back-end bean meta-data

className - bean class name

Returns:

bean meta-data or null if the given bean class is not found on this gateway

Throws:

java.lang.Exception

getCreationMetadata

com.prosyst.mbs.services.fim.metadata.CreationMetadata getCreationMetadata(java.lang.String gatewayID,
                                                                           java.lang.String className)
                                                                    throws java.lang.Exception

Returns bean creation meta-data given a bean class name.

Parameters:

gatewayID - id of the gateway from which the creation meta-data is requested or null for back-end creation meta-data

className - the bean class name which fields meta-data is requested.

Returns:

creation meta-data or null if the given bean class is not found on this gateway

Throws:

java.lang.Exception - if system error occurs

getItemCreationMetadata

java.util.Collection<com.prosyst.mbs.services.fim.metadata.CreationMetadata> getItemCreationMetadata(java.lang.String gatewayID,
                                                                                                     java.lang.String objectClass)
                                                                                              throws java.lang.Exception

Returns all item creation meta-data available through FunctionalItemFactory on the given gateway.

Parameters:

gatewayID - gateway ID

objectClass - functional item object class

Returns:

item creation meta-data collection

Throws:

java.lang.Exception - if system error occurs

getItemCreationMetadata

com.prosyst.mbs.services.fim.metadata.CreationMetadata getItemCreationMetadata(java.lang.String gatewayID,
                                                                               java.lang.String objectClass,
                                                                               java.lang.String factoryUID)
                                                                        throws java.lang.Exception

Returns item creation meta-data for given class provided by the specified FunctionalItemFactory on the given gateway.

Parameters:

gatewayID - gateway ID

objectClass - functional item object class

factoryUID - factory UID

Returns:

creation meta-data

Throws:

java.lang.Exception - if system error occurs

listItemCreationMetadata

<any> listItemCreationMetadata(java.lang.String gatewayID)
                        throws java.lang.Exception

Returns creation meta-data IDs for all item types supported by functional item factories on the given gateway.

Parameters:

gatewayID - id of the gateway for which item creation meta-data is requested

Returns:

functional item creation meta-data IDs collection

Throws:

java.lang.Exception - if system error occurs

listItemTypes

<any> listItemTypes(java.lang.String gatewayID)
             throws java.lang.Exception

List all available item types' class names on given gateway. The returned class names can be used to get the corresponding meta-data using the getItemMetadata(String, String) method.

Parameters:

gatewayID - id of the gateway for which item types are requested or null for back-end types

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

listBeanTypes

<any> listBeanTypes(java.lang.String gatewayID)
             throws java.lang.Exception

List all available bean types' class names on given gateway. The returned class names can be used to get the corresponding meta-data using the getBeanMetadata(String, String) method.

Parameters:

gatewayID - id of the gateway for which item types are requested or null for back-end types

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

listCreationTypes

<any> listCreationTypes(java.lang.String gatewayID)
                 throws java.lang.Exception

List all available for creation bean types' class names on given gateway. The returned class names can be used to get the corresponding meta-data using the getCreationMetadata(String, String) method.

Parameters:

gatewayID - id of the gateway for which item types are requested or null for back-end types

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

isItemType

boolean isItemType(java.lang.String className)
            throws java.lang.Exception

Check if given class name corresponds to a known Functional Item type.

Parameters:

className - class name

Returns:

true if the given class name is a Functional Item type, false - otherwise

Throws:

java.lang.Exception - if system error occurs

addEventSubscription

java.lang.String addEventSubscription(java.lang.String gatewayID,
                                      org.osgi.service.event.EventHandler handler,
                                      java.lang.String[] topics,
                                      java.lang.String filter)
                               throws java.lang.Exception

Add subscription for Functional Item events.

Parameters:

gatewayID - gateway from which events should be received. If null is passed events from all gateways will be received.

handler - event handler which will receive the events

topics - list of topics in which the handler is interested. The topics defined in FunctionalItemEventConstants should be used.

filter - LDAP filter to further select events of interest to a Event Handler service

Returns:

subscription ID, which can be used in removeEventSubscription(String) to remove the subscription

Throws:

java.lang.Exception

addGlobalEventSubscription

java.lang.String addGlobalEventSubscription(java.lang.String nodePath,
                                            org.osgi.service.event.EventHandler handler,
                                            java.lang.String[] topics,
                                            java.lang.String filter)
                                     throws java.lang.Exception

Add subscription for Functional Item events.

Parameters:

nodePath - the node location of the device subtree tree in which the handler is interested.

handler - event handler which will receive the events

topics - list of topics in which the handler is interested. The topics defined in FunctionalItemEventConstants should be used.

filter - LDAP filter to further select events of interest to a Event Handler service

Returns:

subscription ID, which can be used in removeEventSubscription(String) to remove the subscription

Throws:

java.lang.Exception

removeEventSubscription

void removeEventSubscription(java.lang.String subscriptionID)
                      throws java.lang.Exception

Remove previously registered with addEventSubscription(String, EventHandler, String[], String) method subscription.

Parameters:

subscriptionID - subscription ID returned by the addEventSubscription(String, EventHandler, String[], String) method.

Throws:

java.lang.Exception