TrapdConfiguration (OpenNMS 17.1.0 API)

java.lang.Object
- org.opennms.netmgt.config.trapd.TrapdConfiguration

All Implemented Interfaces:

Serializable
```
public class TrapdConfiguration
extends Object
implements Serializable
```
Top-level element for the trapd-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TrapdConfiguration()

Constructors
Constructor and Description
`TrapdConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSnmpv3User(int index, Snmpv3User vSnmpv3User)`
`void`	`addSnmpv3User(Snmpv3User vSnmpv3User)`
`void`	`deleteNewSuspectOnTrap()`
`void`	`deleteSnmpTrapPort()`
`Enumeration<Snmpv3User>`	`enumerateSnmpv3User()` Method enumerateSnmpv3User.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`boolean`	`getNewSuspectOnTrap()` Returns the value of field 'newSuspectOnTrap'.
`String`	`getSnmpTrapAddress()` Returns the value of field 'snmpTrapAddress'.
`int`	`getSnmpTrapPort()` Returns the value of field 'snmpTrapPort'.
`Snmpv3User[]`	`getSnmpv3User()` Method getSnmpv3User.Returns the contents of the collection in an Array.
`Snmpv3User`	`getSnmpv3User(int index)` Method getSnmpv3User.
`List<Snmpv3User>`	`getSnmpv3UserCollection()` Method getSnmpv3UserCollection.Returns a reference to '_snmpv3UserList'.
`int`	`getSnmpv3UserCount()` Method getSnmpv3UserCount.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`hasNewSuspectOnTrap()` Method hasNewSuspectOnTrap.
`boolean`	`hasSnmpTrapPort()` Method hasSnmpTrapPort.
`boolean`	`isNewSuspectOnTrap()` Returns the value of field 'newSuspectOnTrap'.
`boolean`	`isValid()` Method isValid.
`Iterator<Snmpv3User>`	`iterateSnmpv3User()` Method iterateSnmpv3User.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllSnmpv3User()`
`boolean`	`removeSnmpv3User(Snmpv3User vSnmpv3User)` Method removeSnmpv3User.
`Snmpv3User`	`removeSnmpv3UserAt(int index)` Method removeSnmpv3UserAt.
`void`	`setNewSuspectOnTrap(boolean newSuspectOnTrap)` Sets the value of field 'newSuspectOnTrap'.
`void`	`setSnmpTrapAddress(String snmpTrapAddress)` Sets the value of field 'snmpTrapAddress'.
`void`	`setSnmpTrapPort(int snmpTrapPort)` Sets the value of field 'snmpTrapPort'.
`void`	`setSnmpv3User(int index, Snmpv3User vSnmpv3User)`
`void`	`setSnmpv3User(List<Snmpv3User> vSnmpv3UserList)` Sets the value of '_snmpv3UserList' by copying the given Vector.
`void`	`setSnmpv3User(Snmpv3User[] vSnmpv3UserArray)`
`void`	`setSnmpv3UserCollection(List<Snmpv3User> snmpv3UserList)` Deprecated.
`static TrapdConfiguration`	`unmarshal(Reader reader)` Method unmarshal.
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TrapdConfiguration
```
public TrapdConfiguration()
```
- Method Detail
  - addSnmpv3User
```
public void addSnmpv3User(Snmpv3User vSnmpv3User)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    vSnmpv3User -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSnmpv3User
```
public void addSnmpv3User(int index,
                          Snmpv3User vSnmpv3User)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSnmpv3User -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteNewSuspectOnTrap
```
public void deleteNewSuspectOnTrap()
```
  - deleteSnmpTrapPort
```
public void deleteSnmpTrapPort()
```
  - enumerateSnmpv3User
```
public Enumeration<Snmpv3User> enumerateSnmpv3User()
```
    Method enumerateSnmpv3User.
    
    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 Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    true if the objects are equal.
  - getNewSuspectOnTrap
```
public boolean getNewSuspectOnTrap()
```
    Returns the value of field 'newSuspectOnTrap'. The field 'newSuspectOnTrap' has the following description: Whether traps from devices unknown to OpenNMS should generate newSuspect events.
    
    Returns:
    
    the value of field 'NewSuspectOnTrap'.
  - getSnmpTrapAddress
```
public String getSnmpTrapAddress()
```
    Returns the value of field 'snmpTrapAddress'. The field 'snmpTrapAddress' has the following description: The IP address on which trapd listens for connections. If "" is specified, trapd will bind to all addresses. The default is .
    
    Returns:
    
    the value of field 'SnmpTrapAddress'.
  - getSnmpTrapPort
```
public int getSnmpTrapPort()
```
    Returns the value of field 'snmpTrapPort'. The field 'snmpTrapPort' has the following description: The port on which trapd listens for SNMP traps. The standard port is 162.
    
    Returns:
    
    the value of field 'SnmpTrapPort'.
  - getSnmpv3User
```
public Snmpv3User getSnmpv3User(int index)
                         throws IndexOutOfBoundsException
```
    Method getSnmpv3User.
    
    Parameters:
    
    index -
    
    Returns:
    
    the value of the org.opennms.netmgt.config.trapd.Snmpv3User at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getSnmpv3User
```
public Snmpv3User[] getSnmpv3User()
```
    Method getSnmpv3User.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
  - getSnmpv3UserCollection
```
public List<Snmpv3User> getSnmpv3UserCollection()
```
    Method getSnmpv3UserCollection.Returns a reference to '_snmpv3UserList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    
    a reference to the Vector backing this class
  - getSnmpv3UserCount
```
public int getSnmpv3UserCount()
```
    Method getSnmpv3UserCount.
    
    Returns:
    
    the size of this collection
  - hasNewSuspectOnTrap
```
public boolean hasNewSuspectOnTrap()
```
    Method hasNewSuspectOnTrap.
    
    Returns:
    
    true if at least one NewSuspectOnTrap has been added
  - hasSnmpTrapPort
```
public boolean hasSnmpTrapPort()
```
    Method hasSnmpTrapPort.
    
    Returns:
    
    true if at least one SnmpTrapPort has been added
  - 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 Object
    
    Returns:
    
    a hash code value for the object.
  - isNewSuspectOnTrap
```
public boolean isNewSuspectOnTrap()
```
    Returns the value of field 'newSuspectOnTrap'. The field 'newSuspectOnTrap' has the following description: Whether traps from devices unknown to OpenNMS should generate newSuspect events.
    
    Returns:
    
    the value of field 'NewSuspectOnTrap'.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    
    true if this object is valid according to the schema
  - iterateSnmpv3User
```
public Iterator<Snmpv3User> iterateSnmpv3User()
```
    Method iterateSnmpv3User.
    
    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
  - removeAllSnmpv3User
```
public void removeAllSnmpv3User()
```
  - removeSnmpv3User
```
public boolean removeSnmpv3User(Snmpv3User vSnmpv3User)
```
    Method removeSnmpv3User.
    
    Parameters:
    
    vSnmpv3User -
    
    Returns:
    
    true if the object was removed from the collection.
  - removeSnmpv3UserAt
```
public Snmpv3User removeSnmpv3UserAt(int index)
```
    Method removeSnmpv3UserAt.
    
    Parameters:
    
    index -
    
    Returns:
    
    the element removed from the collection
  - setNewSuspectOnTrap
```
public void setNewSuspectOnTrap(boolean newSuspectOnTrap)
```
    Sets the value of field 'newSuspectOnTrap'. The field 'newSuspectOnTrap' has the following description: Whether traps from devices unknown to OpenNMS should generate newSuspect events.
    
    Parameters:
    
    newSuspectOnTrap - the value of field 'newSuspectOnTrap'
  - setSnmpTrapAddress
```
public void setSnmpTrapAddress(String snmpTrapAddress)
```
    Sets the value of field 'snmpTrapAddress'. The field 'snmpTrapAddress' has the following description: The IP address on which trapd listens for connections. If "" is specified, trapd will bind to all addresses. The default is .
    
    Parameters:
    
    snmpTrapAddress - the value of field 'snmpTrapAddress'.
  - setSnmpTrapPort
```
public void setSnmpTrapPort(int snmpTrapPort)
```
    Sets the value of field 'snmpTrapPort'. The field 'snmpTrapPort' has the following description: The port on which trapd listens for SNMP traps. The standard port is 162.
    
    Parameters:
    
    snmpTrapPort - the value of field 'snmpTrapPort'.
  - setSnmpv3User
```
public void setSnmpv3User(int index,
                          Snmpv3User vSnmpv3User)
                   throws IndexOutOfBoundsException
```
    Parameters:
    
    index -
    
    vSnmpv3User -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSnmpv3User
```
public void setSnmpv3User(Snmpv3User[] vSnmpv3UserArray)
```
    Parameters:
    
    vSnmpv3UserArray -
  - setSnmpv3User
```
public void setSnmpv3User(List<Snmpv3User> vSnmpv3UserList)
```
    Sets the value of '_snmpv3UserList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    
    vSnmpv3UserList - the Vector to copy.
  - setSnmpv3UserCollection
```
public void setSnmpv3UserCollection(List<Snmpv3User> snmpv3UserList)
```
    Deprecated.
    
    Sets the value of '_snmpv3UserList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    
    snmpv3UserList - the Vector to set.
  - unmarshal
```
public static TrapdConfiguration 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.trapd.TrapdConfiguration
    
    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

Class TrapdConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrapdConfiguration

Method Detail

addSnmpv3User

addSnmpv3User

deleteNewSuspectOnTrap

deleteSnmpTrapPort

enumerateSnmpv3User

equals

getNewSuspectOnTrap

getSnmpTrapAddress

getSnmpTrapPort

getSnmpv3User

getSnmpv3User

getSnmpv3UserCollection

getSnmpv3UserCount

hasNewSuspectOnTrap

hasSnmpTrapPort

hashCode

isNewSuspectOnTrap

isValid

iterateSnmpv3User

marshal

marshal

removeAllSnmpv3User

removeSnmpv3User

removeSnmpv3UserAt

setNewSuspectOnTrap

setSnmpTrapAddress

setSnmpTrapPort

setSnmpv3User

setSnmpv3User

setSnmpv3User

setSnmpv3UserCollection

unmarshal

validate