DbSnmpInterfaceEntry (OpenNMS 17.1.0 API)

java.lang.Object
- org.opennms.netmgt.capsd.DbSnmpInterfaceEntry

Deprecated.
Objects like this that control their own data access are deprecated in favor of the JAXB beans (opennms-model) and DAO objects (opennms-dao).
```
public final class DbSnmpInterfaceEntry
extends Object
```
Once loaded or create, the class tracks any changes and will write those changes to the database whenever the store method is invoked. If a database connection is not passed to the store method, then a temporary one is allocated to write the results.

NOTE: if the connection is passed in and is not in auto commit mode, then the caller must call commit to inform the database that the transaction is complete.

Author:

Weave , OpenNMS

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static DbSnmpInterfaceEntry`	`create(int nid, int ifIndex)` Deprecated. Creates a new entry.
`static DbSnmpInterfaceEntry`	`get(Connection db, long nodeId, int ifIndex)` Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ifIndex.
`static DbSnmpInterfaceEntry`	`get(long nodeId, int ifIndex)` Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ifindex.
`int`	`getAdminStatus()` Deprecated.
`String`	`getAlias()` Deprecated.
`String`	`getCollect()` Deprecated.
`String`	`getDescription()` Deprecated.
`int`	`getIfIndex()` Deprecated. Returns the current ifIndex
`String`	`getName()` Deprecated.
`InetAddress`	`getNetmask()` Deprecated.
`long`	`getNodeId()` Deprecated. Returns the node entry's unique identifier.
`int`	`getOperationalStatus()` Deprecated.
`String`	`getPhysicalAddress()` Deprecated.
`long`	`getSpeed()` Deprecated.
`int`	`getType()` Deprecated.
`boolean`	`hasAdminStatusChanged()` Deprecated.
`boolean`	`hasAliasChanged()` Deprecated.
`boolean`	`hasCollectChanged()` Deprecated.
`boolean`	`hasDescriptionChanged()` Deprecated.
`boolean`	`hasIfIndex()` Deprecated. Returns true if the ifIndex is defined.
`boolean`	`hasNameChanged()` Deprecated.
`boolean`	`hasNetmaskChanged()` Deprecated.
`boolean`	`hasOperationalStatusChanged()` Deprecated.
`boolean`	`hasPhysicalAddressChanged()` Deprecated.
`boolean`	`hasSpeedChanged()` Deprecated.
`boolean`	`hasTypeChanged()` Deprecated.
`static void`	`main(String[] args)` Deprecated. For debugging only
`void`	`setAdminStatus(int status)` Deprecated.
`void`	`setAlias(String alias)` Deprecated.
`void`	`setCollect(String collect)` Deprecated.
`void`	`setDescription(String descr)` Deprecated.
`void`	`setName(String name)` Deprecated.
`void`	`setNetmask(InetAddress mask)` Deprecated.
`void`	`setOperationalStatus(int status)` Deprecated.
`void`	`setPhysicalAddress(String addr)` Deprecated.
`void`	`setSpeed(long speed)` Deprecated.
`void`	`setType(int type)` Deprecated.
`void`	`store()` Deprecated. Updates the interface information in the configured database.
`void`	`store(Connection db)` Deprecated. Updates the interface information in the configured database.
`String`	`toString()` Deprecated. Creates a string that displays the internal contents of the record.
`boolean`	`updateAdminStatus(int newIfAdminStatus)` Deprecated.
`boolean`	`updateAlias(String newIfAlias)` Deprecated.
`boolean`	`updateCollect(String newCollect)` Deprecated.
`boolean`	`updateDescription(String newIfDescription)` Deprecated.
`boolean`	`updateName(String newIfName)` Deprecated.
`boolean`	`updateNetmask(InetAddress newNetmask)` Deprecated.
`boolean`	`updateOperationalStatus(int newIfOperStatus)` Deprecated.
`boolean`	`updatePhysicalAddress(String newPhysAddr)` Deprecated.
`boolean`	`updateSpeed(long newIfSpeed)` Deprecated.
`boolean`	`updateType(int newIfType)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getNodeId
```
public long getNodeId()
```
    Deprecated.
    
    Returns the node entry's unique identifier. This is a non-mutable element. If the record does not yet exist in the database then a -1 is returned.
  - hasIfIndex
```
public boolean hasIfIndex()
```
    Deprecated.
    
    Returns true if the ifIndex is defined.
  - getIfIndex
```
public int getIfIndex()
```
    Deprecated.
    
    Returns the current ifIndex
  - getNetmask
```
public InetAddress getNetmask()
```
    Deprecated.
  - setNetmask
```
public void setNetmask(InetAddress mask)
```
    Deprecated.
  - hasNetmaskChanged
```
public boolean hasNetmaskChanged()
```
    Deprecated.
  - updateNetmask
```
public boolean updateNetmask(InetAddress newNetmask)
```
    Deprecated.
  - getPhysicalAddress
```
public String getPhysicalAddress()
```
    Deprecated.
  - setPhysicalAddress
```
public void setPhysicalAddress(String addr)
```
    Deprecated.
  - hasPhysicalAddressChanged
```
public boolean hasPhysicalAddressChanged()
```
    Deprecated.
  - updatePhysicalAddress
```
public boolean updatePhysicalAddress(String newPhysAddr)
```
    Deprecated.
  - getDescription
```
public String getDescription()
```
    Deprecated.
  - setDescription
```
public void setDescription(String descr)
```
    Deprecated.
  - hasDescriptionChanged
```
public boolean hasDescriptionChanged()
```
    Deprecated.
  - updateDescription
```
public boolean updateDescription(String newIfDescription)
```
    Deprecated.
  - getName
```
public String getName()
```
    Deprecated.
  - setName
```
public void setName(String name)
```
    Deprecated.
  - hasNameChanged
```
public boolean hasNameChanged()
```
    Deprecated.
  - updateName
```
public boolean updateName(String newIfName)
```
    Deprecated.
  - getType
```
public int getType()
```
    Deprecated.
  - setType
```
public void setType(int type)
```
    Deprecated.
  - hasTypeChanged
```
public boolean hasTypeChanged()
```
    Deprecated.
  - updateType
```
public boolean updateType(int newIfType)
```
    Deprecated.
  - getSpeed
```
public long getSpeed()
```
    Deprecated.
  - setSpeed
```
public void setSpeed(long speed)
```
    Deprecated.
  - hasSpeedChanged
```
public boolean hasSpeedChanged()
```
    Deprecated.
  - updateSpeed
```
public boolean updateSpeed(long newIfSpeed)
```
    Deprecated.
  - getAdminStatus
```
public int getAdminStatus()
```
    Deprecated.
  - setAdminStatus
```
public void setAdminStatus(int status)
```
    Deprecated.
  - hasAdminStatusChanged
```
public boolean hasAdminStatusChanged()
```
    Deprecated.
  - updateAdminStatus
```
public boolean updateAdminStatus(int newIfAdminStatus)
```
    Deprecated.
  - getOperationalStatus
```
public int getOperationalStatus()
```
    Deprecated.
  - setOperationalStatus
```
public void setOperationalStatus(int status)
```
    Deprecated.
  - hasOperationalStatusChanged
```
public boolean hasOperationalStatusChanged()
```
    Deprecated.
  - updateOperationalStatus
```
public boolean updateOperationalStatus(int newIfOperStatus)
```
    Deprecated.
  - getAlias
```
public String getAlias()
```
    Deprecated.
  - setAlias
```
public void setAlias(String alias)
```
    Deprecated.
  - hasAliasChanged
```
public boolean hasAliasChanged()
```
    Deprecated.
  - updateAlias
```
public boolean updateAlias(String newIfAlias)
```
    Deprecated.
  - getCollect
```
public String getCollect()
```
    Deprecated.
  - setCollect
```
public void setCollect(String collect)
```
    Deprecated.
  - hasCollectChanged
```
public boolean hasCollectChanged()
```
    Deprecated.
  - updateCollect
```
public boolean updateCollect(String newCollect)
```
    Deprecated.
  - store
```
public void store()
           throws SQLException
```
    Deprecated.
    
    Updates the interface information in the configured database. If the interface does not exist the a new row in the table is created. If the element already exists then it's current row is updated as needed based upon the current changes to the node.
    
    Throws:
    
    SQLException
  - store
```
public void store(Connection db)
           throws SQLException
```
    Deprecated.
    
    Updates the interface information in the configured database. If the interface does not exist the a new row in the table is created. If the element already exists then it's current row is updated as needed based upon the current changes to the node.
    
    Parameters:
    
    db - The database connection used to write the record.
    
    Throws:
    
    SQLException
  - create
```
public static DbSnmpInterfaceEntry create(int nid,
                                          int ifIndex)
```
    Deprecated.
    
    Creates a new entry. The entry is created in memory, but is not written to the database until the first call to store.
    
    Parameters:
    
    nid - The node id of the interface.
    
    ifIndex - The ifIndex of the interface
    
    Returns:
    
    A new interface record.
  - get
```
public static DbSnmpInterfaceEntry get(long nodeId,
                                       int ifIndex)
                                throws SQLException
```
    Deprecated.
    
    Retrieves a current record from the database based upon the key fields of nodeID and ifindex. If the record cannot be found then a null reference is returned.
    
    Parameters:
    
    nodeId - The node id key
    
    ifIndex - the interface index.
    
    Returns:
    
    The loaded entry or null if one could not be found.
    
    Throws:
    
    SQLException
  - get
```
public static DbSnmpInterfaceEntry get(Connection db,
                                       long nodeId,
                                       int ifIndex)
                                throws SQLException
```
    Deprecated.
    
    Retrieves a current record from the database based upon the key fields of nodeID and ifIndex. If the record cannot be found then a null reference is returned.
    
    Parameters:
    
    db - The database connection used to load the entry.
    
    nodeId - The node id key
    
    ifIndex - The interface index.
    
    Returns:
    
    The loaded entry or null if one could not be found.
    
    Throws:
    
    SQLException
  - toString
```
public String toString()
```
    Deprecated.
    
    Creates a string that displays the internal contents of the record. This is mainly just used for debug output since the format is ad-hoc.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String object.
  - main
```
public static void main(String[] args)
```
    Deprecated.
    
    For debugging only
    
    Parameters:
    
    args - an array of String objects.

Class DbSnmpInterfaceEntry

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getNodeId

hasIfIndex

getIfIndex

getNetmask

setNetmask

hasNetmaskChanged

updateNetmask

getPhysicalAddress

setPhysicalAddress

hasPhysicalAddressChanged

updatePhysicalAddress

getDescription

setDescription

hasDescriptionChanged

updateDescription

getName

setName

hasNameChanged

updateName

getType

setType

hasTypeChanged

updateType

getSpeed

setSpeed

hasSpeedChanged

updateSpeed

getAdminStatus

setAdminStatus

hasAdminStatusChanged

updateAdminStatus

getOperationalStatus

setOperationalStatus

hasOperationalStatusChanged

updateOperationalStatus

getAlias

setAlias

hasAliasChanged

updateAlias

getCollect

setCollect

hasCollectChanged

updateCollect

store

store

create

get

get

toString

main