org.opennms.netmgt.model.capsd

Class DbNodeEntry

java.lang.Object

org.opennms.netmgt.model.capsd.DbNodeEntry

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 DbNodeEntry
extends Object

This class is used to model a row of the node table from the OpenNMS database. The node table is indexed by the elements dpNode and nodeID. When a new element is created using the create call a node id will be automatically defined. If the name of the distribute poller is not passed to the create method, the it also is assigned a default value.

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 conneciton 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

Field Summary

Fields

Modifier and Type	Field and Description
static char	LABEL_SOURCE_ADDRESS Deprecated. Label source set by IP Address
static char	LABEL_SOURCE_HOSTNAME Deprecated. Label source set by hostname
static char	LABEL_SOURCE_NETBIOS Deprecated. Label source set by netbios
static char	LABEL_SOURCE_SYSNAME Deprecated. Label source set by SNMP sysname
static char	LABEL_SOURCE_UNKNOWN Deprecated. Label source unset/unknown
static char	LABEL_SOURCE_USER Deprecated. Label source set by user
static char	NODE_TYPE_ACTIVE Deprecated. The character returned if the node is active
static char	NODE_TYPE_DELETED Deprecated. The character returned if the node is deleted
static char	NODE_TYPE_UNKNOWN Deprecated. The character returned if the node type is unset/unknown.

Method Summary

Methods

Modifier and Type	Method and Description
static DbNodeEntry	clone(DbNodeEntry entry) Deprecated. Clones an existing entry.
static DbNodeEntry	create() Deprecated. Creates a new entry.
static DbNodeEntry	create(String poller) Deprecated. Creates a new entry.
void	createAssetNodeEntry(Connection conn, int nodeid) Deprecated. Creates a null entry for a nodeid into the assets table
static DbNodeEntry	get(Connection db, int nid) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and dpName.
static DbNodeEntry	get(Connection db, int nid, String dpName) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and dpName.
static DbNodeEntry	get(int nid) Deprecated. Retreives a current record from the database based upon the key fields of nodeID and dpName.
static DbNodeEntry	get(int nid, String dpName) Deprecated. Retreives a current record from the database based upon the key fields of nodeID and dpName.
Timestamp	getCreationTime() Deprecated. Gets the creation time of the record.
String	getDistributedPollerName() Deprecated. Returns the name of the distributed poller for the entry.
String	getDomainName() Deprecated. Returns the current domain name.
String	getForeignId() Deprecated. Returns the current foreignSource.
String	getForeignSource() Deprecated. Returns the current foreignSource.
String	getFormattedCreationTime() Deprecated. Gets the creation time of the record.
DbIpInterfaceEntry[]	getInterfaces() Deprecated.
DbIpInterfaceEntry[]	getInterfaces(Connection db) Deprecated.
String	getLabel() Deprecated. Returns the entry's label.
char	getLabelSource() Deprecated. Returns the current label source.
Timestamp	getLastPoll() Deprecated. Gets the last poll time of the record
String	getLastPollString() Deprecated. Gets the last poll time of the record
DbIpInterfaceEntry[]	getManagedInterfaces() Deprecated.
DbIpInterfaceEntry[]	getManagedInterfaces(Connection db) Deprecated.
String	getNetBIOSName() Deprecated. Returns the current NetBIOS name.
int	getNodeId() Deprecated. Returns the node entry's unique identifier.
char	getNodeType() Deprecated. Returns the current node type
String	getOS() Deprecated. Returns the current operating system string
int	getParentId() Deprecated. Returns the id of the parent.
static DbIpInterfaceEntry	getPrimarySnmpInterface(DbIpInterfaceEntry[] ipInterfaces) Deprecated.
DbSnmpInterfaceEntry[]	getSnmpInterfaces() Deprecated.
DbSnmpInterfaceEntry[]	getSnmpInterfaces(Connection db) Deprecated.
String	getSystemContact() Deprecated. Returns the current system contact.
String	getSystemDescription() Deprecated. Returns the current system description
String	getSystemLocation() Deprecated. Returns the current system location
String	getSystemName() Deprecated. Gets the current system name
String	getSystemOID() Deprecated. Returns the current SNMP system object id, if any.
boolean	hasDomainNameChanged() Deprecated.
boolean	hasForeignId() Deprecated.
boolean	hasForeignSource() Deprecated.
boolean	hasLabelChanged() Deprecated.
boolean	hasLabelSourceChanged() Deprecated.
boolean	hasNetBIOSNameChanged() Deprecated.
boolean	hasNodeTypeChanged() Deprecated.
boolean	hasOSChanged() Deprecated.
boolean	hasParentId() Deprecated. Returns true if the entry has a parent identity.
boolean	hasParentIdChanged() Deprecated.
boolean	hasSystemContactChanged() Deprecated.
boolean	hasSystemDescriptionChanged() Deprecated.
boolean	hasSystemLocationChanged() Deprecated.
boolean	hasSystemNameChanged() Deprecated.
boolean	hasSystemOIDChanged() Deprecated.
void	setCreationTime(Date time) Deprecated. Sets the current creation time.
void	setCreationTime(String time) Deprecated. Sets the current creation time.
void	setCreationTime(Timestamp time) Deprecated. Sets the current creation time.
void	setDomainName(String domain) Deprecated. Sets the current domain name.
void	setForeignId(String foreignId) Deprecated. Sets the current NetBIOS name.
void	setForeignSource(String foreignSource) Deprecated. Sets the current NetBIOS name.
void	setLabel(String label) Deprecated. Sets the current label for the entry.
void	setLabelSource(char src) Deprecated. Sets the source of the node's label.
void	setLastPoll(Date time) Deprecated. Sets the last poll time.
void	setLastPoll(String time) Deprecated. Sets the last poll time.
void	setLastPoll(Timestamp time) Deprecated. Sets the last poll time.
void	setNetBIOSName(String name) Deprecated. Sets the current NetBIOS name.
void	setNodeType(char type) Deprecated. Sets the node type
void	setOS(String os) Deprecated. Sets the current operating system string.
void	setParentId(int id) Deprecated. Sets the id of the parent.
void	setSystemContact(String contact) Deprecated. Sets the current system contact.
void	setSystemDescription(String descr) Deprecated. Sets the current system description
void	setSystemLocation(String loc) Deprecated. Sets the current system location.
void	setSystemName(String name) Deprecated. Sets the current system name.
void	setSystemOID(String oid) Deprecated. Sets the current SNMP system object id.
void	store() Deprecated. Updates the node information in the configured database.
void	store(Connection db) Deprecated. Updates the node information in the configured database.
String	toString() Deprecated. Creates a string that displays the internal contents of the record.
boolean	updateDomainName(String domain) Deprecated.
boolean	updateForeignId(String newForeignId) Deprecated.
boolean	updateForeignSource(String newForeignSource) Deprecated.
boolean	updateLabel(String newlabel) Deprecated.
boolean	updateLabelSource(char newlabelSource) Deprecated.
boolean	updateNetBIOSName(String newnbName) Deprecated.
boolean	updateNodeType(char newtype) Deprecated.
boolean	updateOS(String newos) Deprecated.
boolean	updateParentId(int newparentId) Deprecated.
boolean	updateSystemContact(String newsyscontact) Deprecated.
boolean	updateSystemDescription(String newsysdescr) Deprecated.
boolean	updateSystemLocation(String newsyslocation) Deprecated.
boolean	updateSystemName(String newsysname) Deprecated.
boolean	updateSystemOID(String newsysoid) Deprecated. Update the value of sysoid associated with this node entry.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_TYPE_ACTIVE

public static final char NODE_TYPE_ACTIVE

Deprecated.

The character returned if the node is active

See Also:

Constant Field Values

NODE_TYPE_DELETED

public static final char NODE_TYPE_DELETED

Deprecated.

The character returned if the node is deleted

See Also:

Constant Field Values

NODE_TYPE_UNKNOWN

public static final char NODE_TYPE_UNKNOWN

Deprecated.

The character returned if the node type is unset/unknown.

See Also:

Constant Field Values

LABEL_SOURCE_USER

public static final char LABEL_SOURCE_USER

Deprecated.

Label source set by user

See Also:

Constant Field Values

LABEL_SOURCE_NETBIOS

public static final char LABEL_SOURCE_NETBIOS

Deprecated.

Label source set by netbios

See Also:

Constant Field Values

LABEL_SOURCE_HOSTNAME

public static final char LABEL_SOURCE_HOSTNAME

Deprecated.

Label source set by hostname

See Also:

Constant Field Values

LABEL_SOURCE_SYSNAME

public static final char LABEL_SOURCE_SYSNAME

Deprecated.

Label source set by SNMP sysname

See Also:

Constant Field Values

LABEL_SOURCE_ADDRESS

public static final char LABEL_SOURCE_ADDRESS

Deprecated.

Label source set by IP Address

See Also:

Constant Field Values

LABEL_SOURCE_UNKNOWN

public static final char LABEL_SOURCE_UNKNOWN

Deprecated.

Label source unset/unknown

See Also:

Constant Field Values

Method Detail

getNodeId

public int 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.

getDistributedPollerName

public String getDistributedPollerName()

Deprecated.

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

getCreationTime

public Timestamp getCreationTime()

Deprecated.

Gets the creation time of the record.

getFormattedCreationTime

public String getFormattedCreationTime()

Deprecated.

Gets the creation time of the record.

setCreationTime

public void setCreationTime(String time)
                     throws ParseException

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

Throws:

ParseException

setCreationTime

public void setCreationTime(Date time)

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

setCreationTime

public void setCreationTime(Timestamp time)

Deprecated.

Sets the current creation time.

Parameters:

time - The creation time.

hasParentId

public boolean hasParentId()

Deprecated.

Returns true if the entry has a parent identity.

getParentId

public int getParentId()

Deprecated.

Returns the id of the parent.

setParentId

public void setParentId(int id)

Deprecated.

Sets the id of the parent.

Parameters:

id - The new parent id.

hasParentIdChanged

public boolean hasParentIdChanged()

Deprecated.

updateParentId

public boolean updateParentId(int newparentId)

Deprecated.

getNodeType

public char getNodeType()

Deprecated.

Returns the current node type

setNodeType

public void setNodeType(char type)

Deprecated.

Sets the node type

Parameters:

type - The new node type.

hasNodeTypeChanged

public boolean hasNodeTypeChanged()

Deprecated.

updateNodeType

public boolean updateNodeType(char newtype)

Deprecated.

getSystemOID

public String getSystemOID()

Deprecated.

Returns the current SNMP system object id, if any.

setSystemOID

public void setSystemOID(String oid)

Deprecated.

Sets the current SNMP system object id.

hasSystemOIDChanged

public boolean hasSystemOIDChanged()

Deprecated.

updateSystemOID

public boolean updateSystemOID(String newsysoid)

Deprecated.

Update the value of sysoid associated with this node entry.

getSystemName

public String getSystemName()

Deprecated.

Gets the current system name

setSystemName

public void setSystemName(String name)

Deprecated.

Sets the current system name.

Parameters:

name - The new system name

hasSystemNameChanged

public boolean hasSystemNameChanged()

Deprecated.

updateSystemName

public boolean updateSystemName(String newsysname)

Deprecated.

getSystemDescription

public String getSystemDescription()

Deprecated.

Returns the current system description

setSystemDescription

public void setSystemDescription(String descr)

Deprecated.

Sets the current system description

Parameters:

descr - The new system description.

hasSystemDescriptionChanged

public boolean hasSystemDescriptionChanged()

Deprecated.

updateSystemDescription

public boolean updateSystemDescription(String newsysdescr)

Deprecated.

getSystemLocation

public String getSystemLocation()

Deprecated.

Returns the current system location

setSystemLocation

public void setSystemLocation(String loc)

Deprecated.

Sets the current system location.

Parameters:

loc - The new location

hasSystemLocationChanged

public boolean hasSystemLocationChanged()

Deprecated.

updateSystemLocation

public boolean updateSystemLocation(String newsyslocation)

Deprecated.

getSystemContact

public String getSystemContact()

Deprecated.

Returns the current system contact.

setSystemContact

public void setSystemContact(String contact)

Deprecated.

Sets the current system contact.

Parameters:

contact - The new system contact

hasSystemContactChanged

public boolean hasSystemContactChanged()

Deprecated.

updateSystemContact

public boolean updateSystemContact(String newsyscontact)

Deprecated.

getLabel

public String getLabel()

Deprecated.

Returns the entry's label.

setLabel

public void setLabel(String label)

Deprecated.

Sets the current label for the entry.

Parameters:

label - The new label.

hasLabelChanged

public boolean hasLabelChanged()

Deprecated.

updateLabel

public boolean updateLabel(String newlabel)

Deprecated.

getLabelSource

public char getLabelSource()

Deprecated.

Returns the current label source.

setLabelSource

public void setLabelSource(char src)

Deprecated.

Sets the source of the node's label.

Parameters:

src - The new label source.

hasLabelSourceChanged

public boolean hasLabelSourceChanged()

Deprecated.

updateLabelSource

public boolean updateLabelSource(char newlabelSource)

Deprecated.

getNetBIOSName

public String getNetBIOSName()

Deprecated.

Returns the current NetBIOS name.

setNetBIOSName

public void setNetBIOSName(String name)

Deprecated.

Sets the current NetBIOS name.

Parameters:

name - The new NetBIOS name.

hasNetBIOSNameChanged

public boolean hasNetBIOSNameChanged()

Deprecated.

updateNetBIOSName

public boolean updateNetBIOSName(String newnbName)

Deprecated.

getDomainName

public String getDomainName()

Deprecated.

Returns the current domain name.

setDomainName

public void setDomainName(String domain)

Deprecated.

Sets the current domain name.

Parameters:

domain - The new domain name.

hasDomainNameChanged

public boolean hasDomainNameChanged()

Deprecated.

updateDomainName

public boolean updateDomainName(String domain)

Deprecated.

getOS

public String getOS()

Deprecated.

Returns the current operating system string

setOS

public void setOS(String os)

Deprecated.

Sets the current operating system string.

Parameters:

os - The OS string

hasOSChanged

public boolean hasOSChanged()

Deprecated.

updateOS

public boolean updateOS(String newos)

Deprecated.

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 last poll time.

Parameters:

time - The last poll time.

Throws:

ParseException

setLastPoll

public void setLastPoll(Date time)

Deprecated.

Sets the last poll time.

Parameters:

time - The last poll time.

setLastPoll

public void setLastPoll(Timestamp time)

Deprecated.

Sets the last poll time.

Parameters:

time - The last poll time.

getForeignSource

public String getForeignSource()

Deprecated.

Returns the current foreignSource.

setForeignSource

public void setForeignSource(String foreignSource)

Deprecated.

Sets the current NetBIOS name.

Parameters:

name - The new NetBIOS name.

hasForeignSource

public boolean hasForeignSource()

Deprecated.

updateForeignSource

public boolean updateForeignSource(String newForeignSource)

Deprecated.

getForeignId

public String getForeignId()

Deprecated.

Returns the current foreignSource.

setForeignId

public void setForeignId(String foreignId)

Deprecated.

Sets the current NetBIOS name.

Parameters:

name - The new NetBIOS name.

hasForeignId

public boolean hasForeignId()

Deprecated.

updateForeignId

public boolean updateForeignId(String newForeignId)

Deprecated.

store

public void store()
           throws SQLException

Deprecated.

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

getInterfaces

public DbIpInterfaceEntry[] getInterfaces()
                                   throws SQLException

Deprecated.

Throws:

SQLException

getInterfaces

public DbIpInterfaceEntry[] getInterfaces(Connection db)
                                   throws SQLException

Deprecated.

Throws:

SQLException

getManagedInterfaces

public DbIpInterfaceEntry[] getManagedInterfaces()
                                          throws SQLException

Deprecated.

Throws:

SQLException

getManagedInterfaces

public DbIpInterfaceEntry[] getManagedInterfaces(Connection db)
                                          throws SQLException

Deprecated.

Throws:

SQLException

getPrimarySnmpInterface

public static DbIpInterfaceEntry getPrimarySnmpInterface(DbIpInterfaceEntry[] ipInterfaces)

Deprecated.

getSnmpInterfaces

public DbSnmpInterfaceEntry[] getSnmpInterfaces()
                                         throws SQLException

Deprecated.

Throws:

SQLException

getSnmpInterfaces

public DbSnmpInterfaceEntry[] getSnmpInterfaces(Connection db)
                                         throws SQLException

Deprecated.

Throws:

SQLException

create

public static DbNodeEntry create()

Deprecated.

Creates a new entry. The entry is created in memory, but is not written to the database until the first call to store.

Returns:

A new node record.

create

public static DbNodeEntry create(String poller)

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:

poller - The name of the distributed poller to use.

Returns:

A new node record.

clone

public static DbNodeEntry clone(DbNodeEntry entry)

Deprecated.

Clones an existing entry.

Parameters:

entry - The entry to be cloned

Returns:

a new DbNodeEntry identical to the original

get

public static DbNodeEntry get(int nid)
                       throws SQLException

Deprecated.

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

Parameters:

nid - The node id key

Returns:

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

Throws:

SQLException

get

public static DbNodeEntry get(int nid,
              String dpName)
                       throws SQLException

Deprecated.

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

Parameters:

nid - The node id key

Returns:

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

Throws:

SQLException

get

public static DbNodeEntry get(Connection db,
              int nid)
                       throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and dpName. 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

Returns:

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

Throws:

SQLException

get

public static DbNodeEntry get(Connection db,
              int nid,
              String dpName)
                       throws SQLException

Deprecated.

Retrieves a current record from the database based upon the key fields of nodeID and dpName. 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

dpName - The distribute poller name key

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.

createAssetNodeEntry

public void createAssetNodeEntry(Connection conn,
                        int nodeid)
                          throws SQLException

Deprecated.

Creates a null entry for a nodeid into the assets table

Parameters:

conn - a Connection object.

nodeid - a int.

Throws:

SQLException - if any.