org.opennms.netmgt.config.httpdatacollection

Class HttpDatacollectionConfig

java.lang.Object

org.opennms.netmgt.config.httpdatacollection.HttpDatacollectionConfig

All Implemented Interfaces:

Serializable

public class HttpDatacollectionConfig
extends Object
implements Serializable

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HttpDatacollectionConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHttpCollection(HttpCollection vHttpCollection)
void	addHttpCollection(int index, HttpCollection vHttpCollection)
Enumeration<HttpCollection>	enumerateHttpCollection() Method enumerateHttpCollection.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
HttpCollection[]	getHttpCollection() Method getHttpCollection.Returns the contents of the collection in an Array.
HttpCollection	getHttpCollection(int index) Method getHttpCollection.
List<HttpCollection>	getHttpCollectionCollection() Method getHttpCollectionCollection.Returns a reference to '_httpCollectionList'.
int	getHttpCollectionCount() Method getHttpCollectionCount.
String	getRrdRepository() Returns the value of field 'rrdRepository'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<HttpCollection>	iterateHttpCollection() Method iterateHttpCollection.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllHttpCollection()
boolean	removeHttpCollection(HttpCollection vHttpCollection) Method removeHttpCollection.
HttpCollection	removeHttpCollectionAt(int index) Method removeHttpCollectionAt.
void	setHttpCollection(HttpCollection[] vHttpCollectionArray)
void	setHttpCollection(int index, HttpCollection vHttpCollection)
void	setHttpCollection(List<HttpCollection> vHttpCollectionList) Sets the value of '_httpCollectionList' by copying the given Vector.
void	setHttpCollectionCollection(List<HttpCollection> httpCollectionList) Deprecated.
void	setRrdRepository(String rrdRepository) Sets the value of field 'rrdRepository'.
static HttpDatacollectionConfig	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

HttpDatacollectionConfig

public HttpDatacollectionConfig()

Method Detail

addHttpCollection

public void addHttpCollection(HttpCollection vHttpCollection)
                       throws IndexOutOfBoundsException

Parameters:

vHttpCollection -

Throws:

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

addHttpCollection

public void addHttpCollection(int index,
                     HttpCollection vHttpCollection)
                       throws IndexOutOfBoundsException

Parameters:

index -

vHttpCollection -

Throws:

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

enumerateHttpCollection

public Enumeration<HttpCollection> enumerateHttpCollection()

Method enumerateHttpCollection.

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.

getHttpCollection

public HttpCollection getHttpCollection(int index)
                                 throws IndexOutOfBoundsException

Method getHttpCollection.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.httpdatacollection.HttpCollection at the given index

Throws:

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

getHttpCollection

public HttpCollection[] getHttpCollection()

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

getHttpCollectionCollection

public List<HttpCollection> getHttpCollectionCollection()

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

Returns:

a reference to the Vector backing this class

getHttpCollectionCount

public int getHttpCollectionCount()

Method getHttpCollectionCount.

Returns:

the size of this collection

getRrdRepository

public String getRrdRepository()

Returns the value of field 'rrdRepository'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected SNMP data

Returns:

the value of field 'RrdRepository'.

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

iterateHttpCollection

public Iterator<HttpCollection> iterateHttpCollection()

Method iterateHttpCollection.

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

removeAllHttpCollection

public void removeAllHttpCollection()

removeHttpCollection

public boolean removeHttpCollection(HttpCollection vHttpCollection)

Method removeHttpCollection.

Parameters:

vHttpCollection -

Returns:

true if the object was removed from the collection.

removeHttpCollectionAt

public HttpCollection removeHttpCollectionAt(int index)

Method removeHttpCollectionAt.

Parameters:

index -

Returns:

the element removed from the collection

setHttpCollection

public void setHttpCollection(int index,
                     HttpCollection vHttpCollection)
                       throws IndexOutOfBoundsException

Parameters:

index -

vHttpCollection -

Throws:

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

setHttpCollection

public void setHttpCollection(HttpCollection[] vHttpCollectionArray)

Parameters:

vHttpCollectionArray -

setHttpCollection

public void setHttpCollection(List<HttpCollection> vHttpCollectionList)

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

Parameters:

vHttpCollectionList - the Vector to copy.

setHttpCollectionCollection

public void setHttpCollectionCollection(List<HttpCollection> httpCollectionList)

Deprecated.

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

Parameters:

httpCollectionList - the Vector to set.

setRrdRepository

public void setRrdRepository(String rrdRepository)

Sets the value of field 'rrdRepository'. The field 'rrdRepository' has the following description: full path to the RRD repository for collected SNMP data

Parameters:

rrdRepository - the value of field 'rrdRepository'.

unmarshal

public static HttpDatacollectionConfig 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.httpdatacollection.HttpDatacollectionConfig

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