com.prosyst.mprm.backend.cutracker

Interface BackendControlUnitTracker

All Superinterfaces:

ControlUnitTracker

public interface BackendControlUnitTracker
extends ControlUnitTracker

Control Unit Tracker interface to the backend applications. Applications capable to provide control unit tracker templates use this service to add/remove tracked components. BackendControlUnitTracker is available as service in the backend frameworks.

Method Summary

Modifier and Type	Method and Description
TrackedControlUnit	addTrackedControlUnit(com.prosyst.mprm.backend.ms.cu.spi.ControlUnitState cuState) Adds control unit template to the tracker.
void	cleanTracks(java.lang.String cuType) Cleans all track records for given control unit type.
void	removeTrackedControlUnit(java.lang.String trackId) Removes tracked control unit from the tracker.

Methods inherited from interface com.prosyst.mprm.admin.cutracker.ControlUnitTracker

addTrackListener, getDistinctValues, getExtensionIds, getExtensions, getForeignValues, getForeignVariableNames, getTrackedControlUnit, getTrackedControlUnitIds, getTrackedControlUnits, getTrackedControlUnitTypes, getTrackedInterface, getTrackId, removeTrackListener

Method Detail

addTrackedControlUnit

TrackedControlUnit addTrackedControlUnit(com.prosyst.mprm.backend.ms.cu.spi.ControlUnitState cuState)
                                  throws ManagementException

Adds control unit template to the tracker. The control unit instance passed to this method may bear entire state of deployed control unit, but not only the tracked subset of the control unit state. It is responsibility of the system to determine the tracked state regarding the declared track interface for the corresponding control unit type. Another responsibility to the system is to detect whether such tracked state already exists in the tracker and to not duplicate the templates. It's ok for application to invoke this method for the same control units multiple times without considering existing entries - for example every time a component control unit is deployed on any target device.

Parameters:

cuState - control unit to added in the tracker.

Returns:

TrackedControlUnit object representing the system stored track.

Throws:

ManagementException

removeTrackedControlUnit

void removeTrackedControlUnit(java.lang.String trackId)
                       throws ManagementException

Removes tracked control unit from the tracker. Principally control unit templates should not exit from the tracker, but this method is meant to be used when converting old track interfaces by updated applications.

Parameters:

trackId - id of track record to be removed.

Throws:

ManagementException - if system error occurs.

cleanTracks

void cleanTracks(java.lang.String cuType)
          throws ManagementException

Cleans all track records for given control unit type.

Parameters:

cuType - control unit type for which track templates to be removed.

Throws:

ManagementException - if system error occurs.