org.opennms.netmgt.config.monitoringLocations

Class MonitoringLocationsConfiguration

java.lang.Object

org.opennms.netmgt.config.monitoringLocations.MonitoringLocationsConfiguration

All Implemented Interfaces:

Serializable

public class MonitoringLocationsConfiguration
extends Object
implements Serializable

Top-level element for configuration remote monitoring locations.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MonitoringLocationsConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
Locations	getLocations() Returns the value of field 'locations'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setLocations(Locations locations) Sets the value of field 'locations'.
static MonitoringLocationsConfiguration	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

MonitoringLocationsConfiguration

public MonitoringLocationsConfiguration()

Method Detail

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.

getLocations

public Locations getLocations()

Returns the value of field 'locations'. The field 'locations' has the following description: The name and polling configuration for each monitoring location. Note: multiple monitors can use the same monitoring location, they will get assigned and ID with the name of the location prepended (example: location name "SFO" instance could be "SFO-1" or "SFO-Building A" as the instance is defined by the user during registration of the distributed monitor).

Returns:

the value of field 'Locations'.

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

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

setLocations

public void setLocations(Locations locations)

Sets the value of field 'locations'. The field 'locations' has the following description: The name and polling configuration for each monitoring location. Note: multiple monitors can use the same monitoring location, they will get assigned and ID with the name of the location prepended (example: location name "SFO" instance could be "SFO-1" or "SFO-Building A" as the instance is defined by the user during registration of the distributed monitor).

Parameters:

locations - the value of field 'locations'.

unmarshal

public static MonitoringLocationsConfiguration 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.monitoringLocations.MonitoringLocationsConfiguration

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