com.prosyst.mprm.admin.devices

Interface NodeOperations

All Known Subinterfaces:

DeviceGroup, DeviceNode, Node

public interface NodeOperations

Operations that can be executed over a Node or Group.

Method Summary

Modifier and Type	Method and Description
Operation	createControlUnits(java.lang.String cuType, java.lang.String deviceRootFilter, java.lang.String constructorId, java.lang.Object arguments) Starts an operation to perform a multiple creation of component control units.
Operation	destroyControlUnits(java.lang.String cuType, java.lang.String filter) Starts an operation to perform a global destruction of control units.
Operation	invokeAction(java.lang.String cuType, java.lang.String filter, java.lang.String actionID, java.lang.Object arguments) Starts an operation to invoke given action on a set of control units.
Operation	synchronizeStates(java.lang.String cuType, java.lang.String filter) Starts an operation to perform global synchronization of control unit state.

Method Detail

invokeAction

Operation invokeAction(java.lang.String cuType,
                       java.lang.String filter,
                       java.lang.String actionID,
                       java.lang.Object arguments)
                throws ManagementException

Starts an operation to invoke given action on a set of control units. If there are different versions of this control unit type provided, the action will be invoked only on control units with versions that provide this action with this interface. If there is no version providing the invoked action - exception will be thrown to indicate wrong arguments.

Parameters:

cuType - specifies type of control units on which the action to be invoked.

filter - mprm script criteria for filtering the set of control units on which the specified action to be invoked. Value of null may be supplied to skip the filtering restriction.

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:

Operation object for monitoring the action execution.

Throws:

ManagementException - if a system error occurs.

createControlUnits

Operation createControlUnits(java.lang.String cuType,
                             java.lang.String deviceRootFilter,
                             java.lang.String constructorId,
                             java.lang.Object arguments)
                      throws ManagementException

Starts an operation to perform a multiple creation of component control units. Example: installing bundle. If there are different versions of this control unit type provided, the constructor will be invoked only on device roots where the provided cuType version defines the given constructor with the given interface. If there is no version providing the invoked constructor - exception will be thrown to indicate wrong arguments.

Parameters:

cuType - specifies type of component control units for which the constructor to be invoked.

deviceRootFilter - script filter for filtering the devices on which specified control units to be created.

constructorId - contructor identifier

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

Returns:

Operation object for monitoring the operation.

Throws:

ManagementException - if a system error occurs.

destroyControlUnits

Operation destroyControlUnits(java.lang.String cuType,
                              java.lang.String filter)
                       throws ManagementException

Starts an operation to perform a global destruction of control units.

Parameters:

cuType - specifies type of control units to be unregistered/destroyed.

filter - script filter consists of the following parts:

• deviceRootFilter - script filter restricting the device roots the retrieved units should be components of. If the type parameter itself denotes device root control unit type, this part is ignored. Omitting this part of the filter would skip filtering the retrieved units by device root
• cuFilter - script criteria for filtering the retrieved control units.

Returns:

Operation object for monitoring the operation.

Throws:

ManagementException - if a system error occurs.

synchronizeStates

Operation synchronizeStates(java.lang.String cuType,
                            java.lang.String filter)
                     throws ManagementException

Starts an operation to perform global synchronization of control unit state.

Parameters:

cuType - specifies type of control units to be synchronized.

filter - script filter consists of the following parts:

• deviceRootFilter - script filter restricting the device roots the retrieved units should be components of. If the type parameter itself denotes device root control unit type, this part is ignored. Omitting this part of the filter would skip filtering the retrieved units by device root
• cuFilter - script criteria for filtering the retrieved control units.

Returns:

Operation object for monitoring the operation.

Throws:

ManagementException - if a system error occurs.