|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.opennms.netmgt.config.discovery.DiscoveryConfiguration
public class DiscoveryConfiguration
Top-level element for the discovery-configuration.xml configuration file.
| Constructor Summary | |
|---|---|
DiscoveryConfiguration()
|
|
| Method Summary | |
|---|---|
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. |
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. |
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'. |
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 |
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DiscoveryConfiguration()
| Method Detail |
|---|
public void addExcludeRange(ExcludeRange vExcludeRange)
throws IndexOutOfBoundsException
vExcludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addExcludeRange(int index,
ExcludeRange vExcludeRange)
throws IndexOutOfBoundsException
index - vExcludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addIncludeRange(IncludeRange vIncludeRange)
throws IndexOutOfBoundsException
vIncludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addIncludeRange(int index,
IncludeRange vIncludeRange)
throws IndexOutOfBoundsException
index - vIncludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addIncludeUrl(IncludeUrl vIncludeUrl)
throws IndexOutOfBoundsException
vIncludeUrl -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addIncludeUrl(int index,
IncludeUrl vIncludeUrl)
throws IndexOutOfBoundsException
index - vIncludeUrl -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addSpecific(Specific vSpecific)
throws IndexOutOfBoundsException
vSpecific -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collection
public void addSpecific(int index,
Specific vSpecific)
throws IndexOutOfBoundsException
index - vSpecific -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic void deleteInitialSleepTime()
public void deletePacketsPerSecond()
public void deleteRestartSleepTime()
public void deleteRetries()
public void deleteThreads()
public void deleteTimeout()
public Enumeration<ExcludeRange> enumerateExcludeRange()
public Enumeration<IncludeRange> enumerateIncludeRange()
public Enumeration<IncludeUrl> enumerateIncludeUrl()
public Enumeration<Specific> enumerateSpecific()
public ExcludeRange getExcludeRange(int index)
throws IndexOutOfBoundsException
index -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic ExcludeRange[] getExcludeRange()
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.
public List<ExcludeRange> getExcludeRangeCollection()
public int getExcludeRangeCount()
public IncludeRange getIncludeRange(int index)
throws IndexOutOfBoundsException
index -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic IncludeRange[] getIncludeRange()
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.
public List<IncludeRange> getIncludeRangeCollection()
public int getIncludeRangeCount()
public IncludeUrl getIncludeUrl(int index)
throws IndexOutOfBoundsException
index -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic IncludeUrl[] getIncludeUrl()
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.
public List<IncludeUrl> getIncludeUrlCollection()
public int getIncludeUrlCount()
public long getInitialSleepTime()
public int getPacketsPerSecond()
public long getRestartSleepTime()
public int getRetries()
public Specific getSpecific(int index)
throws IndexOutOfBoundsException
index -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic Specific[] getSpecific()
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.
public List<Specific> getSpecificCollection()
public int getSpecificCount()
public int getThreads()
public long getTimeout()
public boolean hasInitialSleepTime()
public boolean hasPacketsPerSecond()
public boolean hasRestartSleepTime()
public boolean hasRetries()
public boolean hasThreads()
public boolean hasTimeout()
public boolean isValid()
public Iterator<ExcludeRange> iterateExcludeRange()
public Iterator<IncludeRange> iterateIncludeRange()
public Iterator<IncludeUrl> iterateIncludeUrl()
public Iterator<Specific> iterateSpecific()
public void marshal(Writer out)
throws org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
out -
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
public void marshal(ContentHandler handler)
throws IOException,
org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
handler -
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 marshalingpublic void removeAllExcludeRange()
public void removeAllIncludeRange()
public void removeAllIncludeUrl()
public void removeAllSpecific()
public boolean removeExcludeRange(ExcludeRange vExcludeRange)
vExcludeRange -
public ExcludeRange removeExcludeRangeAt(int index)
index -
public boolean removeIncludeRange(IncludeRange vIncludeRange)
vIncludeRange -
public IncludeRange removeIncludeRangeAt(int index)
index -
public boolean removeIncludeUrl(IncludeUrl vIncludeUrl)
vIncludeUrl -
public IncludeUrl removeIncludeUrlAt(int index)
index -
public boolean removeSpecific(Specific vSpecific)
vSpecific -
public Specific removeSpecificAt(int index)
index -
public void setExcludeRange(int index,
ExcludeRange vExcludeRange)
throws IndexOutOfBoundsException
index - vExcludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic void setExcludeRange(ExcludeRange[] vExcludeRangeArray)
vExcludeRangeArray - public void setExcludeRange(List<ExcludeRange> vExcludeRangeList)
vExcludeRangeList - the Vector to copy.public void setExcludeRangeCollection(List<ExcludeRange> excludeRangeList)
excludeRangeList - the Vector to set.
public void setIncludeRange(int index,
IncludeRange vIncludeRange)
throws IndexOutOfBoundsException
index - vIncludeRange -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic void setIncludeRange(IncludeRange[] vIncludeRangeArray)
vIncludeRangeArray - public void setIncludeRange(List<IncludeRange> vIncludeRangeList)
vIncludeRangeList - the Vector to copy.public void setIncludeRangeCollection(List<IncludeRange> includeRangeList)
includeRangeList - the Vector to set.
public void setIncludeUrl(int index,
IncludeUrl vIncludeUrl)
throws IndexOutOfBoundsException
index - vIncludeUrl -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic void setIncludeUrl(IncludeUrl[] vIncludeUrlArray)
vIncludeUrlArray - public void setIncludeUrl(List<IncludeUrl> vIncludeUrlList)
vIncludeUrlList - the Vector to copy.public void setIncludeUrlCollection(List<IncludeUrl> includeUrlList)
includeUrlList - the Vector to set.public void setInitialSleepTime(long initialSleepTime)
initialSleepTime - the value of field 'initialSleepTime'public void setPacketsPerSecond(int packetsPerSecond)
packetsPerSecond - the value of field 'packetsPerSecond'public void setRestartSleepTime(long restartSleepTime)
restartSleepTime - the value of field 'restartSleepTime'public void setRetries(int retries)
retries - the value of field 'retries'.
public void setSpecific(int index,
Specific vSpecific)
throws IndexOutOfBoundsException
index - vSpecific -
IndexOutOfBoundsException - if the index
given is outside the bounds of the collectionpublic void setSpecific(Specific[] vSpecificArray)
vSpecificArray - public void setSpecific(List<Specific> vSpecificList)
vSpecificList - the Vector to copy.public void setSpecificCollection(List<Specific> specificList)
specificList - the Vector to set.public void setThreads(int threads)
threads - the value of field 'threads'.public void setTimeout(long timeout)
timeout - the value of field 'timeout'.
public static DiscoveryConfiguration unmarshal(Reader reader)
throws org.exolab.castor.xml.MarshalException,
org.exolab.castor.xml.ValidationException
reader -
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
public void validate()
throws org.exolab.castor.xml.ValidationException
org.exolab.castor.xml.ValidationException - if this
object is an invalid instance according to the schema
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||