com.adventnet.nms.topodb.tl1
Class TL1Node

java.lang.Object
  com.adventnet.nms.topodb.ManagedObject
      com.adventnet.nms.topodb.TopoObject
          com.adventnet.nms.topodb.Node
              com.adventnet.nms.topodb.tl1.TL1Node

All Implemented Interfaces:

DBExtendedInterface, DBInterface, com.adventnet.nms.topodb.corba.ManagedObject_CIOperations, com.adventnet.nms.topodb.corba.Node_CIOperations, com.adventnet.nms.topodb.corba.TopoObject_CIOperations, java.io.Serializable, java.lang.Cloneable

public class TL1Node
extends Node

This class extends the Node class and represents the TL1 enabled Nodes discovered by the WebNMS system. This class is used to represent the TL1 device as a whole. User can extend this class and write his/her own Managed Object classes representing a specific type of TL1 device. For detailed information on each of the fields used in this TL1Node class, please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.adventnet.nms.topodb.TopoObject

PROCEEDSTATUSPOLL

Constructor Summary

TL1Node()
Default constructor.

Method Summary

protected int	checkStatus() This method is called to check the status of the TL1Node object.
boolean	checkValues(com.adventnet.tl1.message.TL1ResponseMessage resMess, java.lang.String response)
java.lang.String	getConnectionHandler() Get the ConnectionHandler implementation class name for this TL1 device.
java.lang.String	getDictionary() For future use.
java.lang.String	getInfoCommand() Get the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
java.util.Vector	getInfoCommandV() Get the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
java.lang.String	getInitCommand() Get the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
java.util.Vector	getInitCommandV() Get the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
java.lang.String	getLoginCommand() Get the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message.
java.util.Hashtable	getLoginCommandHt() Get the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message.
java.lang.String	getNotifyId() Get the current NotificationId used.
java.lang.String	getPortList()
int[]	getPortListArray()
java.util.Properties	getProperties() Returns the Properties of the TL1Node object.
java.lang.String	getSessionId() Get the current SessionId used.
java.lang.String	getStatpollCommand() Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device.
java.util.Vector	getStatpollCommandV() Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device.
int	getTl1port() Get the current port number of TL1 Agent in the NetworkElement used for connecting to the TL1 device.
void	setConnectionHandler(java.lang.String connHandler) Set the ConnectionHandler implementation classname for this TL1 device.
void	setDictionary(java.lang.String diction) For future use.
void	setInfoCommand(java.lang.String infoStr) Set the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
void	setInfoCommandV(java.util.Vector infoV) Set the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
void	setInitCommand(java.lang.String initStr) Set the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
void	setInitCommandV(java.util.Vector initV) Set the Initiailization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages.
void	setLoginCommand(java.lang.String logStr) Set the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message.
void	setLoginCommandHt(java.util.Hashtable logHash) Set the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message.
void	setNotifyId(java.lang.String notifId) Set the current NotificationId used.
void	setPortList(java.lang.String portlist)
void	setPortListArray(int[] portListArray)
void	setProperties(java.util.Properties p) Set the TL1Node object's properties.
void	setSessionId(java.lang.String sessId) Set the current SessionId used.
void	setStatpollCommand(java.lang.String statpollStr) Set the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device.
void	setStatpollCommandV(java.util.Vector statpollV) Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device.
void	setTl1port(int port) Set the current port number of TL1 Agent in the NetworkElement used for connecting to the TL1 device.

Methods inherited from class com.adventnet.nms.topodb.Node

checkDHCPNodeStatus, checkStatus_CT, clone, getInterfacesList, getIpaddrs_CT, getIpaddrs, getParentNets_CT, getParentNets, getProperties_CT, getStatus_CT, getTieRefHolder_Node, getUserProperties_CT, setIpaddrs_CT, setIpaddrs, setParentNets_CT, setParentNets, setProperties_CT

Methods inherited from class com.adventnet.nms.topodb.TopoObject

getBaseMibs, getCommunity, getContextName, getDomainName, getIpAddress, getIsDHCP, getIsInterface, getIsNetwork, getIsNode, getIsRouter, getIsSNMP, getNetmask, getSnmpport, getTieRefHolder_TopoObject, getUserName, getVersion, getWriteCommunity, setBaseMibs, setCommunity, setContextName, setDomainName, setIpAddress, setIsDHCP, setIsInterface, setIsNetwork, setIsNode, setIsRouter, setIsSNMP, setNetmask, setSnmpport, setUserName, setVersion, setWriteCommunity, toString

Methods inherited from class com.adventnet.nms.topodb.ManagedObject

addChildrenKey, addChildrenKeys, addGroupMembers, addGroupNames, equals, getChildren, getChildrenKeys, getClassname, getDisplayName, getDynamicUserProperty, getFailureCount, getFailureThreshold, getGroupMembers, getGroupNames, getGroups, getIsContainer, getIsGroup, getKey, getKeyName, getLazyLoaded, getLockId, getManaged, getMappedProperties, getMembers, getMoid, getName, getOwnerName, getParentId, getParentKey, getPollInterval, getShallowProperties, getStatus, getStatus, getStatusChangeTime, getStatusColor, getStatusPollEnabled, getStatusUpdateTime, getTester, getTieRefHolder_ManagedObject, getType, getUClass, getUserProperties, getUserProperty, getUTest, getWebNMS, hashCode, pollStatus, removeChildren, removeChildrenKeys, removeGroupMembers, removeGroupNames, removeUserProperty, setChildren, setChildrenKeys, setClassname, setDisplayName, setDynamicUserProperty, setFailureCount, setFailureThreshold, setGroupMembers, setGroupNames, setGroups, setIsContainer, setIsGroup, setLazyLoaded, setLockId, setManaged, setMappedProperties, setMembers, setName, setObjMoid, setOwnerName, setParentId, setParentKey, setPollInterval, setShallowProperties, setStatus, setStatusChangeTime, setStatusPollEnabled, setStatusUpdateTime, setTester, setType, setUClass, setUserProperty, setUTest, setWebNMS

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.adventnet.nms.topodb.corba.TopoObject_CIOperations

getBaseMibs, getCommunity, getIpAddress, getIsInterface, getIsNetwork, getIsNode, getIsRouter, getIsSNMP, getNetmask, getSnmpport, getWriteCommunity, setBaseMibs, setCommunity, setIpAddress, setIsInterface, setIsNetwork, setIsNode, setIsRouter, setIsSNMP, setNetmask, setSnmpport, setWriteCommunity

Methods inherited from interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperations

getClassname, getFailureCount, getFailureThreshold, getGroupNames, getKey, getKeyName, getManaged, getName, getPollInterval, getStatusChangeTime, getStatusUpdateTime, getTester, getType, getUClass, getWebNMS, pollStatus, setFailureThreshold, setGroupNames, setManaged, setName, setPollInterval, setStatus, setStatusChangeTime, setStatusUpdateTime, setTester, setType, setUClass, setWebNMS

Constructor Detail

TL1Node

public TL1Node()

Default constructor. Sets the "type" and "classname" fields to a default value of "TL1Node"

Method Detail

getTl1port

public int getTl1port()

Get the current port number of TL1 Agent in the NetworkElement used for connecting to the TL1 device.

Returns:

TL1 Agent port number currently used by Web NMS.

setTl1port

public void setTl1port(int port)

Set the current port number of TL1 Agent in the NetworkElement used for connecting to the TL1 device.

Parameters:

port - TL1 Agent port number currently used by Web NMS.

getPortList

public java.lang.String getPortList()

setPortList

public void setPortList(java.lang.String portlist)

getPortListArray

public int[] getPortListArray()

setPortListArray

public void setPortListArray(int[] portListArray)

getSessionId

public java.lang.String getSessionId()

Get the current SessionId used. SessionId is a unique key allocated by the Management Server denoting a connection between Web NMS and the Network Element.

Returns:

SessionId used currently.

setSessionId

public void setSessionId(java.lang.String sessId)

Set the current SessionId used. SessionId is a unique key allocated by the Management Server denoting a connection between Web NMS and the Network Element.

Parameters:

SessionId - used currently.

getNotifyId

public java.lang.String getNotifyId()

Get the current NotificationId used. NotificationId (Also called EventId) is a unique key allocated by the Management Server on registering for device event notifications (i.e., Autonomous Messages)

Returns:

NotificationId used currently.

setNotifyId

public void setNotifyId(java.lang.String notifId)

Set the current NotificationId used. NotificationId (Also called * EventId) is a unique key allocated by the Management Server on registering for device event notifications (i.e., Autonomous Messages)

Parameters:

NotificationId - used currently.

getDictionary

public java.lang.String getDictionary()

For future use. Not in use as of now. Get the XML filenames defining the complete set of device specific input commands, responses messages, acknowledgement messages and autonomous messages.

Returns:

dictionaries used.

setDictionary

public void setDictionary(java.lang.String diction)

For future use. Not in use as of now. Set the XML filenames defining the complete set of device specific input commands, responses messages, acknowledgement messages and autonomous messages.

Parameters:

dictionaries - used.

getConnectionHandler

public java.lang.String getConnectionHandler()

Get the ConnectionHandler implementation class name for this TL1 device. ConnectionHandler is a class used for doing any special setups or device specific customization when a connection is established to the device. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file in the WebNMS_HOME/conf/example directory.

Returns:

the ConnectionHandler implementation class name.

setConnectionHandler

public void setConnectionHandler(java.lang.String connHandler)

Set the ConnectionHandler implementation classname for this TL1 device. ConnectionHandler is a class used for doing any special setups or device specific customization when a connection is established to the device. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file in the WebNMS_HOME/conf/examples directory.

getLoginCommand

public java.lang.String getLoginCommand()

Get the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message. The returned String uses a special format. User is recommended to use the user friendly getLoginCommandHt() method instead of this method. This method is meant for internal use by Web NMS

Returns:

Login Command and the response information are returned as a String in a special format.

setLoginCommand

public void setLoginCommand(java.lang.String logStr)

Set the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message. The String argument needs to be in a special format. User is recommended to use the user friendly setLoginCommandHt() method instead of this method. This method is meant for internal use by Web NMS.

Parameters:

Login - Command and the response information are passed as a String in a special format.

getLoginCommandHt

public java.util.Hashtable getLoginCommandHt()

Get the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message. The returned Hashtable has the TL1 command against "command" key and the response information against "response" key. User is recommended to use this method and avoid using the getLoginCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format followed for the "response" message string.

Returns:

Login Command and the response information are returned as a Hashtable.

setLoginCommandHt

public void setLoginCommandHt(java.util.Hashtable logHash)

Set the Login Command (TL1 Input Command) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Message. The Hashtable argument passed should have the TL1 Login Command against "command" key and the response information against "response" key. This "response" information is optional. User is recommended to use this method and avoid using the setLoginCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format to be follow for the "response" message string.

Parameters:

Login - Command and the response information are passed as a Hashtable.

getInitCommand

public java.lang.String getInitCommand()

Get the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The returned String uses a special format. User is recommended to use the user friendly getInitCommandV() method instead of this method. This method is meant for internal use by Web NMS

Returns:

Initialization Commands and the response information are returned as a String in a special format.

setInitCommand

public void setInitCommand(java.lang.String initStr)

Set the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The String argument needs to be in a special format. User is recommended to use the user friendly setInitCommandV() method instead of this method. This method is meant for internal use by Web NMS.

Parameters:

Initialization - Commands and the response information are passed as a String in a special format.

getInitCommandV

public java.util.Vector getInitCommandV()

Get the Initialization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. Returns a Vector of Hashtables. The Hashtables have the the TL1 command against "command" key and the response information against "response" key. User is recommended to use this method and avoid using the getInitCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format followed for the "response" message string.

Returns:

Initialization Commands and the response information are returned as a Vector of Hashtables.

setInitCommandV

public void setInitCommandV(java.util.Vector initV)

Set the Initiailization Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The argument passed is a Vector of Hashtables. The Hashtables should have the TL1 Initialization Commands against "command" key and the response information against "response" key. This "response" information is optional. User is recommended to use this method and avoid using the setInitCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format to be follow for the "response" message string.

Parameters:

Initialization - Commands and the response information are passed as a Vector of Hashtables.

getInfoCommand

public java.lang.String getInfoCommand()

Get the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The returned String uses a special format. User is recommended to use the user friendly getInfoCommandV() method instead of this method. This method is meant for internal use by Web NMS

Returns:

Information Commands and the response information are returned as a String in a special format.

setInfoCommand

public void setInfoCommand(java.lang.String infoStr)

Set the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The String argument needs to be in a special format. User is recommended to use the user friendly setInfoCommandV() method instead of this method. This method is meant for internal use by Web NMS.

Parameters:

Information - Commands and the response information are passed as a String in a special format.

getInfoCommandV

public java.util.Vector getInfoCommandV()

Get the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. Returns a Vector of Hashtables. The Hashtables have the the TL1 command against "command" key and the response information against "response" key. User is recommended to use this method and avoid using the getInfoCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format followed for the "response" message string.

Returns:

Information Commands and the response information are returned as a Vector of Hashtables.

setInfoCommandV

public void setInfoCommandV(java.util.Vector infoV)

Set the additional Information Commands (TL1 Input Commands) used when connection is established to the TL1 device and any response information to be collected from the TL1 Response Messages. The argument passed is a Vector of Hashtables. The Hashtables should have the TL1 Initialization Commands against "command" key and the response information against "response" key. This "response" information is optional. User is recommended to use this method and avoid using the setInfoCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format to be follow for the "response" message string.

Parameters:

Information - Commands and the response information are passed as a Vector of Hashtables.

getStatpollCommand

public java.lang.String getStatpollCommand()

Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device. Any response information to be used for matching with the information obtained from the TL1 Response Message, for checking if the device is healthy can also be given. The returned String uses a special format. User is recommended to use the user friendly getStatpollCommandV() method instead of this method. This method is meant for internal use by Web NMS

Returns:

Status Polling Commands and the response information are returned as a String in a special format.

setStatpollCommand

public void setStatpollCommand(java.lang.String statpollStr)

Set the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device. Any response information to be used for matching with the information obtained from the TL1 Response Message, for checking if the device is healthy can also be given. The String argument needs to be in a special format. User is recommended to use the user friendly setStatpollCommandV() method instead of this method. This method is meant for internal use by Web NMS.

Parameters:

Status - Polling Commands and the response information are passed as a String in a special format.

getStatpollCommandV

public java.util.Vector getStatpollCommandV()

Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device. Any response information to be used for matching with the information obtained from the TL1 Response Message, for checking if the device is healthy can also be given. . Returns a Vector of Hashtables. The Hashtables have the the TL1 command against "command" key and the response information, for matching, against "response" key. User is recommended to use this method and avoid using the getStatpollCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format followed for the "response" message string.

Returns:

Status Polling Commands and the response information are returned as a Vector of Hashtables.

setStatpollCommandV

public void setStatpollCommandV(java.util.Vector statpollV)

Get the Status Polling Commands (TL1 Input Commands) used for status polling the TL1Node object and thereby the TL1 device. Any response information to be used for matching with the information obtained from the TL1 Response Message, for checking if the device is healthy can also be given. The argument passed is a Vector of Hashtables. The Hashtables should have the TL1 Status Polling Commands against "command" key and the response information, for matching, against "response" key. This "response" information is optional. User is recommended to use this method and avoid using the setStatpollCommand() method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information and the format to be follow for the "response" message string.

Parameters:

Status - Polling Commands and the response information are passed as a Vector of Hashtables.

getProperties

public java.util.Properties getProperties()

Returns the Properties of the TL1Node object. Derived classes should override this method and invoke the super.getProperties() in the begining of this method. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information on each of the TL1Node object fields.

Specified by:

getProperties in interface DBInterface

Overrides:

getProperties in class Node

Returns:

The values of the following fields of this class and all its super classes in a Property object including the user properties. This method returns the value of all fields as string.

 
 tl1port, sessionId, notifyId, dictionary, connectionHandler,
 loginCommand, initCommand, infoCommand, statpollCommand and all the properties of this
 object's super classes.
  

See Also:

ManagedObject#getProperties()

setProperties

public void setProperties(java.util.Properties p)

Set the TL1Node object's properties. The name of an object cannot be changed using this method. Derived Classes should override this method and invoke super.setProperties() at the end of this method. If the Object is to be updated in the database the TopoAPI.updateObject() method should be invoked after doing the setProperties() on the object. It's recommended to use this method to set all properties except the loginCommand, initCommand, statpollCommand and infoCommand as they use special format, internally used by Web NMS. Please refer to the Help Documentation or the documentation provided in the example_tl1seed.file under WebNMS_HOME/conf/examples directory for detailed information on each of the TL1Node object fields.

Specified by:

setProperties in interface DBInterface

Overrides:

setProperties in class Node

Parameters:

p - The properties to be set in this object.

 
 tl1port, sessionId, notifyId, dictionary, connectionHandler,
 loginCommand, initCommand, infoCommand, statpollComand and all the properties of this
 object's super classes.
  

See Also:

ManagedObject#setProperties(Properties)

checkStatus

protected int checkStatus()
                   throws java.rmi.RemoteException

This method is called to check the status of the TL1Node object. It does the status checking and returns the new status of this object. Super classes should override this method and provide their own status checking logic.

Overrides:

checkStatus in class Node

Returns:

status of the object to be set.

Throws:

java.rmi.RemoteException - if an error occurs

checkValues

public boolean checkValues(com.adventnet.tl1.message.TL1ResponseMessage resMess,
                           java.lang.String response)