|
"WEBNMS_5 API Docs" | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.adventnet.nms.topodb.ManagedObject
com.adventnet.nms.topodb.TopoObject
public class TopoObject
This class extends the ManagedObject class and is the base class for all
IP objects. It defines fields specific to Network Elements implementing
TCP/IP. It has fields to indicate if the object is a Network, Node,
IpAddress(interface), router, SnmpNode etc. It also has field for
snmp related parameters like port, commuinity, snmp version etc.
| Field Summary | |
|---|---|
static int |
PROCEEDSTATUSPOLL
The integer value for proceeding with status polling after DHCP Node IP verification checkDHCPNodeStatus() |
| Constructor Summary | |
|---|---|
TopoObject()
Default Constructor. |
|
| Method Summary | |
|---|---|
protected int |
checkDHCPNodeStatus()
The checkDHCPNodeStatus method is invoked during
status polling for DHCP client objects. |
com.adventnet.nms.topodb.corba.SeverityStateEnum |
checkStatus_CT()
corba: ManagedObject_CIOperations interface method. |
java.lang.Object |
clone()
Returns the cloned copy of the TopoObject. |
java.lang.String |
getBaseMibs()
Gets the Mibs implemented by the Snmp Agent in the Network Element. |
java.lang.String |
getCommunity()
Gets the read community String used by the Snmp Agent in the Network Element. |
java.lang.String |
getContextName()
Gets the contextName used by the SNMPv3 Agent in the Network Element. |
java.lang.String |
getDomainName()
Gets the Domain Name of the Network Element. |
java.lang.String |
getIpAddress()
Gets the Ipaddress of the Network Element. |
boolean |
getIsDHCP()
Gets whether the network element supports DHCP (i.e., if the ipaddress for the network element is assigned by DHCP protocol). |
boolean |
getIsInterface()
Gets whether the Network element is an IP interface Object. |
boolean |
getIsNetwork()
Gets whether the Network element is a IP Network. |
boolean |
getIsNode()
Gets Whether the Network element is a IP node. |
boolean |
getIsRouter()
Gets whether the network element is a Router. |
boolean |
getIsSNMP()
Gets whether the network element supports snmp protocol. |
java.lang.String |
getNetmask()
Gets the Sub-net Mask of the Network Element. |
com.adventnet.nms.common.corba.Property_CT[] |
getProperties_CT()
corba: ManagedObject_CIOperations interface method. |
java.util.Properties |
getProperties()
Returns the all the properties of the TopoObject. |
int |
getSnmpport()
Gets the Snmp port used by the Snmp Agent in the Network Element. |
com.adventnet.nms.topodb.corba.SeverityStateEnum |
getStatus_CT()
corba: ManagedObject_CIOperations interface method. |
TopoObjectTieRefHolder |
getTieRefHolder_TopoObject()
corba: To get the tie ref holder for the object. |
java.lang.String |
getUserName()
Gets the userName used by the SNMPv3 Agent in the Network Element. |
com.adventnet.nms.common.corba.Property_CT[] |
getUserProperties_CT()
corba: ManagedObject_CIOperations interface method. |
java.lang.String |
getVersion()
Gets the version used by the Snmp Agent in the Network Element. |
java.lang.String |
getWriteCommunity()
Gets the write community String used by the Snmp Agent in the Network Element. |
void |
setBaseMibs(java.lang.String baseMibs)
Sets the Mibs implemented by the Snmp Agent in the Network Element. |
void |
setCommunity(java.lang.String community)
Sets the read community String used by the Snmp Agent in the Network Element. |
void |
setContextName(java.lang.String contextName)
Sets the contextName used by the SNMPv3 Agent in the Network Element. |
void |
setDomainName(java.lang.String domainName)
Sets the Domain Name of the Network Element. |
void |
setIpAddress(java.lang.String ipAddress)
Sets the IpAddress of the Network Element which may be the same as the name. |
void |
setIsDHCP(boolean isDHCP)
Sets whether the network element supports DHCP or not. |
void |
setIsInterface(boolean isInterface)
Sets Whether the Network element is an interface Object. |
void |
setIsNetwork(boolean isNetwork)
Sets whether the Network element is a IP Network. |
void |
setIsNode(boolean isNode)
Sets Whether the Network element is a IP node. |
void |
setIsRouter(boolean isRouter)
Sets Whether the network element is a Router. |
void |
setIsSNMP(boolean isSNMP)
Sets whether the network element supports snmp. |
void |
setNetmask(java.lang.String netmask)
Sets the Sub-net Mask of the Network Element. |
void |
setProperties_CT(com.adventnet.nms.common.corba.Property_CT[] propertyList)
corba: ManagedObject_CIOperations interface method. |
void |
setProperties(java.util.Properties p)
Set the TopoObject object's properties. |
void |
setSnmpport(int snmpport)
Sets the Snmp port used by the Snmp Agent in the Network Element. |
void |
setUserName(java.lang.String userName)
Sets the userName used by the SNMPv3 Agent in the Network Element. |
void |
setVersion(java.lang.String version)
Sets the version used by the Snmp Agent in the Network Element. |
void |
setWriteCommunity(java.lang.String writeCommunity)
Sets the write community String used by the Snmp Agent in the Network Element. |
java.lang.String |
toString()
Returns the name of this object. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| 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 |
| Field Detail |
|---|
public static int PROCEEDSTATUSPOLL
checkDHCPNodeStatus()
| Constructor Detail |
|---|
public TopoObject()
| Method Detail |
|---|
public java.lang.String getIpAddress()
getIpAddress in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetIpAddress(java.lang.String)public void setIpAddress(java.lang.String ipAddress)
setIpAddress in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsipAddress - The Ipaddress of the Network element.setNetmask(String),
getIpAddress()public java.lang.String getNetmask()
getNetmask in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetNetmask(java.lang.String)public void setNetmask(java.lang.String netmask)
Network to which the node belongs.
setNetmask in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsnetmask - The sub netmask of the Network Element.setIpAddress(String),
getNetmask()public java.lang.String getCommunity()
SnmpNode. It
returns the default value when no community is set for the object. This
property is internally used in NMS when SNMP Get operation is performed.
getCommunity in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsgetWriteCommunity(),
setCommunity(java.lang.String)public void setCommunity(java.lang.String community)
SnmpNode. The default
value for this property is "public". The community basically determines if the
user has the permission to do the Get operations for the OIDs.
setCommunity in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationscommunity - The community of the snmp agent in the network element.setWriteCommunity(String),
getCommunity()public java.lang.String getVersion()
SnmpNode.
It returns empty String when no version is set for the object.
setVersion(java.lang.String)public void setVersion(java.lang.String version)
SnmpNode.
The version is internally set by the Nms during the discovery,
to the version of the Snmp Agent discovered. It has no version set for
a non-snmp node.
version - The version of the snmp agent in the network element. The value should be v1 or v2c or v3getVersion()public java.lang.String getUserName()
getContextName(),
setUserName(java.lang.String)public void setUserName(java.lang.String userName)
userName - The userName used by the SNMPv3 agent in the Network element.setContextName(String),
getUserName()public java.lang.String getContextName()
setContextName(java.lang.String)public void setContextName(java.lang.String contextName)
contextName - The contextName used by the SNMPv3 agent in the Network element.getContextName()public java.lang.String getWriteCommunity()
getWriteCommunity in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsgetCommunity(),
setWriteCommunity(java.lang.String)public void setWriteCommunity(java.lang.String writeCommunity)
setWriteCommunity in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationswriteCommunity - The write community of the snmp agent in the Network element.setCommunity(String),
getWriteCommunity()public int getSnmpport()
getSnmpport in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetSnmpport(int)public void setSnmpport(int snmpport)
setSnmpport in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssnmpport - The port used by the snmp agent in the Network element.getSnmpport()public java.lang.String getBaseMibs()
getBaseMibs in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetBaseMibs(java.lang.String)public void setBaseMibs(java.lang.String baseMibs)
setBaseMibs in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsbaseMibs - The mibs implemented by the snmp agent in the Network
element. More than one mib should be set with white
space separating them.getBaseMibs()public boolean getIsDHCP()
setIsDHCP(boolean)public void setIsDHCP(boolean isDHCP)
isDHCP - Whether the Network element gets its ipaddress assigned
using by DHCP protoclgetIsDHCP()public boolean getIsSNMP()
SnmpNode.
getIsSNMP in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetIsSNMP(boolean)public void setIsSNMP(boolean isSNMP)
setIsSNMP in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsisSNMP - Whether the Network element implements an Snmp agent or not.getIsSNMP()public boolean getIsInterface()
IpAddress class.
getIsInterface in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsIpAddress,
setIsInterface(boolean)public void setIsInterface(boolean isInterface)
IpAddress.
setIsInterface in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsisInterface - Whether the ManagedObject is an interfaceIpAddress,
getIsInterface()public boolean getIsRouter()
getIsRouter in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationssetIsRouter(boolean)public void setIsRouter(boolean isRouter)
setIsRouter in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsisRouter - Whether the network element is a router.getIsRouter()public boolean getIsNode()
Node class.
getIsNode in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsNode,
setIsNode(boolean)public void setIsNode(boolean isNode)
Node class. This method has
no check, if the field is set for an object that is not an instance
of Node.
setIsNode in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsisNode - Whether the ManagedObject is a IP node.Node,
getIsNode()public boolean getIsNetwork()
Network class.
getIsNetwork in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsNetwork,
setIsNetwork(boolean)public void setIsNetwork(boolean isNetwork)
Network class. By default it has
the value false. This method has no check, if the field is set for an
object that is not an instance of Node.
setIsNetwork in interface com.adventnet.nms.topodb.corba.TopoObject_CIOperationsisNetwork - Whether the ManagedObject is a IP Network.Network,
getIsNetwork()public java.lang.String getDomainName()
setDomainName(java.lang.String)public void setDomainName(java.lang.String domainName)
domainName - The Domain Name of the Network element.ManagedObject.setName(String),
getDomainName()public java.lang.String toString()
toString in class ManagedObjectpublic java.lang.Object clone()
clone in interface DBInterfaceclone in class ManagedObjectpublic void setProperties(java.util.Properties p)
setProperties in interface DBInterfacesetProperties in class ManagedObjectp - The properties that can be set in this object.
ipAddress, netmask, domainName, baseMibs, isSNMP, isDHCP, community,
writeCommunity, snmpport, isRouter, isNode, isNetwork,
isInterface and all the properties of it's super classes.
ManagedObject.setProperties(Properties),
getProperties()public java.util.Properties getProperties()
getProperties in interface DBInterfacegetProperties in class ManagedObject
name, ipAddress, domainName, netmask, isSNMP, isDHCP, snmpport, baseMibs,
community, writeCommunity, isInterface, isRouter, isNode,
isNetwork and all the properties of its super classes in a
Property object.
ManagedObject.getProperties(),
setProperties(java.util.Properties)public com.adventnet.nms.topodb.corba.SeverityStateEnum checkStatus_CT()
checkStatus_CT in interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperationscheckStatus_CT in class ManagedObjectprotected int checkDHCPNodeStatus()
checkDHCPNodeStatus method is invoked during
status polling for DHCP client objects. The default implementation of this
method verifies if the IPAddress of the dhcp object in the database
and in the device are alike(In a DHCP environment, there is a possibility
of IP change between status polls). If there has been a change, the current object
will be unmanaged and its IpAddress will be changed to 0.0.0.0. A new node with the
new IP got will be added to database. If, there has been an IP change and the node
gets unmanaged, this method will return -1 which is the
com.adventnet.nms.severity.SeverityInfo#SpecialPurposeSeverity.
Else, it will return PROCEEDSTATUSPOLL
int valueNode.checkDHCPNodeStatus(),
SnmpNode.checkDHCPNodeStatus(),
IpAddress.checkDHCPNodeStatus(),
SnmpInterface.checkDHCPNodeStatus()public void setProperties_CT(com.adventnet.nms.common.corba.Property_CT[] propertyList)
setProperties_CT in interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperationssetProperties_CT in class ManagedObjectgetProperties_CT()public com.adventnet.nms.common.corba.Property_CT[] getProperties_CT()
getProperties_CT in interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperationsgetProperties_CT in class ManagedObjectsetProperties_CT(com.adventnet.nms.common.corba.Property_CT[])public com.adventnet.nms.common.corba.Property_CT[] getUserProperties_CT()
getUserProperties_CT in interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperationsgetUserProperties_CT in class ManagedObjectpublic com.adventnet.nms.topodb.corba.SeverityStateEnum getStatus_CT()
getStatus_CT in interface com.adventnet.nms.topodb.corba.ManagedObject_CIOperationsgetStatus_CT in class ManagedObjectpublic TopoObjectTieRefHolder getTieRefHolder_TopoObject()
|
"WEBNMS_5 API Docs" | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||