com.prosyst.mprm.admin.cutracker

Interface ControlUnitTracker

All Known Subinterfaces:

BackendControlUnitTracker

public interface ControlUnitTracker

Administration service for monitoring the control unit tracker.

Method Summary

Modifier and Type	Method and Description
void	addTrackListener(java.lang.String eventFilter, TrackListener listener) Registers tracker listener to be notified for changes in the control unit tracker, i.e.
java.lang.Object[]	getDistinctValues(java.lang.String cuType, java.lang.String svName, java.lang.String filter, int maxCount) Returns up to maxCount distinct values of given state variable encountered in all track records of given cu type.
Enumerator	getExtensionIds(java.lang.String superTrackId, java.lang.String cuType, java.lang.String filter) Returns all track records for a given cu type, that are direct extensions if specified track record.
Enumerator	getExtensions(java.lang.String superTrackId, java.lang.String cuType, java.lang.String filter) Returns all track records for a given cu type, that are direct extensions if specified track record.
java.lang.Object[]	getForeignValues(java.lang.String trackId, java.lang.String foreignStateVariable) Returns all tracked values of given foreign state variable for given track record.
java.lang.String[]	getForeignVariableNames(java.lang.String controlUnitType) Returns the list of state variable ids declared as foreign state variables for given control unit type.
TrackedControlUnit	getTrackedControlUnit(java.lang.String trackId) Retrieves tracked control unit instance.
Enumerator	getTrackedControlUnitIds(java.lang.String cuType, java.lang.String filter) Lists ids of tracked control units of given control unit type and filtered by given criteria.
Enumerator	getTrackedControlUnits(java.lang.String cuType, java.lang.String filter) Lists tracked control units of given control unit type and filtered by given criteria.
java.lang.String[]	getTrackedControlUnitTypes() Returns types of control units kept in the tracker.
java.lang.String[]	getTrackedInterface(java.lang.String controlUnitType) Returns the list of state variables determining the track interface for given control unit type.
java.lang.String	getTrackId(TrackedControlUnit trackedUnit) Returns id of tracked control unit that matches a supplied control unit state.
void	removeTrackListener(TrackListener listener) Removes a track listener registration.

Method Detail

getTrackedControlUnitTypes

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

Returns types of control units kept in the tracker.

Returns:

control unit types

Throws:

ManagementException - if system error occurs.

getTrackedInterface

java.lang.String[] getTrackedInterface(java.lang.String controlUnitType)
                                throws ManagementException

Returns the list of state variables determining the track interface for given control unit type.

Parameters:

controlUnitType - control unit type

Returns:

names of state variables defining tracked interface.

Throws:

ManagementException - if system error occurs.

getTrackId

java.lang.String getTrackId(TrackedControlUnit trackedUnit)
                     throws ManagementException

Returns id of tracked control unit that matches a supplied control unit state. The given control unit could be a state representing deployed control unit instance. The system shall check if its unique sub state already exists in the tracker and shall return its track id.

Returns:

id of tracked control unit that matches the supplied state, or null if such record does not exist in the tracker.

Throws:

ManagementException - if system error occurs.

getTrackedControlUnits

Enumerator getTrackedControlUnits(java.lang.String cuType,
                                  java.lang.String filter)
                           throws ManagementException

Lists tracked control units of given control unit type and filtered by given criteria.

Parameters:

cuType - control unit type.

filter - filter in mPRM Script form.

Returns:

Enumerator of TrackedControlUnit objects.

Throws:

ManagementException - if system error occurs.

getTrackedControlUnitIds

Enumerator getTrackedControlUnitIds(java.lang.String cuType,
                                    java.lang.String filter)
                             throws ManagementException

Lists ids of tracked control units of given control unit type and filtered by given criteria.

Parameters:

cuType - control unit type

filter - filter in mPRM Script form.

Returns:

Enumerator of String objects represented track ids.

Throws:

ManagementException - if system error occurs.

getExtensions

Enumerator getExtensions(java.lang.String superTrackId,
                         java.lang.String cuType,
                         java.lang.String filter)
                  throws ManagementException

Returns all track records for a given cu type, that are direct extensions if specified track record. The given cuType must extend the control unit type of the record superTrackId. The hierarchy of track records derives from the control unit types hierarchy. When a track record enters the tracker, the system automatically enters super-records for every super-type of the entering track and links the record with its super-records. This method enumerates all extensions by given super track.

Parameters:

superTrackId - id of super track record.

cuType - control unit type of the listed extensions records.

filter - control unit filter in mPRM Script lexical syntax.

Returns:

Enumerator of TrackedControlUnit objects.

Throws:

ManagementException - if system error occurs.

getExtensionIds

Enumerator getExtensionIds(java.lang.String superTrackId,
                           java.lang.String cuType,
                           java.lang.String filter)
                    throws ManagementException

Returns all track records for a given cu type, that are direct extensions if specified track record. The given cuType must extend the control unit type of the record superTrackId. The hierarchy of track records derives from the control unit types hierarchy. When a track record enters the tracker, the system automatically enters super-records for every super-type of the entering track and links the record with its super-records. This method enumerates all extensions by given super track.

Parameters:

superTrackId - id of super track record.

cuType - control unit type of the listed extensions records.

filter - contorl unit filter in mPRM Script lexical syntax.

Returns:

Enumerator of track id strings.

Throws:

ManagementException - if system error occurs.

getTrackedControlUnit

TrackedControlUnit getTrackedControlUnit(java.lang.String trackId)
                                  throws ManagementException

Retrieves tracked control unit instance.

Parameters:

trackId - id of tracked control unit.

Returns:

TrackedControlUnit object.

Throws:

ManagementException - if system error occurs.

addTrackListener

void addTrackListener(java.lang.String eventFilter,
                      TrackListener listener)
               throws ManagementException

Registers tracker listener to be notified for changes in the control unit tracker, i.e. when tracked control units are added or removed to the tracker. Any previous registration for the given listener instance will be replaced with the current one.

Parameters:

eventFilter - filter specifying the tracked control units, the application listener is interested in. Filter must be given in mPRM Script filter form and may specify restrictions about the control unit types and/or participating state variables in the tracked interface.

listener - application implemented track listener.

Throws:

ManagementException - if system error occurs.

removeTrackListener

void removeTrackListener(TrackListener listener)

Removes a track listener registration.

Parameters:

listener - user-defined track listener.

getDistinctValues

java.lang.Object[] getDistinctValues(java.lang.String cuType,
                                     java.lang.String svName,
                                     java.lang.String filter,
                                     int maxCount)
                              throws ManagementException

Returns up to maxCount distinct values of given state variable encountered in all track records of given cu type. For example the bundle-category for OSGi bundles. The MC lists all different bundle categories and builds the tracker view to display bundles sorted in different categories.

Parameters:

cuType - control unit type.

svName - id of the state variable for which distinct values are requested.

filter - control unit filter in mPRM Script lexical form.

maxCount - limitation of distinct values count.

Returns:

array of distinct values encountered in the track records for the specified state variable.

Throws:

ManagementException - if system error occurs.

getForeignVariableNames

java.lang.String[] getForeignVariableNames(java.lang.String controlUnitType)
                                    throws ManagementException

Returns the list of state variable ids declared as foreign state variables for given control unit type.

Parameters:

controlUnitType - control unit type.

Returns:

list of state variable ids.

Throws:

ManagementException - if system error occurs.

getForeignValues

java.lang.Object[] getForeignValues(java.lang.String trackId,
                                    java.lang.String foreignStateVariable)
                             throws ManagementException

Returns all tracked values of given foreign state variable for given track record.

Parameters:

trackId - id of track record.

foreignStateVariable - id of foreign state variable.

Returns:

list of all values of the specified state variable for the specified track record.

Throws:

ManagementException - if system error occurs.