org.opennms.netmgt.config.poller
Class NodeOutage

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

All Implemented Interfaces:

Serializable

public class NodeOutage
extends Object
implements Serializable

Configuration of node-outage functionality

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

NodeOutage()

Method Summary

CriticalService	getCriticalService() Returns the value of field 'criticalService'.
String	getPollAllIfNoCriticalServiceDefined() Returns the value of field 'pollAllIfNoCriticalServiceDefined'.
String	getStatus() Returns the value of field 'status'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setCriticalService(CriticalService criticalService) Sets the value of field 'criticalService'.
void	setPollAllIfNoCriticalServiceDefined(String pollAllIfNoCriticalServiceDefined) Sets the value of field 'pollAllIfNoCriticalServiceDefined'.
void	setStatus(String status) Sets the value of field 'status'.
static NodeOutage	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

NodeOutage

public NodeOutage()

Method Detail

getCriticalService

public CriticalService getCriticalService()

Returns the value of field 'criticalService'. The field 'criticalService' has the following description: 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.

Returns:

the value of field 'CriticalService'.

getPollAllIfNoCriticalServiceDefined

public String getPollAllIfNoCriticalServiceDefined()

Returns the value of field 'pollAllIfNoCriticalServiceDefined'. The field 'pollAllIfNoCriticalServiceDefined' has the following description: Defines behavior of node outage processing when a service has changed status to DOWN and a critical service is not defined. If "true", all remaining services on the interface are polled.

Returns:

the value of field 'PollAllIfNoCriticalServiceDefined'.

getStatus

public String getStatus()

Returns the value of field 'status'. The field 'status' has the following description: Enable/disable node outage processing

Returns:

the value of field 'Status'.

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

setCriticalService

public void setCriticalService(CriticalService criticalService)

Sets the value of field 'criticalService'. The field 'criticalService' has the following description: 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.

Parameters:

criticalService - the value of field 'criticalService'.

setPollAllIfNoCriticalServiceDefined

public void setPollAllIfNoCriticalServiceDefined(String pollAllIfNoCriticalServiceDefined)

Sets the value of field 'pollAllIfNoCriticalServiceDefined'. The field 'pollAllIfNoCriticalServiceDefined' has the following description: Defines behavior of node outage processing when a service has changed status to DOWN and a critical service is not defined. If "true", all remaining services on the interface are polled.

Parameters:

pollAllIfNoCriticalServiceDefined - the value of field 'pollAllIfNoCriticalServiceDefined'.

setStatus

public void setStatus(String status)

Sets the value of field 'status'. The field 'status' has the following description: Enable/disable node outage processing

Parameters:

status - the value of field 'status'.

unmarshal

public static NodeOutage 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.NodeOutage

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