The available plugin methods, including description of how the default plugin class implements each method, are:
java.lang.String
getScadaPointId(MspObject obj)
This method is used to extract SCADA Point ID from the incoming MultiSpeak message.
Returns value of the objectID attribute if not empty, otherwise value of the objectName element
java.lang.String
getScadaPointId(ScadaTag tag)
This method is used to extract SCADA Point ID from the incoming tag-related MultiSpeak message.
Returns value of the scadaPointID element
StatusIdentifiers
getStatus(final ScadaStatus status);
This method is used to extract device status value from the MultiSpeak device status update message.
status - ScadaStatus object
MultiSpeak device status value
Returns value of the status element.
java.util.List<java.lang.String>
getQualityCodes(ScadaStatus status)
This method is used to extract quality values from MultiSpeak status update message.
status - ScadaStatus object
list of MultiSpeak quality values
Returns value of the quality element
java.util.List<java.lang.String>
getQualityCodes(ScadaAnalog analog)
This method is used to extract quality values from MultiSpeak analog update message.
analog - ScadaAnalog object
list of MultiSpeak quality values
Returns value of the quality element
int
processChangeCounter(StatusPoint point, int changeCounter)
This method is used to process SCADA change counter value.
point - SCADA status point
changeCounter - new change counter value for the SCADA status point
Number of device operations, which occurred since the last processed update
Assumes that change counter value received from SCADA is cumulative (total number of times device has changed state since some point in the past). Number of device operations is calculated as the difference between previous and current SCADA change counter values
java.lang.String
getTagId(ScadaTag tag)
This method is used to extract value from the tag update message, which is then used to populate external id of the corresponding condition in NMS. This value has to uniquely identify the tag in NMS.
Returns value of the objectID attribute
void
setTagId(ScadaTag tag, java.lang.String tagId)
This method is used during synchronization process to set tag id value in the tag update message, which is later extracted by the getTagId method.
tag - ScadaTag object to be updated
Sets value of objectID attribute
java.lang.String
getTagType(ScadaTag tag)
This method is used to extract SCADA tag type from tag update message. This value is then used to determine corresponding NMS condition class.
Returns value of the tagType element
java.util.Map<java.lang.String,java.lang.Object>
getTagData(ScadaTag tag)
This method is used to extract additional tag data fields from tag message.
Map <tag field name -> tag field value>
Returns map with a single entry ('text', value of the tagReason element)
java.lang.String
getUserName(ScadaTag tag)
Extracts operator username from tag update message.
Returns value of the userName element
Action
getAction(ScadaTag tag)
This method is used to extract action from tag update message. Action determines if the request is to place a new tag, update an existing tag or remove an existing tag.
•
|
CHANGE - update an existing tag
|
•
|
DELETE - delete an existing tag
|
Returns value of the verb attribute
void
setAction(ScadaTag tag, Action action)
This method is used during synchronization process to set action value in the tag update message, which is later extracted by the getAction method.
tag - ScadaTag object to be updated
•
|
CHANGE - update an existing tag
|
•
|
DELETE - delete an existing tag
|
Sets value of the verb attribute
java.lang.String
buildScadaPointId(com.splwg.oms.common.intersys.Handle nmsDeviceHandle, java.lang.String nmsDeviceAlias, int phase)
throws java.lang.IllegalArgumentException
This method is used to construct SCADA point id for status of an NMS device.
nmsDeviceHandle - NMS device handle
nmsDeviceAlias - NMS device alias
SCADA point id or null if not supported
java.lang.IllegalArgumentException - SCADA point id cannot be constructed for the given arguments
ParsedSCADAPointId parseScadaPointId(java.lang.String scadaPointId)
throws java.lang.IllegalArgumentException
scadaPointId - SCADA point id
ParsedSCADAPountId object
java.lang.IllegalArgumentException - if scadaPointId cannot be parsed
Populates NMS device id in ParsedSCADAPointId with scadaPointId argument.
ScadaControl
generateControl(ExpectedAction action)
This method is used to create ScadaControl object based on information from the EXPECTED_ACTIONS table.
action - row from EXPECTED_ACTIONS table
ScadaControl object or null is controls are not supported
boolean isScadaPoint(
final MspObject obj)
This method is used to determine if obj is a SCADA-telemetered point. Currently this method gets invoked only for status points.
true if obj is a SCADA-telemetered point, otherwise false