org.opennms.netmgt.collection.api

Interface CollectionAgent

All Known Subinterfaces:

SnmpCollectionAgent

All Known Implementing Classes:

CollectionAgentDTO, DefaultCollectionAgent, DefaultSnmpCollectionAgent, MockCollectionAgent

public interface CollectionAgent

CollectionAgent interface.

Version:

$Id: $

Author:

Mathew Brozowski

Method Summary

Modifier and Type	Method and Description
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
Object	setAttribute(String property, Object value) This method is used to associate an object value with a textual key.
void	setSavedSysUpTime(long sysUpTime) setSavedSysUpTime

Method Detail

getAddress

InetAddress getAddress()

Returns the address information for the interface.

Returns:

a Object object.

getAttributeNames

Set<String> getAttributeNames()

Retrieves the names of all available attributes.

Returns:

a Set that contains the name of all configured attributes

getAttribute

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

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

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.

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

Boolean isStoreByForeignSource()

isStoreByForeignSource

Returns:

a Boolean object.

getHostAddress

String getHostAddress()

getHostAddress

Returns:

a String object.

getNodeId

int getNodeId()

getNodeId

Returns:

a int.

getNodeLabel

String getNodeLabel()

getNodeLabel

Returns:

a String object.

getForeignSource

String getForeignSource()

getForeignSource

Returns:

a String object.

getForeignId

String getForeignId()

getForeignId

Returns:

a String object.

getLocationName

String getLocationName()

getLocationName

Returns:

a String object.

getStorageResourcePath

ResourcePath getStorageResourcePath()

getSavedSysUpTime

long getSavedSysUpTime()

getSavedSysUpTime

Returns:

a long.

setSavedSysUpTime

void setSavedSysUpTime(long sysUpTime)

setSavedSysUpTime

Parameters:

sysUpTime - a long.