org.opennms.netmgt.config.outage

Class OutageConfiguration

java.lang.Object

org.opennms.netmgt.config.outage.OutageConfiguration

All Implemented Interfaces:

Serializable

public class OutageConfiguration
extends Object
implements Serializable

Top-level element for the outage-configuration.xml configuration file.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OutageConfiguration()

Method Summary

Modifier and Type	Method and Description
void	deleteWriters()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDeletePropagation() Returns the value of field 'deletePropagation'.
String	getGetNextOutageID() Returns the value of field 'getNextOutageID'.
int	getWriters() Returns the value of field 'writers'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasWriters() Method hasWriters.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setDeletePropagation(String deletePropagation) Sets the value of field 'deletePropagation'.
void	setGetNextOutageID(String getNextOutageID) Sets the value of field 'getNextOutageID'.
void	setWriters(int writers) Sets the value of field 'writers'.
static OutageConfiguration	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

OutageConfiguration

public OutageConfiguration()

Method Detail

deleteWriters

public void deleteWriters()

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.

getDeletePropagation

public String getDeletePropagation()

Returns the value of field 'deletePropagation'. The field 'deletePropagation' has the following description: Flag which indicates if a delete service event should propagate to a delete interface or delete node event, if approciate.

Returns:

the value of field 'DeletePropagation'.

getGetNextOutageID

public String getGetNextOutageID()

Returns the value of field 'getNextOutageID'. The field 'getNextOutageID' has the following description: SQL query to get next value of the 'outageNxtId' database sequence to make the access database independant.

Returns:

the value of field 'GetNextOutageID'.

getWriters

public int getWriters()

Returns the value of field 'writers'. The field 'writers' has the following description: Maximum number of threads reading the events and updating the database.

Returns:

the value of field 'Writers'.

hasWriters

public boolean hasWriters()

Method hasWriters.

Returns:

true if at least one Writers has been added

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

setDeletePropagation

public void setDeletePropagation(String deletePropagation)

Sets the value of field 'deletePropagation'. The field 'deletePropagation' has the following description: Flag which indicates if a delete service event should propagate to a delete interface or delete node event, if approciate.

Parameters:

deletePropagation - the value of field 'deletePropagation'.

setGetNextOutageID

public void setGetNextOutageID(String getNextOutageID)

Sets the value of field 'getNextOutageID'. The field 'getNextOutageID' has the following description: SQL query to get next value of the 'outageNxtId' database sequence to make the access database independant.

Parameters:

getNextOutageID - the value of field 'getNextOutageID'.

setWriters

public void setWriters(int writers)

Sets the value of field 'writers'. The field 'writers' has the following description: Maximum number of threads reading the events and updating the database.

Parameters:

writers - the value of field 'writers'.

unmarshal

public static OutageConfiguration 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.outage.OutageConfiguration

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