com.prosyst.mprm.backend.ms.commands.spi

Interface OperationManagementContext

public interface OperationManagementContext

This interface is granted to CommandInterpreter, ComponentControlUnitProvider and DeviceRootControlUnitProvider services to facilitate their implementation of command executions.

Method Summary

Modifier and Type	Method and Description
InterpretationResult	createInterpretationResult(java.lang.String operationId, java.lang.String deviceType, java.lang.String deviceId, java.lang.String commandId) Creates InterpretationResult instance for applying result of interpretation.
void	executionsInterrupted(java.lang.String deviceType, java.lang.String deviceId) Called to notify the system that device has interrupted any executions (for example because of going offline).
void	forceAllCommands(java.lang.String deviceType, java.lang.String deviceId, OperationPermanentOptions permanenetOptions) Forces the system to re-trigger all pending commands and to execute any permanent operations over the given device.
void	forcePendingCommands(java.lang.String deviceType, java.lang.String deviceId) Forces the system to re-initiate all pending commands of the provided types for the given device.
void	forcePermanentOperations(java.lang.String deviceType, java.lang.String deviceId, OperationPermanentOptions permanenetOptions) Forces the system to execute the permanent operations over the given device.
ControlUnitID[]	getControlUnits(java.lang.String deviceType, java.lang.String deviceId, java.lang.String controlUnitType, ControlUnitFilter filter) Performs filtered listing of control units of given type on given device.
boolean	match(ControlUnitID controlUnitId, ControlUnitFilter controlUnitFilter) Matches a control unit filter against a control unit.

Method Detail

getControlUnits

ControlUnitID[] getControlUnits(java.lang.String deviceType,
                                java.lang.String deviceId,
                                java.lang.String controlUnitType,
                                ControlUnitFilter filter)
                         throws ManagementException

Performs filtered listing of control units of given type on given device.

Parameters:

deviceType - device type.

deviceId - device id.

controlUnitType - control unit type.

filter - control unit filter.

Returns:

ids of control units that match the supplied filter.

Throws:

ManagementException

match

boolean match(ControlUnitID controlUnitId,
              ControlUnitFilter controlUnitFilter)
       throws ManagementException

Matches a control unit filter against a control unit.

Parameters:

controlUnitId - id of a control unit.

controlUnitFilter - control unit filter.

Returns:

true if the given control unit matches the filter, false otherwise.

Throws:

ManagementException

createInterpretationResult

InterpretationResult createInterpretationResult(java.lang.String operationId,
                                                java.lang.String deviceType,
                                                java.lang.String deviceId,
                                                java.lang.String commandId)
                                         throws ManagementException

Creates InterpretationResult instance for applying result of interpretation. The created InterpretationResult should be identical with the instance passed to the interpreter with the processCommand method by the four attributes: operationId (see InterpretationResult.getOperationId()), commandId(see InterpretationResult.getCommandId()()), deviceType & deviceId (passed to the processCommand method) . methods.

Parameters:

operationId - operation id.

deviceType - device type.

deviceId - device id.

commandId - command id/

Returns:

InterpretationResult instance for applying result of interpretation.

Throws:

ManagementException

forceAllCommands

void forceAllCommands(java.lang.String deviceType,
                      java.lang.String deviceId,
                      OperationPermanentOptions permanenetOptions)
               throws ManagementException

Forces the system to re-trigger all pending commands and to execute any permanent operations over the given device. Could be invoked instead of invoking separately forcePendingCommands(String, String) and forcePermanentOperations(String, String, OperationPermanentOptions). Besides, the system consolidates both types of executions in case permanent operations might intersect already pending commands, i.e., permanent operations may cancel old pending commands, or old pending commands may postpone a new trigger of a permanent operation. Any triggering of commands is done synchronously, i.e., commands are started before this method is finished.

Parameters:

deviceType - device type.

deviceId - device id.

Throws:

ManagementException

forcePendingCommands

void forcePendingCommands(java.lang.String deviceType,
                          java.lang.String deviceId)
                   throws ManagementException

Forces the system to re-initiate all pending commands of the provided types for the given device. Any triggering of commands is done synchronously, i.e., commands are started before this method is finished.

Parameters:

deviceType - device type.

deviceId - device id.

Throws:

ManagementException

forcePermanentOperations

void forcePermanentOperations(java.lang.String deviceType,
                              java.lang.String deviceId,
                              OperationPermanentOptions permanenetOptions)
                       throws ManagementException

Forces the system to execute the permanent operations over the given device. Any triggering of commands is done synchronously, i.e., commands are started before this method is finished.

Parameters:

deviceType - device type.

deviceId - device id.

permanenetOptions - operations with the supplied permanent options shall be affected.

Throws:

ManagementException

executionsInterrupted

void executionsInterrupted(java.lang.String deviceType,
                           java.lang.String deviceId)

Called to notify the system that device has interrupted any executions (for example because of going offline). On this call, the system shall remove all command waitings for this device from the pool of concurrent asynchronous executions, thus freeing room for other commands to be started. (See: InterpretationResult.setExecutionStarted())

Parameters:

deviceType - device type.

deviceId - device id.