org.opennms.netmgt.config.actiond

Class ActiondConfiguration

java.lang.Object

org.opennms.netmgt.config.actiond.ActiondConfiguration

All Implemented Interfaces:

Serializable

public class ActiondConfiguration
extends Object
implements Serializable

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActiondConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteMaxOutstandingActions()
void	deleteMaxProcessTime()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
int	getMaxOutstandingActions() Returns the value of field 'maxOutstandingActions'.
long	getMaxProcessTime() Returns the value of field 'maxProcessTime'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasMaxOutstandingActions() Method hasMaxOutstandingActions.
boolean	hasMaxProcessTime() Method hasMaxProcessTime.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setMaxOutstandingActions(int maxOutstandingActions) Sets the value of field 'maxOutstandingActions'.
void	setMaxProcessTime(long maxProcessTime) Sets the value of field 'maxProcessTime'.
static ActiondConfiguration	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

ActiondConfiguration

public ActiondConfiguration()

Method Detail

deleteMaxOutstandingActions

public void deleteMaxOutstandingActions()

deleteMaxProcessTime

public void deleteMaxProcessTime()

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.

getMaxOutstandingActions

public int getMaxOutstandingActions()

Returns the value of field 'maxOutstandingActions'. The field 'maxOutstandingActions' has the following description: The maximum number of simultaneous processes launched by actiond. If the number of launched processes currently runnning reaches this number, actiond waits for a process to complete or get terminated before it launches the next process.

Returns:

the value of field 'MaxOutstandingActions'.

getMaxProcessTime

public long getMaxProcessTime()

Returns the value of field 'maxProcessTime'. The field 'maxProcessTime' has the following description: The maximum time that a launched process can take to complete. If execution time exceeds this time, the launched process is terminated.

Returns:

the value of field 'MaxProcessTime'.

hasMaxOutstandingActions

public boolean hasMaxOutstandingActions()

Method hasMaxOutstandingActions.

Returns:

true if at least one MaxOutstandingActions has been added

hasMaxProcessTime

public boolean hasMaxProcessTime()

Method hasMaxProcessTime.

Returns:

true if at least one MaxProcessTime 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

setMaxOutstandingActions

public void setMaxOutstandingActions(int maxOutstandingActions)

Sets the value of field 'maxOutstandingActions'. The field 'maxOutstandingActions' has the following description: The maximum number of simultaneous processes launched by actiond. If the number of launched processes currently runnning reaches this number, actiond waits for a process to complete or get terminated before it launches the next process.

Parameters:

maxOutstandingActions - the value of field 'maxOutstandingActions'.

setMaxProcessTime

public void setMaxProcessTime(long maxProcessTime)

Sets the value of field 'maxProcessTime'. The field 'maxProcessTime' has the following description: The maximum time that a launched process can take to complete. If execution time exceeds this time, the launched process is terminated.

Parameters:

maxProcessTime - the value of field 'maxProcessTime'.

unmarshal

public static ActiondConfiguration 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.actiond.ActiondConfiguration

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