org.opennms.netmgt.config.mailtransporttest

Class MailTransportTest

java.lang.Object

org.opennms.netmgt.config.mailtransporttest.MailTransportTest

All Implemented Interfaces:

Serializable

public class MailTransportTest
extends Object
implements Serializable

Use this element to define a mail test with the MailTransportMonitor. Supported use cases for the sequence are: a) Class will test that it can successfully send an email. b) Class will test that it can successfully connect to a mail server and get mailbox contents. c) Class will test that it can successfully read a new email message from a mail server. d) Class will test that it can send an email and read that same email from a mail server. The sequence support a max of one send and one receive server. If each are specified, the complete sequence is delivery of a message from one mail host to another.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailTransportTest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
MailTest	getMailTest() Returns the value of field 'mailTest'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setMailTest(MailTest mailTest) Sets the value of field 'mailTest'.
static MailTransportTest	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

MailTransportTest

public MailTransportTest()

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.

getMailTest

public MailTest getMailTest()

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

Returns:

the value of field 'MailTest'.

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

setMailTest

public void setMailTest(MailTest mailTest)

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

Parameters:

mailTest - the value of field 'mailTest'.

unmarshal

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

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