com.adventnet.nms.extranet.remote.communication.fw
Class SPPCommParser

java.lang.Object
  |
  +--com.adventnet.nms.extranet.remote.communication.fw.SPPCommParser

public class SPPCommParser

extends java.lang.Object

This class provides the communication details configured in CommunicationInfo.xml for this DMS. All the details about communication with the Central Server are maintained in this object. At the DMS startup CommunicationInfo.xml file is read for getting communication details. This configuration file is present in FE, DMS, and Central server, and this class is used in all these components for reading the XML file.

Method Summary

java.lang.String	getCommunicationProperty(java.lang.String key) Returns the value corresponding to the given key from communication properties configured in CommunicationInfo.xml.
java.util.Properties	getCommunicationProps() Returns all the communication properties configured in CommunicationInfo.xml.
static SPPCommParser	getInstance() Returns a reference of this object.
java.lang.String	getMainProperty(java.lang.String key) Returns the value corresponding to the given key from main communication properties configured in CommunicationInfo.xml.
java.util.Properties	getMainProps() Returns the main communication properties configured in CommunicationInfo.xml for the corresponding key.
java.lang.String	getUserProperty(java.lang.String key) Returns the value corresponding to the given key from user properties configured in CommunicationInfo.xml.
java.util.Properties	getUserProps() Returns the user properties configured in CommunicationInfo.xml.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SPPCommParser getInstance()

Returns a reference of this object.

Returns:

reference of this object.

getCommunicationProps

public java.util.Properties getCommunicationProps()

Returns all the communication properties configured in CommunicationInfo.xml.

Returns:

communication properties.

getMainProps

public java.util.Properties getMainProps()

Returns the main communication properties configured in CommunicationInfo.xml for the corresponding key. To get the ReadInterval configured as a main property in the configuration file, readInterval= Long.parseLong(SPPCommParser.getInstance().getMainProperty("ReadInterval"))

Returns:

main communication properties.

getUserProps

public java.util.Properties getUserProps()

Returns the user properties configured in CommunicationInfo.xml.

Returns:

user properties.

getMainProperty

public java.lang.String getMainProperty(java.lang.String key)

Returns the value corresponding to the given key from main communication properties configured in CommunicationInfo.xml.

Returns:

value corresponding to the given key.

getUserProperty

public java.lang.String getUserProperty(java.lang.String key)

Returns the value corresponding to the given key from user properties configured in CommunicationInfo.xml.

Returns:

value corresponding to the given key.

getCommunicationProperty

public java.lang.String getCommunicationProperty(java.lang.String key)

Returns the value corresponding to the given key from communication properties configured in CommunicationInfo.xml.

Returns:

value corresponding to the given key.