org.opennms.netmgt.config.javamail

Class SendmailProtocol

java.lang.Object

org.opennms.netmgt.config.javamail.SendmailProtocol

All Implemented Interfaces:

Serializable

public class SendmailProtocol
extends Object
implements Serializable

Basically attributes that help setup the javamailer's confusion set of properties.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendmailProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteQuitWait()
void	deleteSslEnable()
void	deleteStartTls()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getCharSet() Returns the value of field 'charSet'.
String	getMailer() Returns the value of field 'mailer'.
String	getMessageContentType() Returns the value of field 'messageContentType'.
String	getMessageEncoding() Returns the value of field 'messageEncoding'.
boolean	getQuitWait() Returns the value of field 'quitWait'.
boolean	getSslEnable() Returns the value of field 'sslEnable'.
boolean	getStartTls() Returns the value of field 'startTls'.
String	getTransport() Returns the value of field 'transport'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasQuitWait() Method hasQuitWait.
boolean	hasSslEnable() Method hasSslEnable.
boolean	hasStartTls() Method hasStartTls.
boolean	isQuitWait() Returns the value of field 'quitWait'.
boolean	isSslEnable() Returns the value of field 'sslEnable'.
boolean	isStartTls() Returns the value of field 'startTls'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setCharSet(String charSet) Sets the value of field 'charSet'.
void	setMailer(String mailer) Sets the value of field 'mailer'.
void	setMessageContentType(String messageContentType) Sets the value of field 'messageContentType'.
void	setMessageEncoding(String messageEncoding) Sets the value of field 'messageEncoding'.
void	setQuitWait(boolean quitWait) Sets the value of field 'quitWait'.
void	setSslEnable(boolean sslEnable) Sets the value of field 'sslEnable'.
void	setStartTls(boolean startTls) Sets the value of field 'startTls'.
void	setTransport(String transport) Sets the value of field 'transport'.
static SendmailProtocol	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

SendmailProtocol

public SendmailProtocol()

Method Detail

deleteQuitWait

public void deleteQuitWait()

deleteSslEnable

public void deleteSslEnable()

deleteStartTls

public void deleteStartTls()

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.

getCharSet

public String getCharSet()

Returns the value of field 'charSet'.

Returns:

the value of field 'CharSet'.

getMailer

public String getMailer()

Returns the value of field 'mailer'.

Returns:

the value of field 'Mailer'.

getMessageContentType

public String getMessageContentType()

Returns the value of field 'messageContentType'.

Returns:

the value of field 'MessageContentType'.

getMessageEncoding

public String getMessageEncoding()

Returns the value of field 'messageEncoding'.

Returns:

the value of field 'MessageEncoding'.

getQuitWait

public boolean getQuitWait()

Returns the value of field 'quitWait'.

Returns:

the value of field 'QuitWait'.

getSslEnable

public boolean getSslEnable()

Returns the value of field 'sslEnable'.

Returns:

the value of field 'SslEnable'.

getStartTls

public boolean getStartTls()

Returns the value of field 'startTls'.

Returns:

the value of field 'StartTls'.

getTransport

public String getTransport()

Returns the value of field 'transport'.

Returns:

the value of field 'Transport'.

hasQuitWait

public boolean hasQuitWait()

Method hasQuitWait.

Returns:

true if at least one QuitWait has been added

hasSslEnable

public boolean hasSslEnable()

Method hasSslEnable.

Returns:

true if at least one SslEnable has been added

hasStartTls

public boolean hasStartTls()

Method hasStartTls.

Returns:

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

isQuitWait

public boolean isQuitWait()

Returns the value of field 'quitWait'.

Returns:

the value of field 'QuitWait'.

isSslEnable

public boolean isSslEnable()

Returns the value of field 'sslEnable'.

Returns:

the value of field 'SslEnable'.

isStartTls

public boolean isStartTls()

Returns the value of field 'startTls'.

Returns:

the value of field 'StartTls'.

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

setCharSet

public void setCharSet(String charSet)

Sets the value of field 'charSet'.

Parameters:

charSet - the value of field 'charSet'.

setMailer

public void setMailer(String mailer)

Sets the value of field 'mailer'.

Parameters:

mailer - the value of field 'mailer'.

setMessageContentType

public void setMessageContentType(String messageContentType)

Sets the value of field 'messageContentType'.

Parameters:

messageContentType - the value of field 'messageContentType'.

setMessageEncoding

public void setMessageEncoding(String messageEncoding)

Sets the value of field 'messageEncoding'.

Parameters:

messageEncoding - the value of field 'messageEncoding'.

setQuitWait

public void setQuitWait(boolean quitWait)

Sets the value of field 'quitWait'.

Parameters:

quitWait - the value of field 'quitWait'.

setSslEnable

public void setSslEnable(boolean sslEnable)

Sets the value of field 'sslEnable'.

Parameters:

sslEnable - the value of field 'sslEnable'.

setStartTls

public void setStartTls(boolean startTls)

Sets the value of field 'startTls'.

Parameters:

startTls - the value of field 'startTls'.

setTransport

public void setTransport(String transport)

Sets the value of field 'transport'.

Parameters:

transport - the value of field 'transport'.

unmarshal

public static SendmailProtocol 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.javamail.SendmailProtocol

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