org.opennms.netmgt.config.snmp
Class Definition

java.lang.Object
  org.opennms.netmgt.config.snmp.Definition

All Implemented Interfaces:

Serializable

public class Definition
extends Object
implements Serializable

Provides a mechanism for associating one or more specific IP addresses and/or IP address ranges with a set of SNMP parms which will be used in place of the default values during SNMP data collection.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Definition()

Method Summary

void	addIpMatch(int index, String vIpMatch)
void	addIpMatch(String vIpMatch)
void	addRange(int index, Range vRange)
void	addRange(Range vRange)
void	addSpecific(int index, String vSpecific)
void	addSpecific(String vSpecific)
void	deleteMaxRepetitions()
void	deleteMaxRequestSize()
void	deleteMaxVarsPerPdu()
void	deletePort()
void	deleteRetry()
void	deleteTimeout()
Enumeration<String>	enumerateIpMatch() Method enumerateIpMatch.
Enumeration<Range>	enumerateRange() Method enumerateRange.
Enumeration<String>	enumerateSpecific() Method enumerateSpecific.
String	getAuthPassphrase() Returns the value of field 'authPassphrase'.
String	getAuthProtocol() Returns the value of field 'authProtocol'.
String	getContextEngineId() Returns the value of field 'contextEngineId'.
String	getContextName() Returns the value of field 'contextName'.
String	getEngineId() Returns the value of field 'engineId'.
String	getEnterpriseId() Returns the value of field 'enterpriseId'.
String[]	getIpMatch() Method getIpMatch.Returns the contents of the collection in an Array.
String	getIpMatch(int index) Method getIpMatch.
List<String>	getIpMatchCollection() Method getIpMatchCollection.Returns a reference to '_ipMatchList'.
int	getIpMatchCount() Method getIpMatchCount.
int	getMaxRepetitions() Returns the value of field 'maxRepetitions'.
int	getMaxRequestSize() Returns the value of field 'maxRequestSize'.
int	getMaxVarsPerPdu() Returns the value of field 'maxVarsPerPdu'.
int	getPort() Returns the value of field 'port'.
String	getPrivacyPassphrase() Returns the value of field 'privacyPassphrase'.
String	getPrivacyProtocol() Returns the value of field 'privacyProtocol'.
String	getProxyHost() Returns the value of field 'proxyHost'.
Range[]	getRange() Method getRange.Returns the contents of the collection in an Array.
Range	getRange(int index) Method getRange.
List<Range>	getRangeCollection() Method getRangeCollection.Returns a reference to '_rangeList'.
int	getRangeCount() Method getRangeCount.
String	getReadCommunity() Returns the value of field 'readCommunity'.
int	getRetry() Returns the value of field 'retry'.
String	getSecurityName() Returns the value of field 'securityName'.
String[]	getSpecific() Method getSpecific.Returns the contents of the collection in an Array.
String	getSpecific(int index) Method getSpecific.
List<String>	getSpecificCollection() Method getSpecificCollection.Returns a reference to '_specificList'.
int	getSpecificCount() Method getSpecificCount.
int	getTimeout() Returns the value of field 'timeout'.
String	getVersion() Returns the value of field 'version'.
String	getWriteCommunity() Returns the value of field 'writeCommunity'.
boolean	hasMaxRepetitions() Method hasMaxRepetitions.
boolean	hasMaxRequestSize() Method hasMaxRequestSize.
boolean	hasMaxVarsPerPdu() Method hasMaxVarsPerPdu.
boolean	hasPort() Method hasPort.
boolean	hasRetry() Method hasRetry.
boolean	hasTimeout() Method hasTimeout.
boolean	isValid() Method isValid.
Iterator<String>	iterateIpMatch() Method iterateIpMatch.
Iterator<Range>	iterateRange() Method iterateRange.
Iterator<String>	iterateSpecific() Method iterateSpecific.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllIpMatch()
void	removeAllRange()
void	removeAllSpecific()
boolean	removeIpMatch(String vIpMatch) Method removeIpMatch.
String	removeIpMatchAt(int index) Method removeIpMatchAt.
boolean	removeRange(Range vRange) Method removeRange.
Range	removeRangeAt(int index) Method removeRangeAt.
boolean	removeSpecific(String vSpecific) Method removeSpecific.
String	removeSpecificAt(int index) Method removeSpecificAt.
void	setAuthPassphrase(String authPassphrase) Sets the value of field 'authPassphrase'.
void	setAuthProtocol(String authProtocol) Sets the value of field 'authProtocol'.
void	setContextEngineId(String contextEngineId) Sets the value of field 'contextEngineId'.
void	setContextName(String contextName) Sets the value of field 'contextName'.
void	setEngineId(String engineId) Sets the value of field 'engineId'.
void	setEnterpriseId(String enterpriseId) Sets the value of field 'enterpriseId'.
void	setIpMatch(int index, String vIpMatch)
void	setIpMatch(List<String> vIpMatchList) Sets the value of '_ipMatchList' by copying the given Vector.
void	setIpMatch(String[] vIpMatchArray)
void	setIpMatchCollection(List<String> ipMatchList) Deprecated.
void	setMaxRepetitions(int maxRepetitions) Sets the value of field 'maxRepetitions'.
void	setMaxRequestSize(int maxRequestSize) Sets the value of field 'maxRequestSize'.
void	setMaxVarsPerPdu(int maxVarsPerPdu) Sets the value of field 'maxVarsPerPdu'.
void	setPort(int port) Sets the value of field 'port'.
void	setPrivacyPassphrase(String privacyPassphrase) Sets the value of field 'privacyPassphrase'.
void	setPrivacyProtocol(String privacyProtocol) Sets the value of field 'privacyProtocol'.
void	setProxyHost(String proxyHost) Sets the value of field 'proxyHost'.
void	setRange(int index, Range vRange)
void	setRange(List<Range> vRangeList) Sets the value of '_rangeList' by copying the given Vector.
void	setRange(Range[] vRangeArray)
void	setRangeCollection(List<Range> rangeList) Deprecated.
void	setReadCommunity(String readCommunity) Sets the value of field 'readCommunity'.
void	setRetry(int retry) Sets the value of field 'retry'.
void	setSecurityName(String securityName) Sets the value of field 'securityName'.
void	setSpecific(int index, String vSpecific)
void	setSpecific(List<String> vSpecificList) Sets the value of '_specificList' by copying the given Vector.
void	setSpecific(String[] vSpecificArray)
void	setSpecificCollection(List<String> specificList) Deprecated.
void	setTimeout(int timeout) Sets the value of field 'timeout'.
void	setVersion(String version) Sets the value of field 'version'.
void	setWriteCommunity(String writeCommunity) Sets the value of field 'writeCommunity'.
static Definition	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Definition

public Definition()

Method Detail

addIpMatch

public void addIpMatch(String vIpMatch)
                throws IndexOutOfBoundsException

Parameters:

vIpMatch -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addIpMatch

public void addIpMatch(int index,
                       String vIpMatch)
                throws IndexOutOfBoundsException

Parameters:

index -

vIpMatch -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRange

public void addRange(Range vRange)
              throws IndexOutOfBoundsException

Parameters:

vRange -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRange

public void addRange(int index,
                     Range vRange)
              throws IndexOutOfBoundsException

Parameters:

index -

vRange -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSpecific

public void addSpecific(String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

vSpecific -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSpecific

public void addSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteMaxRepetitions

public void deleteMaxRepetitions()

deleteMaxRequestSize

public void deleteMaxRequestSize()

deleteMaxVarsPerPdu

public void deleteMaxVarsPerPdu()

deletePort

public void deletePort()

deleteRetry

public void deleteRetry()

deleteTimeout

public void deleteTimeout()

enumerateIpMatch

public Enumeration<String> enumerateIpMatch()

Method enumerateIpMatch.

Returns:

an Enumeration over all possible elements of this collection

enumerateRange

public Enumeration<Range> enumerateRange()

Method enumerateRange.

Returns:

an Enumeration over all possible elements of this collection

enumerateSpecific

public Enumeration<String> enumerateSpecific()

Method enumerateSpecific.

Returns:

an Enumeration over all possible elements of this collection

getAuthPassphrase

public String getAuthPassphrase()

Returns the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3

Returns:

the value of field 'AuthPassphrase'.

getAuthProtocol

public String getAuthProtocol()

Returns the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3

Returns:

the value of field 'AuthProtocol'.

getContextEngineId

public String getContextEngineId()

Returns the value of field 'contextEngineId'. The field 'contextEngineId' has the following description: SNMPv3

Returns:

the value of field 'ContextEngineId'.

getContextName

public String getContextName()

Returns the value of field 'contextName'. The field 'contextName' has the following description: SNMPv3

Returns:

the value of field 'ContextName'.

getEngineId

public String getEngineId()

Returns the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3

Returns:

the value of field 'EngineId'.

getEnterpriseId

public String getEnterpriseId()

Returns the value of field 'enterpriseId'. The field 'enterpriseId' has the following description: SNMPv3

Returns:

the value of field 'EnterpriseId'.

getIpMatch

public String getIpMatch(int index)
                  throws IndexOutOfBoundsException

Method getIpMatch.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getIpMatch

public String[] getIpMatch()

Method getIpMatch.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getIpMatchCollection

public List<String> getIpMatchCollection()

Method getIpMatchCollection.Returns a reference to '_ipMatchList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getIpMatchCount

public int getIpMatchCount()

Method getIpMatchCount.

Returns:

the size of this collection

getMaxRepetitions

public int getMaxRepetitions()

Returns the value of field 'maxRepetitions'. The field 'maxRepetitions' has the following description: Number of repetitions per get-bulk requests.

Returns:

the value of field 'MaxRepetitions'.

getMaxRequestSize

public int getMaxRequestSize()

Returns the value of field 'maxRequestSize'. The field 'maxRequestSize' has the following description: Specifies the maximum number of variables that may be encoded into an individual SNMP pdu request by Collectd. Provides a means to limit the size of outgoing PDU requests. Value of 0 indicates no limit on number of PDUs which can be encoded into a single PDU.

Returns:

the value of field 'MaxRequestSize'.

getMaxVarsPerPdu

public int getMaxVarsPerPdu()

Returns the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: Number of variables to send per SNMP request.

Returns:

the value of field 'MaxVarsPerPdu'.

getPort

public int getPort()

Returns the value of field 'port'. The field 'port' has the following description: If set, overrides UDP port 161 as the port where SNMP GET/GETNEXT/GETBULK requests are sent.

Returns:

the value of field 'Port'.

getPrivacyPassphrase

public String getPrivacyPassphrase()

Returns the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3

Returns:

the value of field 'PrivacyPassphrase'.

getPrivacyProtocol

public String getPrivacyProtocol()

Returns the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3

Returns:

the value of field 'PrivacyProtocol'.

getProxyHost

public String getProxyHost()

Returns the value of field 'proxyHost'. The field 'proxyHost' has the following description: The proxy host to use when communiciating with this agent

Returns:

the value of field 'ProxyHost'.

getRange

public Range getRange(int index)
               throws IndexOutOfBoundsException

Method getRange.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.common.Range at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getRange

public Range[] getRange()

Method getRange.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getRangeCollection

public List<Range> getRangeCollection()

Method getRangeCollection.Returns a reference to '_rangeList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getRangeCount

public int getRangeCount()

Method getRangeCount.

Returns:

the size of this collection

getReadCommunity

public String getReadCommunity()

Returns the value of field 'readCommunity'. The field 'readCommunity' has the following description: Read community string (overrides default value).

Returns:

the value of field 'ReadCommunity'.

getRetry

public int getRetry()

Returns the value of field 'retry'. The field 'retry' has the following description: Number of retries (overrides the default value).

Returns:

the value of field 'Retry'.

getSecurityName

public String getSecurityName()

Returns the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3

Returns:

the value of field 'SecurityName'.

getSpecific

public String getSpecific(int index)
                   throws IndexOutOfBoundsException

Method getSpecific.

Parameters:

index -

Returns:

the value of the java.lang.String at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getSpecific

public String[] getSpecific()

Method getSpecific.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getSpecificCollection

public List<String> getSpecificCollection()

Method getSpecificCollection.Returns a reference to '_specificList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getSpecificCount

public int getSpecificCount()

Method getSpecificCount.

Returns:

the size of this collection

getTimeout

public int getTimeout()

Returns the value of field 'timeout'. The field 'timeout' has the following description: Timeout in milliseconds (overrides the default value).

Returns:

the value of field 'Timeout'.

getVersion

public String getVersion()

Returns the value of field 'version'. The field 'version' has the following description: If set, forces SNMP data collection to the specified version.

Returns:

the value of field 'Version'.

getWriteCommunity

public String getWriteCommunity()

Returns the value of field 'writeCommunity'. The field 'writeCommunity' has the following description: Write community string (overrides default value).

Returns:

the value of field 'WriteCommunity'.

hasMaxRepetitions

public boolean hasMaxRepetitions()

Method hasMaxRepetitions.

Returns:

true if at least one MaxRepetitions has been added

hasMaxRequestSize

public boolean hasMaxRequestSize()

Method hasMaxRequestSize.

Returns:

true if at least one MaxRequestSize has been added

hasMaxVarsPerPdu

public boolean hasMaxVarsPerPdu()

Method hasMaxVarsPerPdu.

Returns:

true if at least one MaxVarsPerPdu has been added

hasPort

public boolean hasPort()

Method hasPort.

Returns:

true if at least one Port has been added

hasRetry

public boolean hasRetry()

Method hasRetry.

Returns:

true if at least one Retry has been added

hasTimeout

public boolean hasTimeout()

Method hasTimeout.

Returns:

true if at least one Timeout has been added

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateIpMatch

public Iterator<String> iterateIpMatch()

Method iterateIpMatch.

Returns:

an Iterator over all possible elements in this collection

iterateRange

public Iterator<Range> iterateRange()

Method iterateRange.

Returns:

an Iterator over all possible elements in this collection

iterateSpecific

public Iterator<String> iterateSpecific()

Method iterateSpecific.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllIpMatch

public void removeAllIpMatch()

removeAllRange

public void removeAllRange()

removeAllSpecific

public void removeAllSpecific()

removeIpMatch

public boolean removeIpMatch(String vIpMatch)

Method removeIpMatch.

Parameters:

vIpMatch -

Returns:

true if the object was removed from the collection.

removeIpMatchAt

public String removeIpMatchAt(int index)

Method removeIpMatchAt.

Parameters:

index -

Returns:

the element removed from the collection

removeRange

public boolean removeRange(Range vRange)

Method removeRange.

Parameters:

vRange -

Returns:

true if the object was removed from the collection.

removeRangeAt

public Range removeRangeAt(int index)

Method removeRangeAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSpecific

public boolean removeSpecific(String vSpecific)

Method removeSpecific.

Parameters:

vSpecific -

Returns:

true if the object was removed from the collection.

removeSpecificAt

public String removeSpecificAt(int index)

Method removeSpecificAt.

Parameters:

index -

Returns:

the element removed from the collection

setAuthPassphrase

public void setAuthPassphrase(String authPassphrase)

Sets the value of field 'authPassphrase'. The field 'authPassphrase' has the following description: SNMPv3

Parameters:

authPassphrase - the value of field 'authPassphrase'.

setAuthProtocol

public void setAuthProtocol(String authProtocol)

Sets the value of field 'authProtocol'. The field 'authProtocol' has the following description: SNMPv3

Parameters:

authProtocol - the value of field 'authProtocol'.

setContextEngineId

public void setContextEngineId(String contextEngineId)

Sets the value of field 'contextEngineId'. The field 'contextEngineId' has the following description: SNMPv3

Parameters:

contextEngineId - the value of field 'contextEngineId'.

setContextName

public void setContextName(String contextName)

Sets the value of field 'contextName'. The field 'contextName' has the following description: SNMPv3

Parameters:

contextName - the value of field 'contextName'.

setEngineId

public void setEngineId(String engineId)

Sets the value of field 'engineId'. The field 'engineId' has the following description: SNMPv3

Parameters:

engineId - the value of field 'engineId'.

setEnterpriseId

public void setEnterpriseId(String enterpriseId)

Sets the value of field 'enterpriseId'. The field 'enterpriseId' has the following description: SNMPv3

Parameters:

enterpriseId - the value of field 'enterpriseId'.

setIpMatch

public void setIpMatch(int index,
                       String vIpMatch)
                throws IndexOutOfBoundsException

Parameters:

index -

vIpMatch -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setIpMatch

public void setIpMatch(String[] vIpMatchArray)

Parameters:

vIpMatchArray -

setIpMatch

public void setIpMatch(List<String> vIpMatchList)

Sets the value of '_ipMatchList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vIpMatchList - the Vector to copy.

setIpMatchCollection

public void setIpMatchCollection(List<String> ipMatchList)

Deprecated.

Sets the value of '_ipMatchList' by setting it to the given Vector. No type checking is performed.

Parameters:

ipMatchList - the Vector to set.

setMaxRepetitions

public void setMaxRepetitions(int maxRepetitions)

Sets the value of field 'maxRepetitions'. The field 'maxRepetitions' has the following description: Number of repetitions per get-bulk requests.

Parameters:

maxRepetitions - the value of field 'maxRepetitions'.

setMaxRequestSize

public void setMaxRequestSize(int maxRequestSize)

Sets the value of field 'maxRequestSize'. The field 'maxRequestSize' has the following description: Specifies the maximum number of variables that may be encoded into an individual SNMP pdu request by Collectd. Provides a means to limit the size of outgoing PDU requests. Value of 0 indicates no limit on number of PDUs which can be encoded into a single PDU.

Parameters:

maxRequestSize - the value of field 'maxRequestSize'.

setMaxVarsPerPdu

public void setMaxVarsPerPdu(int maxVarsPerPdu)

Sets the value of field 'maxVarsPerPdu'. The field 'maxVarsPerPdu' has the following description: Number of variables to send per SNMP request.

Parameters:

maxVarsPerPdu - the value of field 'maxVarsPerPdu'.

setPort

public void setPort(int port)

Sets the value of field 'port'. The field 'port' has the following description: If set, overrides UDP port 161 as the port where SNMP GET/GETNEXT/GETBULK requests are sent.

Parameters:

port - the value of field 'port'.

setPrivacyPassphrase

public void setPrivacyPassphrase(String privacyPassphrase)

Sets the value of field 'privacyPassphrase'. The field 'privacyPassphrase' has the following description: SNMPv3

Parameters:

privacyPassphrase - the value of field 'privacyPassphrase'.

setPrivacyProtocol

public void setPrivacyProtocol(String privacyProtocol)

Sets the value of field 'privacyProtocol'. The field 'privacyProtocol' has the following description: SNMPv3

Parameters:

privacyProtocol - the value of field 'privacyProtocol'.

setProxyHost

public void setProxyHost(String proxyHost)

Sets the value of field 'proxyHost'. The field 'proxyHost' has the following description: The proxy host to use when communiciating with this agent

Parameters:

proxyHost - the value of field 'proxyHost'.

setRange

public void setRange(int index,
                     Range vRange)
              throws IndexOutOfBoundsException

Parameters:

index -

vRange -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setRange

public void setRange(Range[] vRangeArray)

Parameters:

vRangeArray -

setRange

public void setRange(List<Range> vRangeList)

Sets the value of '_rangeList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vRangeList - the Vector to copy.

setRangeCollection

public void setRangeCollection(List<Range> rangeList)

Deprecated.

Sets the value of '_rangeList' by setting it to the given Vector. No type checking is performed.

Parameters:

rangeList - the Vector to set.

setReadCommunity

public void setReadCommunity(String readCommunity)

Sets the value of field 'readCommunity'. The field 'readCommunity' has the following description: Read community string (overrides default value).

Parameters:

readCommunity - the value of field 'readCommunity'.

setRetry

public void setRetry(int retry)

Sets the value of field 'retry'. The field 'retry' has the following description: Number of retries (overrides the default value).

Parameters:

retry - the value of field 'retry'.

setSecurityName

public void setSecurityName(String securityName)

Sets the value of field 'securityName'. The field 'securityName' has the following description: SNMPv3

Parameters:

securityName - the value of field 'securityName'.

setSpecific

public void setSpecific(int index,
                        String vSpecific)
                 throws IndexOutOfBoundsException

Parameters:

index -

vSpecific -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setSpecific

public void setSpecific(String[] vSpecificArray)

Parameters:

vSpecificArray -

setSpecific

public void setSpecific(List<String> vSpecificList)

Sets the value of '_specificList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vSpecificList - the Vector to copy.

setSpecificCollection

public void setSpecificCollection(List<String> specificList)

Deprecated.

Sets the value of '_specificList' by setting it to the given Vector. No type checking is performed.

Parameters:

specificList - the Vector to set.

setTimeout

public void setTimeout(int timeout)

Sets the value of field 'timeout'. The field 'timeout' has the following description: Timeout in milliseconds (overrides the default value).

Parameters:

timeout - the value of field 'timeout'.

setVersion

public void setVersion(String version)

Sets the value of field 'version'. The field 'version' has the following description: If set, forces SNMP data collection to the specified version.

Parameters:

version - the value of field 'version'.

setWriteCommunity

public void setWriteCommunity(String writeCommunity)

Sets the value of field 'writeCommunity'. The field 'writeCommunity' has the following description: Write community string (overrides default value).

Parameters:

writeCommunity - the value of field 'writeCommunity'.

unmarshal

public static Definition unmarshal(Reader reader)
                            throws org.exolab.castor.xml.MarshalException,
                                   org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.snmp.Definition

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema