org.opennms.netmgt.config.snmp
Class SnmpConfig

java.lang.Object
  org.opennms.netmgt.config.snmp.Configuration
      org.opennms.netmgt.config.snmp.SnmpConfig

All Implemented Interfaces:

Serializable

public class SnmpConfig
extends Configuration
implements Serializable

Top-level element for the snmp-config.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SnmpConfig()

Method Summary

void	addDefinition(Definition vDefinition)
void	addDefinition(int index, Definition vDefinition)
Enumeration<Definition>	enumerateDefinition() Method enumerateDefinition.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Definition[]	getDefinition() Method getDefinition.Returns the contents of the collection in an Array.
Definition	getDefinition(int index) Method getDefinition.
List<Definition>	getDefinitionCollection() Method getDefinitionCollection.Returns a reference to '_definitionList'.
int	getDefinitionCount() Method getDefinitionCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<Definition>	iterateDefinition() Method iterateDefinition.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllDefinition()
boolean	removeDefinition(Definition vDefinition) Method removeDefinition.
Definition	removeDefinitionAt(int index) Method removeDefinitionAt.
void	setDefinition(Definition[] vDefinitionArray)
void	setDefinition(int index, Definition vDefinition)
void	setDefinition(List<Definition> vDefinitionList) Sets the value of '_definitionList' by copying the given Vector.
void	setDefinitionCollection(List<Definition> definitionList) Deprecated.
static Configuration	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class org.opennms.netmgt.config.snmp.Configuration

deleteMaxRepetitions, deleteMaxRequestSize, deleteMaxVarsPerPdu, deletePort, deleteRetry, deleteSecurityLevel, deleteTimeout, getAuthPassphrase, getAuthProtocol, getContextEngineId, getContextName, getEngineId, getEnterpriseId, getMaxRepetitions, getMaxRequestSize, getMaxVarsPerPdu, getPort, getPrivacyPassphrase, getPrivacyProtocol, getProxyHost, getReadCommunity, getRetry, getSecurityLevel, getSecurityName, getTimeout, getVersion, getWriteCommunity, hasMaxRepetitions, hasMaxRequestSize, hasMaxVarsPerPdu, hasPort, hasRetry, hasSecurityLevel, hasTimeout, setAuthPassphrase, setAuthProtocol, setContextEngineId, setContextName, setEngineId, setEnterpriseId, setMaxRepetitions, setMaxRequestSize, setMaxVarsPerPdu, setPort, setPrivacyPassphrase, setPrivacyProtocol, setProxyHost, setReadCommunity, setRetry, setSecurityLevel, setSecurityName, setTimeout, setVersion, setWriteCommunity

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpConfig

public SnmpConfig()

Method Detail

addDefinition

public void addDefinition(Definition vDefinition)
                   throws IndexOutOfBoundsException

Parameters:

vDefinition -

Throws:

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

addDefinition

public void addDefinition(int index,
                          Definition vDefinition)
                   throws IndexOutOfBoundsException

Parameters:

index -

vDefinition -

Throws:

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

enumerateDefinition

public Enumeration<Definition> enumerateDefinition()

Method enumerateDefinition.

Returns:

an Enumeration over all possible elements of this collection

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Configuration

Parameters:

obj -

Returns:

true if the objects are equal.

getDefinition

public Definition getDefinition(int index)
                         throws IndexOutOfBoundsException

Method getDefinition.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.snmp.Definition at the given index

Throws:

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

getDefinition

public Definition[] getDefinition()

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

getDefinitionCollection

public List<Definition> getDefinitionCollection()

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

Returns:

a reference to the Vector backing this class

getDefinitionCount

public int getDefinitionCount()

Method getDefinitionCount.

Returns:

the size of this collection

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Configuration

Returns:

a hash code value for the object.

isValid

public boolean isValid()

Method isValid.

Overrides:

isValid in class Configuration

Returns:

true if this object is valid according to the schema

iterateDefinition

public Iterator<Definition> iterateDefinition()

Method iterateDefinition.

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

Overrides:

marshal in class Configuration

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

Overrides:

marshal in class Configuration

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

removeAllDefinition

public void removeAllDefinition()

removeDefinition

public boolean removeDefinition(Definition vDefinition)

Method removeDefinition.

Parameters:

vDefinition -

Returns:

true if the object was removed from the collection.

removeDefinitionAt

public Definition removeDefinitionAt(int index)

Method removeDefinitionAt.

Parameters:

index -

Returns:

the element removed from the collection

setDefinition

public void setDefinition(int index,
                          Definition vDefinition)
                   throws IndexOutOfBoundsException

Parameters:

index -

vDefinition -

Throws:

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

setDefinition

public void setDefinition(Definition[] vDefinitionArray)

Parameters:

vDefinitionArray -

setDefinition

public void setDefinition(List<Definition> vDefinitionList)

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

Parameters:

vDefinitionList - the Vector to copy.

setDefinitionCollection

public void setDefinitionCollection(List<Definition> definitionList)

Deprecated.

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

Parameters:

definitionList - the Vector to set.

unmarshal

public static Configuration 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.Configuration

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

Overrides:

validate in class Configuration

Throws:

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