com.prosyst.mprm.admin.devices.inventory

Interface Gateway

public interface Gateway

This interface abstracts a gateway through which FunctionalItemEx are connected to the mPRM.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_GATEWAY_ID Event property for the gateway ID from which event originated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addEventSubscription(org.osgi.service.event.EventHandler handler, java.lang.String[] topics, java.lang.String filter) Add subscription for Functional Item events.
void	addGatewayStateListener(GatewayStateListener listener) This method can be used to register listener which will be notified for changes in gateway online state.
void	close() Releases underlying resources used by this instance.
com.prosyst.mbs.services.fim.metadata.BeanMetadata	getBeanMetadata(java.lang.String className) Returns bean meta-data given a bean class name.
com.prosyst.mbs.services.fim.metadata.CreationMetadata	getCreationMetadata(java.lang.String className) Returns bean creation meta-data given a bean class name.
FunctionalItemEx	getFunctionalItem(java.lang.String uid) Returns functional item with given UID.
java.lang.String	getGatewayID() Returns the ID of the gateway, unique in the scope of the mPRM.
java.util.Collection<com.prosyst.mbs.services.fim.metadata.CreationMetadata>	getItemCreationMetadata(java.lang.String objectClass) Returns all item creation meta-data available through FunctionalItemFactory on this gateway.
com.prosyst.mbs.services.fim.metadata.CreationMetadata	getItemCreationMetadata(java.lang.String objectClass, java.lang.String factoryUID) Returns item creation meta-data for given class provided by the specified FunctionalItemFactory.
com.prosyst.mbs.services.fim.metadata.ItemMetadata	getItemMetadata(java.lang.String className) Returns meta-data for given functional item class on this gateway.
java.lang.Object	getProperty(java.lang.String functionalItemUID, java.lang.String property) Get value of given functional item's property.
java.lang.Object	invokeOperation(java.lang.String functionalItemUID, java.lang.String operation, java.lang.Object[] parameters) Execute operation on given functional item.
boolean	isOnline() Check if the gateway is currently connected to the mPRM.
<any>	listBeanTypes() List all available bean types' class names on this gateway.
<any>	listCreationTypes() List all available for creation bean types' class names on this gateway.
<any>	listFunctionalItems(java.lang.String objectClass, java.lang.String ldapFilter) List functional items matching given object class and LDAP filter.
<any>	listItemCreationMetadata() Returns creation meta-data IDs for all item types supported by functional item factories on this gateway.
<any>	listItemTypes() List all available item types' class names on this gateway.
void	removeEventSubscription(java.lang.String subscriptionID) Remove previously registered with addEventSubscription(EventHandler, String[], String) method subscription.
void	removeGatewayStateListener(GatewayStateListener listener) Unregister listener previously registered with addGatewayStateListener(GatewayStateListener) method.
void	setProperty(java.lang.String functionalItemUID, java.lang.String property, java.lang.Object value) Set property of given functional item.
void	synchronizeState() Synchronized functional items states from remote gateway.

Field Detail

PROPERTY_GATEWAY_ID

static final java.lang.String PROPERTY_GATEWAY_ID

Event property for the gateway ID from which event originated.

See Also:

Constant Field Values

Method Detail

close

void close()
    throws java.lang.Exception

Releases underlying resources used by this instance.

Throws:

java.lang.Exception - if system error occurs

getGatewayID

java.lang.String getGatewayID()

Returns the ID of the gateway, unique in the scope of the mPRM.

Returns:

gateway ID

isOnline

boolean isOnline()
          throws java.lang.Exception

Check if the gateway is currently connected to the mPRM.

Returns:

true if the gateway is currently connected to the mPRM, false - otherwise

Throws:

java.lang.Exception

listFunctionalItems

<any> listFunctionalItems(java.lang.String objectClass,
                          java.lang.String ldapFilter)
                   throws org.osgi.framework.InvalidSyntaxException

List functional items matching given object class and LDAP filter. If no filter and object class are given all functional items residing on the gateway will be returned. The following properties can be used in the LDAP filter: FunctionalItem.UID, FunctionalItem.TAGS, FunctionalItem.getAttributes() and Constants.OBJECTCLASS.

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

ldapFilter - LDAP filter or null

Returns:

matching functional items or null if none match

Throws:

org.osgi.framework.InvalidSyntaxException

getFunctionalItem

FunctionalItemEx getFunctionalItem(java.lang.String uid)
                            throws java.lang.Exception

Returns functional item with given UID. In contract with the functional items residing on the OSGi gateway, the returned object can not be cast to concrete interface (like Blinds, BinarySwitch, etc.). Instead the generic methods of FunctionalItemEx for operation execution and properties setting/getting should be used.

Parameters:

uid - functional item UID

Returns:

functional item with the given UID or null if functional item with the give UID is not found

Throws:

java.lang.Exception

invokeOperation

java.lang.Object invokeOperation(java.lang.String functionalItemUID,
                                 java.lang.String operation,
                                 java.lang.Object[] parameters)
                          throws java.lang.Exception

Execute operation on given functional item.

Parameters:

functionalItemUID - functional item UID

operation - operation name

parameters - input parameters

Returns:

operation result

Throws:

java.lang.Exception - if error occurs while executing the operation

setProperty

void setProperty(java.lang.String functionalItemUID,
                 java.lang.String property,
                 java.lang.Object value)
          throws java.lang.Exception

Set property of given functional item.

Parameters:

functionalItemUID - functional item UID

property - property name

value - property new value

Throws:

java.lang.Exception - if error occurs while setting property

getProperty

java.lang.Object getProperty(java.lang.String functionalItemUID,
                             java.lang.String property)
                      throws java.lang.Exception

Get value of given functional item's property.

Parameters:

functionalItemUID - functional item UID

property - property name

Returns:

property value

Throws:

java.lang.Exception - if error occurs while reading the property

addEventSubscription

java.lang.String addEventSubscription(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:

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(EventHandler, String[], String) method subscription.

Parameters:

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

Throws:

java.lang.Exception

getItemMetadata

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

Returns meta-data for given functional item class on this gateway.

Parameters:

className - class name

Returns:

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

Throws:

java.lang.Exception

getBeanMetadata

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

Returns bean meta-data given a bean class name.

Parameters:

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 - if system error occurs

getCreationMetadata

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

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

Parameters:

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 objectClass)
                                                                                              throws java.lang.Exception

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

Parameters:

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 objectClass,
                                                                               java.lang.String factoryUID)
                                                                        throws java.lang.Exception

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

Parameters:

objectClass - functional item object class

factoryUID - factory UID

Returns:

creation meta-data

Throws:

java.lang.Exception - if system error occurs

listItemCreationMetadata

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

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

Returns:

functional item creation meta-data IDs collection

Throws:

java.lang.Exception - if system error occurs

listItemTypes

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

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

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

listBeanTypes

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

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

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

listCreationTypes

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

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

Returns:

item types class names

Throws:

java.lang.Exception - if system error occurs

addGatewayStateListener

void addGatewayStateListener(GatewayStateListener listener)
                      throws java.lang.Exception

This method can be used to register listener which will be notified for changes in gateway online state. Use removeGatewayStateListener(GatewayStateListener) to unregister listener.

Parameters:

listener - gateway state listener

Throws:

ManagementException

java.lang.Exception

removeGatewayStateListener

void removeGatewayStateListener(GatewayStateListener listener)
                         throws java.lang.Exception

Unregister listener previously registered with addGatewayStateListener(GatewayStateListener) method.

Parameters:

listener - gateway state listener

Throws:

java.lang.Exception

synchronizeState

void synchronizeState()
               throws java.lang.Exception

Synchronized functional items states from remote gateway.

Throws:

java.lang.Exception - if error occurs