org.opennms.netmgt.config.mailtransporttest

Class MailTest

java.lang.Object

org.opennms.netmgt.config.mailtransporttest.MailTest

All Implemented Interfaces:

Serializable

public class MailTest
extends Object
implements Serializable

Defines a use case for testing mail. If both a send and a read test are configured, then the use case (d) will be executed.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailTest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
ReadmailTest	getReadmailTest() Returns the value of field 'readmailTest'.
SendmailTest	getSendmailTest() Returns the value of field 'sendmailTest'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setReadmailTest(ReadmailTest readmailTest) Sets the value of field 'readmailTest'.
void	setSendmailTest(SendmailTest sendmailTest) Sets the value of field 'sendmailTest'.
static MailTest	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

MailTest

public MailTest()

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.

getReadmailTest

public ReadmailTest getReadmailTest()

Returns the value of field 'readmailTest'.

Returns:

the value of field 'ReadmailTest'.

getSendmailTest

public SendmailTest getSendmailTest()

Returns the value of field 'sendmailTest'. The field 'sendmailTest' has the following description: This entity defines the test for sending mail. Attributes are used to derive values of java mail properties, or, they can be specified directly as key value pairs. Attributes will are easier to read but there isn't an attribute for every javamail property possible (some are fairly obscure).

Returns:

the value of field 'SendmailTest'.

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

setReadmailTest

public void setReadmailTest(ReadmailTest readmailTest)

Sets the value of field 'readmailTest'.

Parameters:

readmailTest - the value of field 'readmailTest'.

setSendmailTest

public void setSendmailTest(SendmailTest sendmailTest)

Sets the value of field 'sendmailTest'. The field 'sendmailTest' has the following description: This entity defines the test for sending mail. Attributes are used to derive values of java mail properties, or, they can be specified directly as key value pairs. Attributes will are easier to read but there isn't an attribute for every javamail property possible (some are fairly obscure).

Parameters:

sendmailTest - the value of field 'sendmailTest'.

unmarshal

public static MailTest 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.mailtransporttest.MailTest

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