org.opennms.netmgt.config

Class SnmpEventInfo

java.lang.Object

org.opennms.netmgt.config.SnmpEventInfo

public class SnmpEventInfo
extends Object

Class for handling data passed as parms in a configureSNMP event. Provides for generating a config package based SNMP Definition class for merging into a current running config.

Author:

David Hustace

Constructor Summary

Constructors

Constructor and Description
SnmpEventInfo() Default constructor
SnmpEventInfo(Event event) Constructor for SnmpEventInfo.

Method Summary

Methods

Modifier and Type	Method and Description
Definition	createDef() Creates an SNMP config definition representing the data in this class.
String	getCommunityString() getCommunityString
String	getFirstIPAddress() getFirstIPAddress
String	getLastIPAddress() getLastIPAddress
int	getPort() getPort
Range	getRange() getRange
int	getRetryCount() getRetryCount
int	getTimeout() getTimeout
String	getVersion() getVersion
boolean	isSpecific() Determines if the configureSNMP event is for a specific address.
void	setCommunityString(String communityString) setCommunityString
void	setFirstIPAddress(InetAddress firstIPAddress) setFirstIPAddress
void	setFirstIPAddress(String firstIPAddress) setFirstIPAddress
void	setLastIPAddress(InetAddress lastIPAddress) setLastIPAddress
void	setLastIPAddress(String lastIPAddress) setLastIPAddress
void	setPort(int port) setPort
void	setRetryCount(int retryCount) setRetryCount
void	setTimeout(int timeout) setTimeout
void	setVersion(String version) setVersion
String	toString() toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpEventInfo

public SnmpEventInfo()

Default constructor

SnmpEventInfo

public SnmpEventInfo(Event event)

Constructor for SnmpEventInfo.

Parameters:

event - a Event object.

Method Detail

getCommunityString

public String getCommunityString()

getCommunityString

Returns:

a String object.

setCommunityString

public void setCommunityString(String communityString)

setCommunityString

Parameters:

communityString - a String object.

getFirstIPAddress

public String getFirstIPAddress()

getFirstIPAddress

Returns:

a String object.

setFirstIPAddress

public void setFirstIPAddress(String firstIPAddress)
                       throws UnknownHostException

setFirstIPAddress

Parameters:

firstIPAddress - a String object.

Throws:

UnknownHostException - if any.

setFirstIPAddress

public void setFirstIPAddress(InetAddress firstIPAddress)

setFirstIPAddress

Parameters:

firstIPAddress - a InetAddress object.

getLastIPAddress

public String getLastIPAddress()

getLastIPAddress

Returns:

a String object.

setLastIPAddress

public void setLastIPAddress(String lastIPAddress)
                      throws UnknownHostException

setLastIPAddress

Parameters:

lastIPAddress - a String object.

Throws:

UnknownHostException - if any.

setLastIPAddress

public void setLastIPAddress(InetAddress lastIPAddress)

setLastIPAddress

Parameters:

lastIPAddress - a InetAddress object.

getRange

public Range getRange()

getRange

Returns:

a org.opennms.netmgt.config.common.Range object.

getRetryCount

public int getRetryCount()

getRetryCount

Returns:

a int.

setRetryCount

public void setRetryCount(int retryCount)

setRetryCount

Parameters:

retryCount - a int.

getTimeout

public int getTimeout()

getTimeout

Returns:

a int.

setTimeout

public void setTimeout(int timeout)

setTimeout

Parameters:

timeout - a int.

getVersion

public String getVersion()

getVersion

Returns:

a String object.

setVersion

public void setVersion(String version)

setVersion

Parameters:

version - a String object.

getPort

public int getPort()

getPort

Returns:

a int.

setPort

public void setPort(int port)

setPort

Parameters:

port - a int.

createDef

public Definition createDef()

Creates an SNMP config definition representing the data in this class. The defintion will either have one specific IP element or one Range element.

Returns:

a Definition object.

isSpecific

public boolean isSpecific()

Determines if the configureSNMP event is for a specific address.

Returns:

true if there is no last IP address specified or if first and last are equal

toString

public String toString()

toString

Overrides:

toString in class Object

Returns:

a String object.