org.opennms.netmgt.capsd

Class DbIpInterfaceEntry

java.lang.Object

org.opennms.netmgt.capsd.DbIpInterfaceEntry

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 DbIpInterfaceEntry
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:

James Zuo , Weave

Field Summary

Fields

Modifier and Type	Field and Description
static char	SNMP_NOT_ELIGIBLE Deprecated. Constant SNMP_NOT_ELIGIBLE='N'
static char	SNMP_PRIMARY Deprecated. Constant SNMP_PRIMARY='P'
static char	SNMP_SECONDARY Deprecated. Constant SNMP_SECONDARY='S'
static char	SNMP_UNKNOWN Deprecated. Constant SNMP_UNKNOWN=' '
static char	STATE_ALIAS Deprecated. Constant STATE_ALIAS='A'
static char	STATE_DELETED Deprecated. Constant STATE_DELETED='D'
static char	STATE_FORCED Deprecated. Constant STATE_FORCED='F'
static char	STATE_MANAGED Deprecated. Constant STATE_MANAGED='M'
static char	STATE_NOT_POLLED Deprecated. Constant STATE_NOT_POLLED='N'
static char	STATE_REMOTE Deprecated. Constant STATE_REMOTE='X'
static char	STATE_UNKNOWN Deprecated. Constant STATE_UNKNOWN=' '
static char	STATE_UNMANAGED Deprecated. Constant STATE_UNMANAGED='U'

Method Summary

Methods

Modifier and Type	Method and Description
static DbIpInterfaceEntry	clone(DbIpInterfaceEntry entry) Deprecated. Clones an existing entry.
static DbIpInterfaceEntry	create(int nid, InetAddress address, int ifIndex) Deprecated. Creates a new entry.
static DbIpInterfaceEntry	create(long l, InetAddress address) Deprecated. Creates a new entry.
static DbIpInterfaceEntry	get(Connection db, long nid, InetAddress addr) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
static DbIpInterfaceEntry	get(Connection db, long nid, InetAddress addr, int ifIndex) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
static DbIpInterfaceEntry	get(int nid, InetAddress addr) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
static DbIpInterfaceEntry	get(int nid, InetAddress addr, int ifIndex) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
String	getHostname() Deprecated. Returns the current hostname.
InetAddress	getIfAddress() Deprecated. Returns the name of the distributed poller for the entry.
int	getIfIndex() Deprecated. Returns the current ifIndex
Timestamp	getLastPoll() Deprecated. Gets the last poll time of the record
String	getLastPollString() Deprecated. Gets the last poll time of the record
char	getManagedState() Deprecated. Returns the current managed state of the interface
long	getNodeId() Deprecated. Returns the node entry's unique identifier.
char	getPrimaryState() Deprecated. Returns the current primary state.
DbIfServiceEntry[]	getServices() Deprecated.
DbIfServiceEntry[]	getServices(Connection db) Deprecated.
int	getStatus() Deprecated. Gets the current operational status field
boolean	hasHostnameChanged() Deprecated.
boolean	hasIfIndex() Deprecated. Returns true if the ifIndex is defined.
boolean	hasIfIndexChanged() Deprecated.
boolean	hasManagedStateChanged() Deprecated.
boolean	hasPrimaryStateChanged() Deprecated.
boolean	hasStatusChanged() Deprecated.
static void	main(String[] args) Deprecated. For debugging only
void	setHostname(String name) Deprecated. Sets the current hostname.
void	setIfIndex(int ndx) Deprecated. Sets the ifIndex value
void	setLastPoll(Date time) Deprecated. Sets the current creation time.
void	setLastPoll(String time) Deprecated. Sets the current creation time.
void	setLastPoll(Timestamp time) Deprecated. Sets the current creation time.
void	setManagedState(char state) Deprecated. Sets the managed state of the instance.
void	setPrimaryState(char state) Deprecated. Sets the new primary state.
void	setStatus(int status) Deprecated. Sets the current status of the interface
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	updateHostname(String newHostname) Deprecated.
boolean	updateIfIndex(int newIfIndex) Deprecated.
boolean	updateManagedState(char newManagedState) Deprecated.
boolean	updatePrimaryState(char newPrimaryState) Deprecated.
boolean	updateStatus(int newStatus) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

SNMP_PRIMARY

public static final char SNMP_PRIMARY

Deprecated.

Constant SNMP_PRIMARY='P'

See Also:

Constant Field Values

SNMP_SECONDARY

public static final char SNMP_SECONDARY

Deprecated.

Constant SNMP_SECONDARY='S'

See Also:

Constant Field Values

SNMP_NOT_ELIGIBLE

public static final char SNMP_NOT_ELIGIBLE

Deprecated.

Constant SNMP_NOT_ELIGIBLE='N'

See Also:

Constant Field Values

SNMP_UNKNOWN

public static final char SNMP_UNKNOWN

Deprecated.

Constant SNMP_UNKNOWN=' '

See Also:

Constant Field Values

STATE_MANAGED

public static final char STATE_MANAGED

Deprecated.

Constant STATE_MANAGED='M'

See Also:

Constant Field Values

STATE_UNMANAGED

public static final char STATE_UNMANAGED

Deprecated.

Constant STATE_UNMANAGED='U'

See Also:

Constant Field Values

STATE_ALIAS

public static final char STATE_ALIAS

Deprecated.

Constant STATE_ALIAS='A'

See Also:

Constant Field Values

STATE_DELETED

public static final char STATE_DELETED

Deprecated.

Constant STATE_DELETED='D'

See Also:

Constant Field Values

STATE_FORCED

public static final char STATE_FORCED

Deprecated.

Constant STATE_FORCED='F'

See Also:

Constant Field Values

STATE_NOT_POLLED

public static final char STATE_NOT_POLLED

Deprecated.

Constant STATE_NOT_POLLED='N'

See Also:

Constant Field Values

STATE_REMOTE

public static final char STATE_REMOTE

Deprecated.

Constant STATE_REMOTE='X'

See Also:

Constant Field Values

STATE_UNKNOWN

public static final char STATE_UNKNOWN

Deprecated.

Constant STATE_UNKNOWN=' '

See Also:

Constant Field Values

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.

getIfAddress

public InetAddress getIfAddress()

Deprecated.

Returns the name of the distributed poller for the entry. This is a non-mutable element of the record.

getLastPollString

public String getLastPollString()

Deprecated.

Gets the last poll time of the record

getLastPoll

public Timestamp getLastPoll()

Deprecated.

Gets the last poll time of the record

setLastPoll

public void setLastPoll(String time)
                 throws ParseException

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

Throws:

ParseException

setLastPoll

public void setLastPoll(Date time)

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

setLastPoll

public void setLastPoll(Timestamp time)

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

hasIfIndex

public boolean hasIfIndex()

Deprecated.

Returns true if the ifIndex is defined.

getIfIndex

public int getIfIndex()

Deprecated.

Returns the current ifIndex

setIfIndex

public void setIfIndex(int ndx)

Deprecated.

Sets the ifIndex value

Parameters:

ndx - The new ifIndex.

hasIfIndexChanged

public boolean hasIfIndexChanged()

Deprecated.

updateIfIndex

public boolean updateIfIndex(int newIfIndex)

Deprecated.

getHostname

public String getHostname()

Deprecated.

Returns the current hostname.

setHostname

public void setHostname(String name)

Deprecated.

Sets the current hostname.

Parameters:

name - The new hostname

hasHostnameChanged

public boolean hasHostnameChanged()

Deprecated.

updateHostname

public boolean updateHostname(String newHostname)

Deprecated.

getManagedState

public char getManagedState()

Deprecated.

Returns the current managed state of the interface

setManagedState

public void setManagedState(char state)

Deprecated.

Sets the managed state of the instance.

Parameters:

state - The new managed state

hasManagedStateChanged

public boolean hasManagedStateChanged()

Deprecated.

updateManagedState

public boolean updateManagedState(char newManagedState)

Deprecated.

getStatus

public int getStatus()

Deprecated.

Gets the current operational status field

setStatus

public void setStatus(int status)

Deprecated.

Sets the current status of the interface

Parameters:

status - The new status.

hasStatusChanged

public boolean hasStatusChanged()

Deprecated.

updateStatus

public boolean updateStatus(int newStatus)

Deprecated.

getPrimaryState

public char getPrimaryState()

Deprecated.

Returns the current primary state.

setPrimaryState

public void setPrimaryState(char state)

Deprecated.

Sets the new primary state.

Parameters:

state - The new primary state.

hasPrimaryStateChanged

public boolean hasPrimaryStateChanged()

Deprecated.

updatePrimaryState

public boolean updatePrimaryState(char newPrimaryState)

Deprecated.

store

public void store()
           throws SQLException

Deprecated.

Updates the interface information in the configured database. If the interfaca 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 interfaca 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

getServices

public DbIfServiceEntry[] getServices()
                               throws SQLException

Deprecated.

Throws:

SQLException

getServices

public DbIfServiceEntry[] getServices(Connection db)
                               throws SQLException

Deprecated.

Throws:

SQLException

create

public static DbIpInterfaceEntry create(long l,
                        InetAddress address)

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:

address - The address of the interface.

l - The node id of the interface.

Returns:

A new interface record.

create

public static DbIpInterfaceEntry create(int nid,
                        InetAddress address,
                        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:

address - The address of the interface.

nid - The node id of the interface.

ifIndex - The ifindex of the interface.

Returns:

A new interface record.

clone

public static DbIpInterfaceEntry clone(DbIpInterfaceEntry entry)

Deprecated.

Clones an existing entry.

Parameters:

entry - The entry to be cloned

Returns:

a new DbIpInterfaceEntry identical to the original

get

public static DbIpInterfaceEntry get(int nid,
                     InetAddress addr)
                              throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and ipAddr. If the record cannot be found then a null reference is returned.

Parameters:

nid - The node id key

addr - The ip address.

Returns:

The loaded entry or null if one could not be found.

Throws:

SQLException

get

public static DbIpInterfaceEntry get(int nid,
                     InetAddress addr,
                     int ifIndex)
                              throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and ipAddr. If the record cannot be found then a null reference is returned.

Parameters:

nid - The node id key

addr - The ip address.

ifIndex - The interface index.

Returns:

The loaded entry or null if one could not be found.

Throws:

SQLException

get

public static DbIpInterfaceEntry get(Connection db,
                     long nid,
                     InetAddress addr)
                              throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and ipAddr. If the record cannot be found then a null reference is returnd.

Parameters:

db - The databse connection used to load the entry.

nid - The node id key

addr - The internet address.

Returns:

The loaded entry or null if one could not be found.

Throws:

SQLException

get

public static DbIpInterfaceEntry get(Connection db,
                     long nid,
                     InetAddress addr,
                     int ifIndex)
                              throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and ipAddr. If the record cannot be found then a null reference is returned.

Parameters:

db - The database connection used to load the entry.

nid - The node id key

addr - The IP address.

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.