com.prosyst.mprm.admin.devices

Interface DeviceManager

public interface DeviceManager

Represents interface for remote management of devices in mPRM.

Method Summary

Modifier and Type	Method and Description
void	addNodeListener(java.lang.String nodePath, NodeListener listener) Adds listener, which will be notified about changes occurred in the specified node and in its direct members (if this node is a device group).
java.lang.String	createControlUnit(java.lang.String nodePath, java.lang.String controlUnitType, java.lang.String constructorId, java.lang.Object arguments) Explicitly creates control unit instance of a specified type using a supplied constructor and returns the id of the newly created control unit.
DynamicDeviceGroup	createDynamicDeviceGroup(java.lang.String name) Deprecated. use createDynamicDeviceGroup(String, String)
DynamicDeviceGroup	createDynamicDeviceGroup(java.lang.String name, java.lang.String baseNode) Creates a dynamic group with the specified name and base node
void	destroyControlUnit(ControlUnitID cuId) Unregisters / removes a control unit instance.
java.lang.String[]	getComponentTypes() Returns all component control unit types provided in mprm.
java.lang.String[]	getComponentTypes(java.lang.String deviceType) Returns all component control unit types provided in the scope of given deviceType.
java.lang.String[]	getComponentTypes(java.lang.String deviceType, boolean declaredTypesOnly) Returns all component control unit types provided in scope of the deviceType.
java.lang.String[]	getComponentTypes(java.lang.String deviceType, java.lang.String deviceId) Returns all component control unit types provided in the scope of particular device specified by the argument pair deviceType, deviceId
java.lang.String	getComponentVersion(java.lang.String type, java.lang.String deviceType, java.lang.String deviceId) Returns the version of a component control unit type provided on a specified device.
DeviceControlUnit	getControlUnit(ControlUnitID controlUnitId) Returns a specified control unit.
MetaTypeProvider	getControlUnitMetadata(java.lang.String cuType, java.lang.String cuVersion) Returns control unit metadata for the given control unit type and version.
MetaTypeProvider	getControlUnitMetadata(java.lang.String cuType, java.lang.String cuVersion, boolean aggregateSuperTypes) Returns control unit metadata for the given control unit type and version.
MetaTypeProvider	getControlUnitMetadata(java.lang.String cuType, java.lang.String cuVersion, java.lang.String extension) Returns control unit metadata extension for the given control unit type, version and extension key.
RemoteCUAdmin	getCUAdminToComponentsOf(java.lang.String deviceType, java.lang.String deviceId) Returns interface for managing the component control units in the scope of a given device.
ControlUnitProxy	getCUProxyToComponentsOf(java.lang.String deviceType, java.lang.String deviceId, RemoteControlUnitAdminApplication remoteApplication) Returns interface for managing the component units in the scope of a given device.
java.lang.String[]	getDeviceTypes() Returns device types in mprm tree.
java.lang.String[]	getDeviceTypes(java.lang.String componentType) Returns device types of a given component cu type.
java.lang.String[]	getDeviceTypes(java.lang.String componentType, boolean declaredTypesOnly) Returns device types if a given component cu type.
DynamicDeviceGroup	getDynamicDeviceGroup(java.lang.String name) Deprecated. use getDynamicDeviceGroup(String, String)
DynamicDeviceGroup	getDynamicDeviceGroup(java.lang.String name, java.lang.String baseNode) Gets a dynamic device group with the specified name and base node
java.lang.String[]	getExtendingTypes(java.lang.String controlUnitType, boolean directExtensionsOnly) Returns the extending types if given control unit type.
Node	getNode(java.lang.String path) Returns a Node object identified by the given path.
MetaTypeProvider[]	getNodePropertiesMetaData(java.lang.String deviceType) Returns the metadata for the build-in mPRM properties which can be assigned to a device tree node (group or device).
java.lang.String[]	getParentTypes(java.lang.String componentType) Returns types of the provided control units that may be parents of the control units with a given type.
DeviceGroup	getRoot() Returns the root device group of the devices tree.
java.lang.String[]	getSubTypes(java.lang.String componentType) Returns types of the provided control units that may be children of control units with a given type.
java.lang.String[]	getSuperTypes(java.lang.String controlUnitType, boolean directAncestorOnly) Returns the super types if given control unit type.
java.lang.String[]	getVersions(java.lang.String type) Returns all versions of given control unit type provided in mPRM.
java.lang.Object	invokeAction(ControlUnitID cuId, java.lang.String actionId, java.lang.Object arguments) Executes a given action over a given control unit.
boolean	isAbstract(java.lang.String controlUnitType) Specifies if given control unit type is abstract.
DynamicDeviceGroup[]	listDynamicDeviceGroups() Lists all dynamic device groups
void	moveDevice(ControlUnitID cuID, java.lang.String newParentPath) Moves the device, denoted by the cuID in a new mPRM Device Tree location, denoted by the newParentPath
void	registerControlUnitListener(java.lang.String nodePath, MPRMControlUnitListener l, java.util.Dictionary cuListenerProps) Registers a control unit listener.
void	registerHierarchyListener(java.lang.String nodePath, MPRMHierarchyListener l, java.util.Dictionary regProps) Registers a hierarchy listener.
void	registerStateVariableListener(java.lang.String nodePath, MPRMStateVariableListener l, java.util.Dictionary svListenerProps) Registers a state variable listener.
void	removeDynamicDeviceGroup(java.lang.String name) Deprecated. use removeDynamicDeviceGroup(String, String)
void	removeDynamicDeviceGroup(java.lang.String name, java.lang.String baseNode) Removes the dynamic group with the specified name and base node from the repository.
void	removeNodeListener(java.lang.String nodePath, NodeListener listener) Removes a node listener.
DeviceControlUnit	synchronizeState(ControlUnitID cuId) Synchronizes a control unit state with the target underlying resource.
void	unregisterControlUnitListener(MPRMControlUnitListener l) Unregisters a control unit listener.
void	unregisterHierarchyListener(MPRMHierarchyListener l) Unregisters a hierarchy listener.
void	unregisterStateVariableListener(MPRMStateVariableListener l) Unregisters a state variable listener.

Method Detail

getRoot

DeviceGroup getRoot()
             throws ManagementException

Returns the root device group of the devices tree.

Returns:

the top level group of the devices hierarchy.

Throws:

ManagementException - if a system error occurs.

getNode

Node getNode(java.lang.String path)
      throws ManagementException

Returns a Node object identified by the given path. If there is not device or group with a given path then null is returned.

Parameters:

path - path of the node in devices tree.

Returns:

device or group object represented by the supplied path.

Throws:

ManagementException - if a system error occurs.

getNodePropertiesMetaData

MetaTypeProvider[] getNodePropertiesMetaData(java.lang.String deviceType)
                                      throws ManagementException

Returns the metadata for the build-in mPRM properties which can be assigned to a device tree node (group or device). The set of properties which can be assigned to an arbitrary node is not restricted only to properties defined in the metadata. The purpose of metadata is to provide flexible mechanism for displaying editable properties by the UI management applications.

Returns:

array of MetaTypeProvider instances.

Throws:

ManagementException - if a system error occurs.

getDynamicDeviceGroup

DynamicDeviceGroup getDynamicDeviceGroup(java.lang.String name)
                                  throws ManagementException

Deprecated. use getDynamicDeviceGroup(String, String)

Gets a dynamic device group

Parameters:

name - name of the dynamic group

Returns:

DynamicDeviceGroup object representing the specified dynamic group, null if no group with this name exists.

Throws:

ManagementException - if an error occurs

getDynamicDeviceGroup

DynamicDeviceGroup getDynamicDeviceGroup(java.lang.String name,
                                         java.lang.String baseNode)
                                  throws ManagementException

Gets a dynamic device group with the specified name and base node

Parameters:

name - the dynamic group name

baseNode - the dynamic group base node

Returns:

DynamicDeviceGroup object representing the specified dynamic group, null if no group with this name and base node exists.

Throws:

ManagementException - if an error occurs

createDynamicDeviceGroup

DynamicDeviceGroup createDynamicDeviceGroup(java.lang.String name)
                                     throws ManagementException

Deprecated. use createDynamicDeviceGroup(String, String)

Creates a brand new dynamic group ( if such exists a management exception is thrown)

Parameters:

name - name of the dynamic group

Returns:

the newly constructed dynamic group

Throws:

ManagementException - if an error occurs

createDynamicDeviceGroup

DynamicDeviceGroup createDynamicDeviceGroup(java.lang.String name,
                                            java.lang.String baseNode)
                                     throws ManagementException

Creates a dynamic group with the specified name and base node

Parameters:

name - name of the dynamic device group

baseNode - the dynamic group base node

Returns:

the newly created dynamic group

Throws:

ManagementException - if a groups with the specified name and base node already exists or an error occurs

listDynamicDeviceGroups

DynamicDeviceGroup[] listDynamicDeviceGroups()
                                      throws ManagementException

Lists all dynamic device groups

Returns:

a list of all dynamic device groups. If there are no dynamic groups, an empty array of DynamicDeviceGroup objects is returned.

Throws:

ManagementException - if an error occurs

removeDynamicDeviceGroup

void removeDynamicDeviceGroup(java.lang.String name)
                       throws ManagementException

Deprecated. use removeDynamicDeviceGroup(String, String)

Removes all dynamic groups with the specified name from the repository. If no dynamic groups with the specified name are stored in repository, this method returns silently.

Parameters:

name - name which specifies the device group

Throws:

ManagementException - if an error occurs

removeDynamicDeviceGroup

void removeDynamicDeviceGroup(java.lang.String name,
                              java.lang.String baseNode)
                       throws ManagementException

Removes the dynamic group with the specified name and base node from the repository. If no dynamic group with this name and base node is stored in the repository, this method returns silently.

Parameters:

name - the dynamic group name

baseNode - the dynamic group base node

Throws:

ManagementException - if an error occurs

getDeviceTypes

java.lang.String[] getDeviceTypes()
                           throws ManagementException

Returns device types in mprm tree.

Returns:

array of string values indicating device types in the management tree.

Throws:

ManagementException - if a system error occurs.

getDeviceTypes

java.lang.String[] getDeviceTypes(java.lang.String componentType)
                           throws ManagementException

Returns device types of a given component cu type. Invoking this method is the same as invoking getDeviceTypes(String, boolean) with value false.

Parameters:

componentType - component control unit type

Returns:

array of string values indicating the possible device types of the given component control unit type.

Throws:

ManagementException - if a system error occurs.

getDeviceTypes

java.lang.String[] getDeviceTypes(java.lang.String componentType,
                                  boolean declaredTypesOnly)
                           throws ManagementException

Returns device types if a given component cu type.

Parameters:

componentType - componentType component control unit type

declaredTypesOnly - if true, the method shall return only the device types declared in the component type metadata. Otherwise, the method shall aggregate all extending types of the declared device types.

Returns:

array of string values indicating the possible device types of the given component control unit type.

Throws:

ManagementException - if a system error occurs.

getComponentTypes

java.lang.String[] getComponentTypes()
                              throws ManagementException

Returns all component control unit types provided in mprm.

Returns:

array of string values indicating the control unit types.

Throws:

ManagementException - if a system error occurs.

getComponentTypes

java.lang.String[] getComponentTypes(java.lang.String deviceType)
                              throws ManagementException

Returns all component control unit types provided in the scope of given deviceType. Invoking this method is the same as invoking getComponentTypes(String, boolean) with value false.

Parameters:

deviceType - device control unit type

Returns:

array of string values indicating the control unit types.

Throws:

ManagementException - if a system error occurs.

getComponentTypes

java.lang.String[] getComponentTypes(java.lang.String deviceType,
                                     java.lang.String deviceId)
                              throws ManagementException

Returns all component control unit types provided in the scope of particular device specified by the argument pair deviceType, deviceId

Parameters:

deviceType - device type.

deviceId - device id.

Returns:

array of string values indicating the control unit types.

Throws:

ManagementException - if a system error occurs.

getComponentTypes

java.lang.String[] getComponentTypes(java.lang.String deviceType,
                                     boolean declaredTypesOnly)
                              throws ManagementException

Returns all component control unit types provided in scope of the deviceType.

Parameters:

deviceType - device control unit type

declaredTypesOnly - if true, the method shall return only the component types that declare the given device type in their metadata. Otherwise, the method shall aggregate all declared components of the deviceType super types.

Returns:

array of string values indicating the control unit types.

Throws:

ManagementException - if a system error occurs.

getVersions

java.lang.String[] getVersions(java.lang.String type)
                        throws ManagementException

Returns all versions of given control unit type provided in mPRM. If the given type is a device type, the result string array will hold up to one element, since types of device root control units may have only one version provided.

Parameters:

type - control unit type

Returns:

array of string values indicating the provided versions.

Throws:

ManagementException - if a system error occurs.

getComponentVersion

java.lang.String getComponentVersion(java.lang.String type,
                                     java.lang.String deviceType,
                                     java.lang.String deviceId)
                              throws ManagementException

Returns the version of a component control unit type provided on a specified device. The arguments pair deviceType & deviceId define the target device, and the type argument defines the component type provided on this device. This method throws IllegalArgumentException if the component type is not provided on this device.

Parameters:

type - component control unit type.

deviceType - device type.

deviceId - device id.

Returns:

control unit type version.

Throws:

ManagementException - if system error occurs.

java.lang.IllegalArgumentException - if the specified component type is not provided on the specified device.

getParentTypes

java.lang.String[] getParentTypes(java.lang.String componentType)
                           throws ManagementException

Returns types of the provided control units that may be parents of the control units with a given type.

Parameters:

componentType - sub control unit type

Returns:

array of string values indicating the parent control unit types.

Throws:

ManagementException - if a system error occurs.

getSubTypes

java.lang.String[] getSubTypes(java.lang.String componentType)
                        throws ManagementException

Returns types of the provided control units that may be children of control units with a given type.

Parameters:

componentType - parent control unit type

Returns:

array of string values indicating the child control unit types.

Throws:

ManagementException - if a system error occurs.

isAbstract

boolean isAbstract(java.lang.String controlUnitType)
            throws ManagementException

Specifies if given control unit type is abstract.

Parameters:

controlUnitType - control unit type

Returns:

true if the control unit type is abstract, false otherwise.

Throws:

ManagementException - if a system error occurs.

getSuperTypes

java.lang.String[] getSuperTypes(java.lang.String controlUnitType,
                                 boolean directAncestorOnly)
                          throws ManagementException

Returns the super types if given control unit type.

Parameters:

controlUnitType - control unit type.

directAncestorOnly - boolean flag specifying whether direct ancestors to be returned (value of true) or all ancestors (value of false).

Returns:

list of super control unit types.

Throws:

ManagementException - if system error occurs.

getExtendingTypes

java.lang.String[] getExtendingTypes(java.lang.String controlUnitType,
                                     boolean directExtensionsOnly)
                              throws ManagementException

Returns the extending types if given control unit type.

Parameters:

controlUnitType - control unit type.

directExtensionsOnly - boolean flag specifying whether direct extensions to be returned (value of true) or all extensions (value of false).

Returns:

list of extending control unit types.

Throws:

ManagementException - if system error occurs.

getControlUnitMetadata

MetaTypeProvider getControlUnitMetadata(java.lang.String cuType,
                                        java.lang.String cuVersion)
                                 throws ManagementException

Returns control unit metadata for the given control unit type and version. Invoking this method is the same as invoking getControlUnitMetadata(String, String, boolean) with parameter aggregateSuperTypes set to true.

Parameters:

cuType - control unit type

cuVersion - version of the control unit type

Returns:

MetaTypeProvider object representing the metadata.

Throws:

ManagementException - if a system error occurs.

getControlUnitMetadata

MetaTypeProvider getControlUnitMetadata(java.lang.String cuType,
                                        java.lang.String cuVersion,
                                        boolean aggregateSuperTypes)
                                 throws ManagementException

Returns control unit metadata for the given control unit type and version. With this method applications could specify whether to retrieve pure metadata for the control unit type, or metadata to be merged with the metadatas of all super control unit types.

Parameters:

cuType - control unit type

cuVersion - version of the control unit type

aggregateSuperTypes - if true the retrieved metadata will be merged with the metdatas of all super control unit types, otherwise, pure metatype for the control unit type will be returned.

Returns:

MetaTypeProvider object representing the metadata.

Throws:

ManagementException - if a system error occurs.

getControlUnitMetadata

MetaTypeProvider getControlUnitMetadata(java.lang.String cuType,
                                        java.lang.String cuVersion,
                                        java.lang.String extension)
                                 throws ManagementException

Returns control unit metadata extension for the given control unit type, version and extension key.

Parameters:

cuType - control unit type

cuVersion - version of the control unit type

extension - metatype extension key

Returns:

MetaTypeProvider object representing the metadata.

Throws:

ManagementException - if a system error occurs.

getControlUnit

DeviceControlUnit getControlUnit(ControlUnitID controlUnitId)
                          throws ManagementException

Returns a specified control unit.

Parameters:

controlUnitId - ControlUnitID defining the target control unit to be retrieved.

Returns:

DeviceControlUnit object if controlUnitId denotes a component control unit, DeviceNode object if controlUnitId denotes a device root control unit and null if there is no such control unit.

Throws:

ManagementException - if a system error occurs.

getCUAdminToComponentsOf

RemoteCUAdmin getCUAdminToComponentsOf(java.lang.String deviceType,
                                       java.lang.String deviceId)
                                throws ManagementException

Returns interface for managing the component control units in the scope of a given device.

Parameters:

deviceType - device type.

deviceId - device id.

Returns:

RemoteCUAdmin interface for administering the component control units in the scope of a given device.

Throws:

ManagementException - if a system error occurs.

getCUProxyToComponentsOf

ControlUnitProxy getCUProxyToComponentsOf(java.lang.String deviceType,
                                          java.lang.String deviceId,
                                          RemoteControlUnitAdminApplication remoteApplication)
                                   throws ManagementException

Returns interface for managing the component units in the scope of a given device.

Parameters:

deviceType - device type.

deviceId - device id.

remoteApplication - user-implemented call back object

Returns:

ControlUnitProxy interface for administering the component control units in the scope of a given device.

Throws:

ManagementException - if a system error occurs.

createControlUnit

java.lang.String createControlUnit(java.lang.String nodePath,
                                   java.lang.String controlUnitType,
                                   java.lang.String constructorId,
                                   java.lang.Object arguments)
                            throws java.lang.Exception

Explicitly creates control unit instance of a specified type using a supplied constructor and returns the id of the newly created control unit.

Parameters:

nodePath - denotes parent path in the mPRM management tree if a new device is supposed to be registered with mPRM and respective device root control unit to be created, or denotes node path of the device node if a component control unit belonging to particular device should be created.

controlUnitType - the type of the Control Unit.

constructorId - the id of the constructors. Must start with "$create.".

arguments - the 'constructors' argument(s). If the argument is only one this is the argument itself. If the arguments are more then one, the value must be a Object[] and arguments are retrieved from that array.

Returns:

id of the newly created control unit.
Note: Applying ids of new control units is not mandatory for device control unit providers, so this method may return null if it is not convenient for the device provider to return id of newly registered device.

Throws:

java.lang.Exception - if an error occurs while creating Control Unit.

destroyControlUnit

void destroyControlUnit(ControlUnitID cuId)
                 throws java.lang.Exception

Unregisters / removes a control unit instance. If control unit is a device root, the device will simply be unregistered from mPRM. If it is a component - its destructor will be invoked.

Parameters:

cuId - ControlUnitID defining the target control unit to be destroyed.

Throws:

java.lang.Exception - if an error occurs while destroying the Control Unit.

synchronizeState

DeviceControlUnit synchronizeState(ControlUnitID cuId)
                            throws java.lang.Exception

Synchronizes a control unit state with the target underlying resource.

Parameters:

cuId - id of control unit to be synchronized.

Throws:

java.lang.Exception - if an error occurs while synchronizing the Control Unit.

invokeAction

java.lang.Object invokeAction(ControlUnitID cuId,
                              java.lang.String actionId,
                              java.lang.Object arguments)
                       throws java.lang.Exception

Executes a given action over a given control unit.

Parameters:

cuId - ControlUnitID defining the target control unit the action to be invoked on.

actionId - id of the action

arguments - the input argument(s). If the argument is only one this is the argument itself. If the arguments are more then one, the value must be a Object[] and arguments are retrieved from that array.

Returns:

the output argument(s) or null if the action does not return value.

Throws:

java.lang.Exception - if an error occurs while executing action.

registerControlUnitListener

void registerControlUnitListener(java.lang.String nodePath,
                                 MPRMControlUnitListener l,
                                 java.util.Dictionary cuListenerProps)
                          throws ManagementException

Registers a control unit listener.

Parameters:

nodePath - scope in the mprm management tree. Only events for control units in the given scope will be delivered.

l - application defined MPRMControlUnitListener object.

cuListenerProps - defines event listener properties. A listener property may be used as a filter to limit the number of received events and to specify certain control unit to listen for. The key of the property is ControlConstants.EVENT_FILTER with value of type String representing LDAP filtering expression. The properties which may be used in the LDAP filer are:

• ControlConstants.EVENT_TYPE- to limit the types of events received by the listener. Valid values are ControlUnitEvent.CONTROL_UNIT_ADDED, ControlUnitEvent.CONTROL_UNIT_REMOVED, ControlUnitEvent.CONTROL_UNIT_TYPE_APPEARED and ControlUnitEvent.CONTROL_UNIT_TYPE_DISAPPEARED,
• ControlConstants.TYPE and
• ControlConstants.ID. The filter states what types of events, and events for which units to be received. The listener will be notified only for events regarding Control Units whose id and type satisfies this filter, if the events match the event filtering criterion. If property ControlConstants.EVENT_FILTER does not present, the listener will receive events for all control units.
  In addition, the registration may contain arbitrary properties that are not considered by the GDM System, but will be applied to the underlying event-listener registration in the mPRM Event Service. This means that applying listener properties defined by the mPRM Event Service will also take effect for the control unit listener registration. For example host filter could be applied in order to receive control unit events originated from the local backend host or from remote hosts only.
  

Throws:

ManagementException - if a system error occurs.

unregisterControlUnitListener

void unregisterControlUnitListener(MPRMControlUnitListener l)

Unregisters a control unit listener.

Parameters:

l - application defined MPRMControlUnitListener object

registerStateVariableListener

void registerStateVariableListener(java.lang.String nodePath,
                                   MPRMStateVariableListener l,
                                   java.util.Dictionary svListenerProps)
                            throws ManagementException

Registers a state variable listener.

Parameters:

nodePath - scope in the mprm management tree. Only events for control units in the given scope will be delivered.

l - application defined MPRMStateVariableListener object.

svListenerProps - defines event listener properties. A listener property may be used as a filter to limit the number of received events and to specify certain control unit and/or state variables to listen for. The key of this property is ControlConstants.EVENT_FILTER with value of type String representing LDAP filtering expression. The properties which may be used in the LDAP filer are:

• ControlConstants.TYPE
• ControlConstants.ID and
• ControlConstants.STATE_VARIABLE_ID The listener will be notified only for changes in the value of the state variables whose id and type of the corresponding control unit satisfies this filter. If property ControlConstants.EVENT_FILTER is not present, the listener will receive events for changing of all state variables.
  In addition, the registration may contain arbitrary properties that are not considered by the GDM System, but will be applied to the underlying event-listener registration in the mPRM Event Service. This means that applying listener properties defined by the mPRM Event Service will also take effect for the state variable listener registration. For example host filter could be applied in order to receive state variable events originated from the local backend host or from remote hosts only.
  

Throws:

ManagementException - if a system error occurs.

unregisterStateVariableListener

void unregisterStateVariableListener(MPRMStateVariableListener l)

Unregisters a state variable listener.

Parameters:

l - application defined MPRMStateVariableListener object

registerHierarchyListener

void registerHierarchyListener(java.lang.String nodePath,
                               MPRMHierarchyListener l,
                               java.util.Dictionary regProps)
                        throws ManagementException

Registers a hierarchy listener.

Parameters:

nodePath - scope in the mprm management tree. Only events for control units in the given scope will be delivered.

l - application defined MPRMHierarchyListener object.

regProps - defines event listener properties. A listener property may be used as a filter to limit the number of received events and to specify certain control unit and/or event types to listen for. The key of this property is ControlConstants.EVENT_FILTER with value of type String representing LDAP filtering expression. The properties which may be used in the LDAP filer are :

• ControlConstants.EVENT_TYPE - to limit the types of events received by the listener. Valid values are HierarchyEvent.ATTACHED and HierarchyEvent.DETACHED.
• ControlConstants.TYPE and ControlConstants.ID are used to limit events based on the child control units to which the events are relevant.
  In addition, the registration may contain arbitrary properties that are not considered by the GDM System, but will be applied to the underlying event-listener registration in the mPRM Event Service. This means that applying listener properties defined by the mPRM Event Service will also take effect for the hierarchy listener registration. For example host filter could be applied in order to receive hierarchy events originated from the local backend host or from remote hosts only.

Throws:

ManagementException - if a system error occurs.

unregisterHierarchyListener

void unregisterHierarchyListener(MPRMHierarchyListener l)

Unregisters a hierarchy listener.

Parameters:

l - application defined MPRMHierarchyListener object.

addNodeListener

void addNodeListener(java.lang.String nodePath,
                     NodeListener listener)
              throws ManagementException

Adds listener, which will be notified about changes occurred in the specified node and in its direct members (if this node is a device group).

Parameters:

nodePath - node path specifying the node on which a listener to be added.

listener - user-defined listener.

Throws:

ManagementException - if system error occurs.

removeNodeListener

void removeNodeListener(java.lang.String nodePath,
                        NodeListener listener)

Removes a node listener.

Parameters:

nodePath - node path specifying the node on which a listener to be removed.

listener - user-defined listener.

moveDevice

void moveDevice(ControlUnitID cuID,
                java.lang.String newParentPath)
         throws ManagementException

Moves the device, denoted by the cuID in a new mPRM Device Tree location, denoted by the newParentPath

Parameters:

cuID - control unit identifier

newParentPath - new the path in the Device Tree

Throws:

ManagementException - if a system error occurs