Package org.opennms.netmgt.collection.core

Class DefaultCollectionAgent

java.lang.Object

org.opennms.netmgt.collection.core.DefaultCollectionAgent

All Implemented Interfaces:

CollectionAgent

Direct Known Subclasses:

DefaultSnmpCollectionAgent

public class DefaultCollectionAgent
extends Object
implements CollectionAgent

Represents a remote agent on a specific IPv4 interface.

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionAgentService	m_agentService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCollectionAgent(CollectionAgentService agentService, String location)

Method Summary

Modifier and Type	Method	Description
static CollectionAgent	create(Integer ifaceId, IpInterfaceDao ifaceDao, org.springframework.transaction.PlatformTransactionManager transMgr)	create
static CollectionAgent	create(Integer ifaceId, IpInterfaceDao ifaceDao, org.springframework.transaction.PlatformTransactionManager transMgr, String location)
InetAddress	getAddress()	Returns the address information for the interface.
<V> V	getAttribute(String property)	This method is used to return the object that is associated with the property name.
Set<String>	getAttributeNames()	Retrieves the names of all available attributes.
String	getForeignId()	getForeignId
String	getForeignSource()	getForeignSource
String	getHostAddress()	getHostAddress
String	getLocationName()	getLocationName
int	getNodeId()	getNodeId
String	getNodeLabel()	getNodeLabel
long	getSavedSysUpTime()	getSavedSysUpTime
ResourcePath	getStorageResourcePath()
Boolean	isStoreByForeignSource()	isStoreByForeignSource
protected void	logCollectionParms()
protected void	logCompletion()
Object	setAttribute(String property, Object value)	This method is used to associate an object value with a textual key.
void	setSavedSysUpTime(long sysUpTime)	setSavedSysUpTime
String	toString()	toString

Methods inherited from class java.lang.Object

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

Field Detail

m_agentService

protected CollectionAgentService m_agentService

Constructor Detail

DefaultCollectionAgent

protected DefaultCollectionAgent(CollectionAgentService agentService,
                                 String location)

Method Detail

create

public static CollectionAgent create(Integer ifaceId,
                                     IpInterfaceDao ifaceDao,
                                     org.springframework.transaction.PlatformTransactionManager transMgr)

create

Parameters:

ifaceId - a Integer object.

ifaceDao - a IpInterfaceDao object.

transMgr - a PlatformTransactionManager object.

Returns:

a CollectionAgent object.

create

public static CollectionAgent create(Integer ifaceId,
                                     IpInterfaceDao ifaceDao,
                                     org.springframework.transaction.PlatformTransactionManager transMgr,
                                     String location)

getAddress

public final InetAddress getAddress()

Returns the address information for the interface.

Specified by:

getAddress in interface CollectionAgent

Returns:

a Object object.

getAttributeNames

public final Set<String> getAttributeNames()

Description copied from interface: CollectionAgent

Retrieves the names of all available attributes.

Specified by:

getAttributeNames in interface CollectionAgent

Returns:

a Set that contains the name of all configured attributes

getAttribute

public final <V> V getAttribute(String property)

This method is used to return the object that is associated with the property name. This is very similar to the java.util.Map get() method, but requires that the lookup be performed using a String name. The object may be of any instance that the monitor previous stored.

If there is no matching object for the property key, then a null pointer is returned to the application.

This method is used to return the object that is associated with the property name. This is very similar to the java.util.Map get() method, but requires that the lookup be performed using a String name. The object may be of any instance that the monitor previous stored.

If there is no matching object for the property key, then a null pointer is returned to the application.

Specified by:

getAttribute in interface CollectionAgent

Parameters:

property - The key for the lookup.

Returns:

The resulting value for the key, null if no value exist.

Throws:

IllegalArgumentException - Thrown if the passed key is empty or null.

See Also:

Map.get(java.lang.Object)

setAttribute

public final Object setAttribute(String property,
                                 Object value)

This method is used to associate an object value with a textual key. If a previous value was associated with the key then the old value is returned to the caller. This is identical to the behavior defined by the java.util.Map put() method. The only restriction is that the key must be a java string instance.

This method is used to associate an object value with a textual key. If a previous value was associated with the key then the old value is returned to the caller. This is identical to the behavior defined by the java.util.Map put() method. The only restriction is that the key must be a java string instance.

Specified by:

setAttribute in interface CollectionAgent

Parameters:

property - The key

value - The value to associate with the key

Returns:

The object that was previously associated with the key. Null is returned if there was no previous value associated.

Throws:

IllegalArgumentException - Thrown if the property name is empty or null.

See Also:

Map.put(java.lang.Object, java.lang.Object)

isStoreByForeignSource

public final Boolean isStoreByForeignSource()

isStoreByForeignSource

Specified by:

isStoreByForeignSource in interface CollectionAgent

Returns:

a Boolean object.

getHostAddress

public final String getHostAddress()

getHostAddress

Specified by:

getHostAddress in interface CollectionAgent

Returns:

a String object.

getNodeId

public final int getNodeId()

getNodeId

Specified by:

getNodeId in interface CollectionAgent

Returns:

a int.

getNodeLabel

public final String getNodeLabel()

getNodeLabel

Specified by:

getNodeLabel in interface CollectionAgent

Returns:

a String object.

getForeignSource

public final String getForeignSource()

getForeignSource

Specified by:

getForeignSource in interface CollectionAgent

Returns:

a String object.

getForeignId

public final String getForeignId()

getForeignId

Specified by:

getForeignId in interface CollectionAgent

Returns:

a String object.

getLocationName

public final String getLocationName()

Description copied from interface: CollectionAgent

getLocationName

Specified by:

getLocationName in interface CollectionAgent

Returns:

a String object.

getStorageResourcePath

public final ResourcePath getStorageResourcePath()

Specified by:

getStorageResourcePath in interface CollectionAgent

logCompletion

protected void logCompletion()

logCollectionParms

protected void logCollectionParms()

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.

getSavedSysUpTime

public final long getSavedSysUpTime()

getSavedSysUpTime

Specified by:

getSavedSysUpTime in interface CollectionAgent

Returns:

a long.

setSavedSysUpTime

public final void setSavedSysUpTime(long sysUpTime)

setSavedSysUpTime

Specified by:

setSavedSysUpTime in interface CollectionAgent

Parameters:

sysUpTime - a long.