DiscoveryConfiguration (OpenNMS 14.0.0 API)

java.lang.Object
- org.opennms.netmgt.config.discovery.DiscoveryConfiguration

All Implemented Interfaces:

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

Version:

$Revision$ $Date$

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

DiscoveryConfiguration()

Constructors
Constructor and Description
`DiscoveryConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExcludeRange(ExcludeRange vExcludeRange)`
`void`	`addExcludeRange(int index, ExcludeRange vExcludeRange)`
`void`	`addIncludeRange(IncludeRange vIncludeRange)`
`void`	`addIncludeRange(int index, IncludeRange vIncludeRange)`
`void`	`addIncludeUrl(IncludeUrl vIncludeUrl)`
`void`	`addIncludeUrl(int index, IncludeUrl vIncludeUrl)`
`void`	`addSpecific(int index, Specific vSpecific)`
`void`	`addSpecific(Specific vSpecific)`
`void`	`deleteInitialSleepTime()`
`void`	`deletePacketsPerSecond()`
`void`	`deleteRestartSleepTime()`
`void`	`deleteRetries()`
`void`	`deleteThreads()`
`void`	`deleteTimeout()`
`Enumeration<ExcludeRange>`	`enumerateExcludeRange()` Method enumerateExcludeRange.
`Enumeration<IncludeRange>`	`enumerateIncludeRange()` Method enumerateIncludeRange.
`Enumeration<IncludeUrl>`	`enumerateIncludeUrl()` Method enumerateIncludeUrl.
`Enumeration<Specific>`	`enumerateSpecific()` Method enumerateSpecific.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`ExcludeRange[]`	`getExcludeRange()` Method getExcludeRange.Returns the contents of the collection in an Array.
`ExcludeRange`	`getExcludeRange(int index)` Method getExcludeRange.
`List<ExcludeRange>`	`getExcludeRangeCollection()` Method getExcludeRangeCollection.Returns a reference to '_excludeRangeList'.
`int`	`getExcludeRangeCount()` Method getExcludeRangeCount.
`String`	`getForeignSource()` Returns the value of field 'foreignSource'.
`IncludeRange[]`	`getIncludeRange()` Method getIncludeRange.Returns the contents of the collection in an Array.
`IncludeRange`	`getIncludeRange(int index)` Method getIncludeRange.
`List<IncludeRange>`	`getIncludeRangeCollection()` Method getIncludeRangeCollection.Returns a reference to '_includeRangeList'.
`int`	`getIncludeRangeCount()` Method getIncludeRangeCount.
`IncludeUrl[]`	`getIncludeUrl()` Method getIncludeUrl.Returns the contents of the collection in an Array.
`IncludeUrl`	`getIncludeUrl(int index)` Method getIncludeUrl.
`List<IncludeUrl>`	`getIncludeUrlCollection()` Method getIncludeUrlCollection.Returns a reference to '_includeUrlList'.
`int`	`getIncludeUrlCount()` Method getIncludeUrlCount.
`long`	`getInitialSleepTime()` Returns the value of field 'initialSleepTime'.
`int`	`getPacketsPerSecond()` Returns the value of field 'packetsPerSecond'.
`long`	`getRestartSleepTime()` Returns the value of field 'restartSleepTime'.
`int`	`getRetries()` Returns the value of field 'retries'.
`Specific[]`	`getSpecific()` Method getSpecific.Returns the contents of the collection in an Array.
`Specific`	`getSpecific(int index)` Method getSpecific.
`List<Specific>`	`getSpecificCollection()` Method getSpecificCollection.Returns a reference to '_specificList'.
`int`	`getSpecificCount()` Method getSpecificCount.
`int`	`getThreads()` Returns the value of field 'threads'.
`long`	`getTimeout()` Returns the value of field 'timeout'.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`hasInitialSleepTime()` Method hasInitialSleepTime.
`boolean`	`hasPacketsPerSecond()` Method hasPacketsPerSecond.
`boolean`	`hasRestartSleepTime()` Method hasRestartSleepTime.
`boolean`	`hasRetries()` Method hasRetries.
`boolean`	`hasThreads()` Method hasThreads.
`boolean`	`hasTimeout()` Method hasTimeout.
`boolean`	`isValid()` Method isValid.
`Iterator<ExcludeRange>`	`iterateExcludeRange()` Method iterateExcludeRange.
`Iterator<IncludeRange>`	`iterateIncludeRange()` Method iterateIncludeRange.
`Iterator<IncludeUrl>`	`iterateIncludeUrl()` Method iterateIncludeUrl.
`Iterator<Specific>`	`iterateSpecific()` Method iterateSpecific.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllExcludeRange()`
`void`	`removeAllIncludeRange()`
`void`	`removeAllIncludeUrl()`
`void`	`removeAllSpecific()`
`boolean`	`removeExcludeRange(ExcludeRange vExcludeRange)` Method removeExcludeRange.
`ExcludeRange`	`removeExcludeRangeAt(int index)` Method removeExcludeRangeAt.
`boolean`	`removeIncludeRange(IncludeRange vIncludeRange)` Method removeIncludeRange.
`IncludeRange`	`removeIncludeRangeAt(int index)` Method removeIncludeRangeAt.
`boolean`	`removeIncludeUrl(IncludeUrl vIncludeUrl)` Method removeIncludeUrl.
`IncludeUrl`	`removeIncludeUrlAt(int index)` Method removeIncludeUrlAt.
`boolean`	`removeSpecific(Specific vSpecific)` Method removeSpecific.
`Specific`	`removeSpecificAt(int index)` Method removeSpecificAt.
`void`	`setExcludeRange(ExcludeRange[] vExcludeRangeArray)`
`void`	`setExcludeRange(int index, ExcludeRange vExcludeRange)`
`void`	`setExcludeRange(List<ExcludeRange> vExcludeRangeList)` Sets the value of '_excludeRangeList' by copying the given Vector.
`void`	`setExcludeRangeCollection(List<ExcludeRange> excludeRangeList)` Deprecated.
`void`	`setForeignSource(String foreignSource)` Sets the value of field 'foreignSource'.
`void`	`setIncludeRange(IncludeRange[] vIncludeRangeArray)`
`void`	`setIncludeRange(int index, IncludeRange vIncludeRange)`
`void`	`setIncludeRange(List<IncludeRange> vIncludeRangeList)` Sets the value of '_includeRangeList' by copying the given Vector.
`void`	`setIncludeRangeCollection(List<IncludeRange> includeRangeList)` Deprecated.
`void`	`setIncludeUrl(IncludeUrl[] vIncludeUrlArray)`
`void`	`setIncludeUrl(int index, IncludeUrl vIncludeUrl)`
`void`	`setIncludeUrl(List<IncludeUrl> vIncludeUrlList)` Sets the value of '_includeUrlList' by copying the given Vector.
`void`	`setIncludeUrlCollection(List<IncludeUrl> includeUrlList)` Deprecated.
`void`	`setInitialSleepTime(long initialSleepTime)` Sets the value of field 'initialSleepTime'.
`void`	`setPacketsPerSecond(int packetsPerSecond)` Sets the value of field 'packetsPerSecond'.
`void`	`setRestartSleepTime(long restartSleepTime)` Sets the value of field 'restartSleepTime'.
`void`	`setRetries(int retries)` Sets the value of field 'retries'.
`void`	`setSpecific(int index, Specific vSpecific)`
`void`	`setSpecific(List<Specific> vSpecificList)` Sets the value of '_specificList' by copying the given Vector.
`void`	`setSpecific(Specific[] vSpecificArray)`
`void`	`setSpecificCollection(List<Specific> specificList)` Deprecated.
`void`	`setThreads(int threads)` Sets the value of field 'threads'.
`void`	`setTimeout(long timeout)` Sets the value of field 'timeout'.
`static DiscoveryConfiguration`	`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
  - DiscoveryConfiguration
```
public DiscoveryConfiguration()
```
- Method Detail
  - addExcludeRange
```
public void addExcludeRange(ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    vExcludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addExcludeRange
```
public void addExcludeRange(int index,
                   ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vExcludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addIncludeRange
```
public void addIncludeRange(IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    vIncludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addIncludeRange
```
public void addIncludeRange(int index,
                   IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vIncludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addIncludeUrl
```
public void addIncludeUrl(IncludeUrl vIncludeUrl)
                   throws IndexOutOfBoundsException
```
    Parameters:
    vIncludeUrl -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addIncludeUrl
```
public void addIncludeUrl(int index,
                 IncludeUrl vIncludeUrl)
                   throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vIncludeUrl -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSpecific
```
public void addSpecific(Specific vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSpecific
```
public void addSpecific(int index,
               Specific vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteInitialSleepTime
```
public void deleteInitialSleepTime()
```
  - deletePacketsPerSecond
```
public void deletePacketsPerSecond()
```
  - deleteRestartSleepTime
```
public void deleteRestartSleepTime()
```
  - deleteRetries
```
public void deleteRetries()
```
  - deleteThreads
```
public void deleteThreads()
```
  - deleteTimeout
```
public void deleteTimeout()
```
  - enumerateExcludeRange
```
public Enumeration<ExcludeRange> enumerateExcludeRange()
```
    Method enumerateExcludeRange.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateIncludeRange
```
public Enumeration<IncludeRange> enumerateIncludeRange()
```
    Method enumerateIncludeRange.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateIncludeUrl
```
public Enumeration<IncludeUrl> enumerateIncludeUrl()
```
    Method enumerateIncludeUrl.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateSpecific
```
public Enumeration<Specific> enumerateSpecific()
```
    Method enumerateSpecific.
    
    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.
  - getExcludeRange
```
public ExcludeRange getExcludeRange(int index)
                             throws IndexOutOfBoundsException
```
    Method getExcludeRange.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.discovery.ExcludeRange at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getExcludeRange
```
public ExcludeRange[] getExcludeRange()
```
    Method getExcludeRange.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
  - getExcludeRangeCollection
```
public List<ExcludeRange> getExcludeRangeCollection()
```
    Method getExcludeRangeCollection.Returns a reference to '_excludeRangeList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getExcludeRangeCount
```
public int getExcludeRangeCount()
```
    Method getExcludeRangeCount.
    
    Returns:
    the size of this collection
  - getForeignSource
```
public String getForeignSource()
```
    Returns the value of field 'foreignSource'.
    
    Returns:
    the value of field 'ForeignSource'.
  - getIncludeRange
```
public IncludeRange getIncludeRange(int index)
                             throws IndexOutOfBoundsException
```
    Method getIncludeRange.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.discovery.IncludeRange at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getIncludeRange
```
public IncludeRange[] getIncludeRange()
```
    Method getIncludeRange.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
  - getIncludeRangeCollection
```
public List<IncludeRange> getIncludeRangeCollection()
```
    Method getIncludeRangeCollection.Returns a reference to '_includeRangeList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getIncludeRangeCount
```
public int getIncludeRangeCount()
```
    Method getIncludeRangeCount.
    
    Returns:
    the size of this collection
  - getIncludeUrl
```
public IncludeUrl getIncludeUrl(int index)
                         throws IndexOutOfBoundsException
```
    Method getIncludeUrl.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.discovery.IncludeUrl at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getIncludeUrl
```
public IncludeUrl[] getIncludeUrl()
```
    Method getIncludeUrl.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
  - getIncludeUrlCollection
```
public List<IncludeUrl> getIncludeUrlCollection()
```
    Method getIncludeUrlCollection.Returns a reference to '_includeUrlList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getIncludeUrlCount
```
public int getIncludeUrlCount()
```
    Method getIncludeUrlCount.
    
    Returns:
    the size of this collection
  - getInitialSleepTime
```
public long getInitialSleepTime()
```
    Returns the value of field 'initialSleepTime'. The field 'initialSleepTime' has the following description: The initial pause (in milliseconds) after discovery starts up before discovery is started.
    
    Returns:
    the value of field 'InitialSleepTime'.
  - getPacketsPerSecond
```
public int getPacketsPerSecond()
```
    Returns the value of field 'packetsPerSecond'. The field 'packetsPerSecond' has the following description: the total number of ping packets sent per second from OpenNMS for discovery
    
    Returns:
    the value of field 'PacketsPerSecond'.
  - getRestartSleepTime
```
public long getRestartSleepTime()
```
    Returns the value of field 'restartSleepTime'. The field 'restartSleepTime' has the following description: The pause (in milliseconds) between discovery passes. Once the discovery process completes a sweep of all the specified addresses, it sleeps for this duration before starting another sweep.
    
    Returns:
    the value of field 'RestartSleepTime'.
  - getRetries
```
public int getRetries()
```
    Returns the value of field 'retries'. The field 'retries' has the following description: The default number of times a ping is retried for an address. If there is no response after the first ping to an address, it is tried again for the specified number of retries. This retry count is a default and can be overridden for specific addresses or sets of addresses that are configured in this file.
    
    Returns:
    the value of field 'Retries'.
  - getSpecific
```
public Specific getSpecific(int index)
                     throws IndexOutOfBoundsException
```
    Method getSpecific.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.discovery.Specific at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getSpecific
```
public Specific[] 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<Specific> 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
  - getThreads
```
public int getThreads()
```
    Returns the value of field 'threads'. The field 'threads' has the following description: the number of threads to be used for discovery
    
    Returns:
    the value of field 'Threads'.
  - getTimeout
```
public long getTimeout()
```
    Returns the value of field 'timeout'. The field 'timeout' has the following description: The default timeout on each poll. This timeout is a default and can be overridden for specific addresses or sets of addresses that are configured in this file.
    
    Returns:
    the value of field 'Timeout'.
  - hasInitialSleepTime
```
public boolean hasInitialSleepTime()
```
    Method hasInitialSleepTime.
    
    Returns:
    true if at least one InitialSleepTime has been added
  - hasPacketsPerSecond
```
public boolean hasPacketsPerSecond()
```
    Method hasPacketsPerSecond.
    
    Returns:
    true if at least one PacketsPerSecond has been added
  - hasRestartSleepTime
```
public boolean hasRestartSleepTime()
```
    Method hasRestartSleepTime.
    
    Returns:
    true if at least one RestartSleepTime has been added
  - hasRetries
```
public boolean hasRetries()
```
    Method hasRetries.
    
    Returns:
    true if at least one Retries has been added
  - hasThreads
```
public boolean hasThreads()
```
    Method hasThreads.
    
    Returns:
    true if at least one Threads has been added
  - hasTimeout
```
public boolean hasTimeout()
```
    Method hasTimeout.
    
    Returns:
    true if at least one Timeout 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.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    true if this object is valid according to the schema
  - iterateExcludeRange
```
public Iterator<ExcludeRange> iterateExcludeRange()
```
    Method iterateExcludeRange.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateIncludeRange
```
public Iterator<IncludeRange> iterateIncludeRange()
```
    Method iterateIncludeRange.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateIncludeUrl
```
public Iterator<IncludeUrl> iterateIncludeUrl()
```
    Method iterateIncludeUrl.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateSpecific
```
public Iterator<Specific> 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
  - removeAllExcludeRange
```
public void removeAllExcludeRange()
```
  - removeAllIncludeRange
```
public void removeAllIncludeRange()
```
  - removeAllIncludeUrl
```
public void removeAllIncludeUrl()
```
  - removeAllSpecific
```
public void removeAllSpecific()
```
  - removeExcludeRange
```
public boolean removeExcludeRange(ExcludeRange vExcludeRange)
```
    Method removeExcludeRange.
    
    Parameters:
    vExcludeRange -
    
    Returns:
    true if the object was removed from the collection.
  - removeExcludeRangeAt
```
public ExcludeRange removeExcludeRangeAt(int index)
```
    Method removeExcludeRangeAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeIncludeRange
```
public boolean removeIncludeRange(IncludeRange vIncludeRange)
```
    Method removeIncludeRange.
    
    Parameters:
    vIncludeRange -
    
    Returns:
    true if the object was removed from the collection.
  - removeIncludeRangeAt
```
public IncludeRange removeIncludeRangeAt(int index)
```
    Method removeIncludeRangeAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeIncludeUrl
```
public boolean removeIncludeUrl(IncludeUrl vIncludeUrl)
```
    Method removeIncludeUrl.
    
    Parameters:
    vIncludeUrl -
    
    Returns:
    true if the object was removed from the collection.
  - removeIncludeUrlAt
```
public IncludeUrl removeIncludeUrlAt(int index)
```
    Method removeIncludeUrlAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeSpecific
```
public boolean removeSpecific(Specific vSpecific)
```
    Method removeSpecific.
    
    Parameters:
    vSpecific -
    
    Returns:
    true if the object was removed from the collection.
  - removeSpecificAt
```
public Specific removeSpecificAt(int index)
```
    Method removeSpecificAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - setExcludeRange
```
public void setExcludeRange(int index,
                   ExcludeRange vExcludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vExcludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setExcludeRange
```
public void setExcludeRange(ExcludeRange[] vExcludeRangeArray)
```
    Parameters:
    vExcludeRangeArray -
  - setExcludeRange
```
public void setExcludeRange(List<ExcludeRange> vExcludeRangeList)
```
    Sets the value of '_excludeRangeList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vExcludeRangeList - the Vector to copy.
  - setExcludeRangeCollection
```
public void setExcludeRangeCollection(List<ExcludeRange> excludeRangeList)
```
    Deprecated.
    
    Sets the value of '_excludeRangeList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    excludeRangeList - the Vector to set.
  - setForeignSource
```
public void setForeignSource(String foreignSource)
```
    Sets the value of field 'foreignSource'.
    
    Parameters:
    foreignSource - the value of field 'foreignSource'.
  - setIncludeRange
```
public void setIncludeRange(int index,
                   IncludeRange vIncludeRange)
                     throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vIncludeRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setIncludeRange
```
public void setIncludeRange(IncludeRange[] vIncludeRangeArray)
```
    Parameters:
    vIncludeRangeArray -
  - setIncludeRange
```
public void setIncludeRange(List<IncludeRange> vIncludeRangeList)
```
    Sets the value of '_includeRangeList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vIncludeRangeList - the Vector to copy.
  - setIncludeRangeCollection
```
public void setIncludeRangeCollection(List<IncludeRange> includeRangeList)
```
    Deprecated.
    
    Sets the value of '_includeRangeList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    includeRangeList - the Vector to set.
  - setIncludeUrl
```
public void setIncludeUrl(int index,
                 IncludeUrl vIncludeUrl)
                   throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vIncludeUrl -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setIncludeUrl
```
public void setIncludeUrl(IncludeUrl[] vIncludeUrlArray)
```
    Parameters:
    vIncludeUrlArray -
  - setIncludeUrl
```
public void setIncludeUrl(List<IncludeUrl> vIncludeUrlList)
```
    Sets the value of '_includeUrlList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vIncludeUrlList - the Vector to copy.
  - setIncludeUrlCollection
```
public void setIncludeUrlCollection(List<IncludeUrl> includeUrlList)
```
    Deprecated.
    
    Sets the value of '_includeUrlList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    includeUrlList - the Vector to set.
  - setInitialSleepTime
```
public void setInitialSleepTime(long initialSleepTime)
```
    Sets the value of field 'initialSleepTime'. The field 'initialSleepTime' has the following description: The initial pause (in milliseconds) after discovery starts up before discovery is started.
    
    Parameters:
    initialSleepTime - the value of field 'initialSleepTime'
  - setPacketsPerSecond
```
public void setPacketsPerSecond(int packetsPerSecond)
```
    Sets the value of field 'packetsPerSecond'. The field 'packetsPerSecond' has the following description: the total number of ping packets sent per second from OpenNMS for discovery
    
    Parameters:
    packetsPerSecond - the value of field 'packetsPerSecond'
  - setRestartSleepTime
```
public void setRestartSleepTime(long restartSleepTime)
```
    Sets the value of field 'restartSleepTime'. The field 'restartSleepTime' has the following description: The pause (in milliseconds) between discovery passes. Once the discovery process completes a sweep of all the specified addresses, it sleeps for this duration before starting another sweep.
    
    Parameters:
    restartSleepTime - the value of field 'restartSleepTime'
  - setRetries
```
public void setRetries(int retries)
```
    Sets the value of field 'retries'. The field 'retries' has the following description: The default number of times a ping is retried for an address. If there is no response after the first ping to an address, it is tried again for the specified number of retries. This retry count is a default and can be overridden for specific addresses or sets of addresses that are configured in this file.
    
    Parameters:
    retries - the value of field 'retries'.
  - setSpecific
```
public void setSpecific(int index,
               Specific vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSpecific
```
public void setSpecific(Specific[] vSpecificArray)
```
    Parameters:
    vSpecificArray -
  - setSpecific
```
public void setSpecific(List<Specific> 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<Specific> 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.
  - setThreads
```
public void setThreads(int threads)
```
    Sets the value of field 'threads'. The field 'threads' has the following description: the number of threads to be used for discovery
    
    Parameters:
    threads - the value of field 'threads'.
  - setTimeout
```
public void setTimeout(long timeout)
```
    Sets the value of field 'timeout'. The field 'timeout' has the following description: The default timeout on each poll. This timeout is a default and can be overridden for specific addresses or sets of addresses that are configured in this file.
    
    Parameters:
    timeout - the value of field 'timeout'.
  - unmarshal
```
public static DiscoveryConfiguration 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.discovery.DiscoveryConfiguration
    
    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 DiscoveryConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DiscoveryConfiguration

Method Detail

addExcludeRange

addExcludeRange

addIncludeRange

addIncludeRange

addIncludeUrl

addIncludeUrl

addSpecific

addSpecific

deleteInitialSleepTime

deletePacketsPerSecond

deleteRestartSleepTime

deleteRetries

deleteThreads

deleteTimeout

enumerateExcludeRange

enumerateIncludeRange

enumerateIncludeUrl

enumerateSpecific

equals

getExcludeRange

getExcludeRange

getExcludeRangeCollection

getExcludeRangeCount

getForeignSource

getIncludeRange

getIncludeRange

getIncludeRangeCollection

getIncludeRangeCount

getIncludeUrl

getIncludeUrl

getIncludeUrlCollection

getIncludeUrlCount

getInitialSleepTime

getPacketsPerSecond

getRestartSleepTime

getRetries

getSpecific

getSpecific

getSpecificCollection

getSpecificCount

getThreads

getTimeout

hasInitialSleepTime

hasPacketsPerSecond

hasRestartSleepTime

hasRetries

hasThreads

hasTimeout

hashCode

isValid

iterateExcludeRange

iterateIncludeRange

iterateIncludeUrl

iterateSpecific

marshal

marshal

removeAllExcludeRange

removeAllIncludeRange

removeAllIncludeUrl

removeAllSpecific

removeExcludeRange

removeExcludeRangeAt

removeIncludeRange

removeIncludeRangeAt

removeIncludeUrl

removeIncludeUrlAt

removeSpecific

removeSpecificAt

setExcludeRange

setExcludeRange

setExcludeRange

setExcludeRangeCollection

setForeignSource