org.opennms.netmgt.capsd

Class DbIfServiceEntry

java.lang.Object

org.opennms.netmgt.capsd.DbIfServiceEntry

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 DbIfServiceEntry
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 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	NOTIFY_ON Deprecated.
static char	SOURCE_PLUGIN Deprecated.
static char	STATUS_ACTIVE Deprecated. Constant STATUS_ACTIVE='A'
static char	STATUS_DELETED Deprecated. Constant STATUS_DELETED='D'
static char	STATUS_FORCED Deprecated. Constant STATUS_FORCED='F'
static char	STATUS_NOT_POLLED Deprecated. Constant STATUS_NOT_POLLED='N'
static char	STATUS_REMOTE Deprecated. Constant STATUS_REMOTE='X'
static char	STATUS_RESUME Deprecated. Constant STATUS_RESUME='R'
static char	STATUS_SUSPEND Deprecated. Constant STATUS_SUSPEND='S'
static char	STATUS_UNKNOWN Deprecated. Constant STATUS_UNKNOWN=' '
static char	STATUS_UNMANAGED Deprecated. Constant STATUS_UNMANAGED='U'

Method Summary

Modifier and Type	Method and Description
static DbIfServiceEntry	create(int nid, InetAddress address, int sid) Deprecated. Creates a new entry.
static DbIfServiceEntry	get(Connection db, long nodeId, InetAddress addr, int sid) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
static DbIfServiceEntry	get(int nid, InetAddress addr, int sid) Deprecated. Retrieves a current record from the database based upon the key fields of nodeID and ipAddr.
InetAddress	getIfAddress() Deprecated. Returns the name of the distributed poller for the entry.
int	getIfIndex() Deprecated. Returns the current ifIndex
Timestamp	getLastFail() Deprecated. Gets the last fail poll time of the record
String	getLastFailString() Deprecated. Gets the last fail poll time of the record
Timestamp	getLastGood() Deprecated. Gets the last good poll time of the record
String	getLastGoodString() Deprecated. Gets the last good poll time of the record
long	getNodeId() Deprecated. Returns the node entry's unique identifier.
char	getNotify() Deprecated. Gets the notification state.
String	getQualifier() Deprecated.
int	getServiceId() Deprecated. Returns the service id of this service entry.
char	getSource() Deprecated. Gets the source of the interface service.
char	getStatus() Deprecated. Gets the current operational status field
boolean	hasIfIndex() Deprecated. Returns true if the ifIndex is defined.
boolean	hasIfIndexChanged() Deprecated.
boolean	hasNotifyChanged() Deprecated.
boolean	hasQualifierChanged() Deprecated.
boolean	hasSourceChanged() Deprecated.
boolean	hasStatusChanged() Deprecated.
static void	main(String[] args) Deprecated. For debugging only
void	setIfIndex(int ndx) Deprecated. Sets the ifIndex value
void	setLastFail(Date time) Deprecated. Sets the current last fail poll time.
void	setLastFail(String time) Deprecated. Sets the current last fail poll time
void	setLastFail(Timestamp time) Deprecated. Sets the current last fail poll time.
void	setLastGood(Date time) Deprecated. Sets the current last good poll time.
void	setLastGood(String time) Deprecated. Sets the current last good poll time
void	setLastGood(Timestamp time) Deprecated. Sets the current last good poll time.
void	setNotify(char notify) Deprecated. Sets the notification state
void	setQualifier(String qualifier) Deprecated.
void	setSource(char src) Deprecated. Sets the source of the interface service
void	setStatus(char status) Deprecated. Sets the current status of the service
void	store() Deprecated. Updates the interface information in the configured database.
void	store(Connection db) Deprecated. Updates the interface information in the configured database.
void	store(Connection db, boolean noRollback) Deprecated.
String	toString() Deprecated. Creates a string that displays the internal contents of the record.
boolean	updateIfIndex(int newIfIndex) Deprecated.
boolean	updateNotify(char newNotify) Deprecated.
boolean	updateQualifier(String newQualifier) Deprecated.
boolean	updateSource(char newSource) Deprecated.
boolean	updateStatus(char newStatus) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_UNMANAGED

public static final char STATUS_UNMANAGED

Deprecated.

Constant STATUS_UNMANAGED='U'

See Also:

Constant Field Values

STATUS_ACTIVE

public static final char STATUS_ACTIVE

Deprecated.

Constant STATUS_ACTIVE='A'

See Also:

Constant Field Values

STATUS_DELETED

public static final char STATUS_DELETED

Deprecated.

Constant STATUS_DELETED='D'

See Also:

Constant Field Values

STATUS_FORCED

public static final char STATUS_FORCED

Deprecated.

Constant STATUS_FORCED='F'

See Also:

Constant Field Values

STATUS_NOT_POLLED

public static final char STATUS_NOT_POLLED

Deprecated.

Constant STATUS_NOT_POLLED='N'

See Also:

Constant Field Values

STATUS_UNKNOWN

public static final char STATUS_UNKNOWN

Deprecated.

Constant STATUS_UNKNOWN=' '

See Also:

Constant Field Values

STATUS_SUSPEND

public static final char STATUS_SUSPEND

Deprecated.

Constant STATUS_SUSPEND='S'

See Also:

Constant Field Values

STATUS_RESUME

public static final char STATUS_RESUME

Deprecated.

Constant STATUS_RESUME='R'

See Also:

Constant Field Values

STATUS_REMOTE

public static final char STATUS_REMOTE

Deprecated.

Constant STATUS_REMOTE='X'

See Also:

Constant Field Values

SOURCE_PLUGIN

public static final char SOURCE_PLUGIN

Deprecated.

See Also:

Constant Field Values

NOTIFY_ON

public static final char NOTIFY_ON

Deprecated.

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.

getServiceId

public int getServiceId()

Deprecated.

Returns the service id of this service entry.

getLastGoodString

public String getLastGoodString()

Deprecated.

Gets the last good poll time of the record

getLastGood

public Timestamp getLastGood()

Deprecated.

Gets the last good poll time of the record

setLastGood

public void setLastGood(String time)
                 throws ParseException

Deprecated.

Sets the current last good poll time

Parameters:

time - The poll time.

Throws:

ParseException

setLastGood

public void setLastGood(Date time)

Deprecated.

Sets the current last good poll time.

Parameters:

time - The poll time.

setLastGood

public void setLastGood(Timestamp time)

Deprecated.

Sets the current last good poll time.

Parameters:

time - The poll time.

getLastFailString

public String getLastFailString()

Deprecated.

Gets the last fail poll time of the record

getLastFail

public Timestamp getLastFail()

Deprecated.

Gets the last fail poll time of the record

setLastFail

public void setLastFail(String time)
                 throws ParseException

Deprecated.

Sets the current last fail poll time

Parameters:

time - The poll time.

Throws:

ParseException

setLastFail

public void setLastFail(Date time)

Deprecated.

Sets the current last fail poll time.

Parameters:

time - The poll time.

setLastFail

public void setLastFail(Timestamp time)

Deprecated.

Sets the current last fail poll time.

Parameters:

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

getStatus

public char getStatus()

Deprecated.

Gets the current operational status field

setStatus

public void setStatus(char status)

Deprecated.

Sets the current status of the service

Parameters:

status - The new status.

hasStatusChanged

public boolean hasStatusChanged()

Deprecated.

updateStatus

public boolean updateStatus(char newStatus)

Deprecated.

getSource

public char getSource()

Deprecated.

Gets the source of the interface service.

setSource

public void setSource(char src)

Deprecated.

Sets the source of the interface service

hasSourceChanged

public boolean hasSourceChanged()

Deprecated.

updateSource

public boolean updateSource(char newSource)

Deprecated.

getNotify

public char getNotify()

Deprecated.

Gets the notification state.

setNotify

public void setNotify(char notify)

Deprecated.

Sets the notification state

hasNotifyChanged

public boolean hasNotifyChanged()

Deprecated.

updateNotify

public boolean updateNotify(char newNotify)

Deprecated.

getQualifier

public String getQualifier()

Deprecated.

setQualifier

public void setQualifier(String qualifier)

Deprecated.

hasQualifierChanged

public boolean hasQualifierChanged()

Deprecated.

updateQualifier

public boolean updateQualifier(String newQualifier)

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

store

public void store(Connection db,
                  boolean noRollback)
           throws SQLException

Deprecated.

Throws:

SQLException

create

public static DbIfServiceEntry create(int nid,
                                      InetAddress address,
                                      int sid)

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.

sid - The service id for the interface.

Returns:

A new interface record.

get

public static DbIfServiceEntry get(int nid,
                                   InetAddress addr,
                                   int sid)
                            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.

sid - The service id.

Returns:

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

Throws:

SQLException

get

public static DbIfServiceEntry get(Connection db,
                                   long nodeId,
                                   InetAddress addr,
                                   int sid)
                            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.

nodeId - The node id key

addr - The IP address.

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.