org.opennms.netmgt.config.poller
Class CriticalService

java.lang.Object
  org.opennms.netmgt.config.poller.CriticalService

All Implemented Interfaces:

Serializable

public class CriticalService
extends Object
implements Serializable

Critical service. Defining a critical service greatly reduces the traffic generated by the poller when an interface is DOWN. When an interface is DOWN only the critical service is polled. If and when the critical service comes back UP then the interface's other services are polled to determine their status. When an interface is UP all services are polled as expected. If the critical service goes DOWN, all services are considered to be DOWN and therefore the interface is also considered DOWN.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

CriticalService()

Method Summary

String	getName() Returns the value of field 'name'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setName(String name) Sets the value of field 'name'.
static CriticalService	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

CriticalService

public CriticalService()

Method Detail

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: Name of the critical service (typically, "ICMP")

Returns:

the value of field 'Name'.

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

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: Name of the critical service (typically, "ICMP")

Parameters:

name - the value of field 'name'.

unmarshal

public static CriticalService 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.poller.CriticalService

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