org.opennms.netmgt.config.javamail

Class ReadmailConfig

java.lang.Object

org.opennms.netmgt.config.javamail.ReadmailConfig

All Implemented Interfaces:

Serializable

public class ReadmailConfig
extends Object
implements Serializable

Configuration container for configuration all settings for reading email

Version:

$Revision$ $Date$

See Also:

Serialized Form

Property Summary

Properties

Type	Property and Description
Enumeration<JavamailProperty>	enumerateJavamail Method enumerateJavamailProperty.
Iterator<JavamailProperty>	iterateJavamail Method iterateJavamailProperty.

Constructor Summary

Constructors

Constructor and Description
ReadmailConfig()

Method Summary

Methods

Modifier and Type	Method and Description
void	addJavamailProperty(int index, JavamailProperty vJavamailProperty)
void	addJavamailProperty(JavamailProperty vJavamailProperty)
void	deleteAttemptInterval()
void	deleteDebug()
void	deleteDeleteAllMail()
Enumeration<JavamailProperty>	enumerateJavamailProperty() Method enumerateJavamailProperty.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
long	getAttemptInterval() Returns the value of field 'attemptInterval'.
boolean	getDebug() Returns the value of field 'debug'.
boolean	getDeleteAllMail() Returns the value of field 'deleteAllMail'.
JavamailProperty[]	getJavamailProperty() Method getJavamailProperty.Returns the contents of the collection in an Array.
JavamailProperty	getJavamailProperty(int index) Method getJavamailProperty.
List<JavamailProperty>	getJavamailPropertyCollection() Method getJavamailPropertyCollection.Returns a reference to '_javamailPropertyList'.
int	getJavamailPropertyCount() Method getJavamailPropertyCount.
String	getMailFolder() Returns the value of field 'mailFolder'.
String	getName() Returns the value of field 'name'.
ReadmailHost	getReadmailHost() Returns the value of field 'readmailHost'.
UserAuth	getUserAuth() Returns the value of field 'userAuth'.
boolean	hasAttemptInterval() Method hasAttemptInterval.
boolean	hasDebug() Method hasDebug.
boolean	hasDeleteAllMail() Method hasDeleteAllMail.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isDebug() Returns the value of field 'debug'.
boolean	isDeleteAllMail() Returns the value of field 'deleteAllMail'.
boolean	isValid() Method isValid.
Iterator<JavamailProperty>	iterateJavamailProperty() Method iterateJavamailProperty.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllJavamailProperty()
boolean	removeJavamailProperty(JavamailProperty vJavamailProperty) Method removeJavamailProperty.
JavamailProperty	removeJavamailPropertyAt(int index) Method removeJavamailPropertyAt.
void	setAttemptInterval(long attemptInterval) Sets the value of field 'attemptInterval'.
void	setDebug(boolean debug) Sets the value of field 'debug'.
void	setDeleteAllMail(boolean deleteAllMail) Sets the value of field 'deleteAllMail'.
void	setJavamailProperty(int index, JavamailProperty vJavamailProperty)
void	setJavamailProperty(JavamailProperty[] vJavamailPropertyArray)
void	setJavamailProperty(List<JavamailProperty> vJavamailPropertyList) Sets the value of '_javamailPropertyList' by copying the given Vector.
void	setJavamailPropertyCollection(List<JavamailProperty> javamailPropertyList) Deprecated.
void	setMailFolder(String mailFolder) Sets the value of field 'mailFolder'.
void	setName(String name) Sets the value of field 'name'.
void	setReadmailHost(ReadmailHost readmailHost) Sets the value of field 'readmailHost'.
void	setUserAuth(UserAuth userAuth) Sets the value of field 'userAuth'.
static ReadmailConfig	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Property Detail

enumerateJavamail

Method enumerateJavamailProperty.

Returns:

an Enumeration over all possible elements of this collection

iterateJavamail

Method iterateJavamailProperty.

Returns:

an Iterator over all possible elements in this collection

Constructor Detail

ReadmailConfig

public ReadmailConfig()

Method Detail

addJavamailProperty

public void addJavamailProperty(JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException

Parameters:

vJavamailProperty -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addJavamailProperty

public void addJavamailProperty(int index,
                       JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException

Parameters:

index -

vJavamailProperty -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

deleteAttemptInterval

public void deleteAttemptInterval()

deleteDebug

public void deleteDebug()

deleteDeleteAllMail

public void deleteDeleteAllMail()

enumerateJavamailProperty

public Enumeration<JavamailProperty> enumerateJavamailProperty()

Method enumerateJavamailProperty.

Returns:

an Enumeration over all possible elements of this collection

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.

getAttemptInterval

public long getAttemptInterval()

Returns the value of field 'attemptInterval'.

Returns:

the value of field 'AttemptInterval'.

getDebug

public boolean getDebug()

Returns the value of field 'debug'.

Returns:

the value of field 'Debug'.

getDeleteAllMail

public boolean getDeleteAllMail()

Returns the value of field 'deleteAllMail'.

Returns:

the value of field 'DeleteAllMail'.

getJavamailProperty

public JavamailProperty getJavamailProperty(int index)
                                     throws IndexOutOfBoundsException

Method getJavamailProperty.

Parameters:

index -

Returns:

the value of the org.opennms.netmgt.config.javamail.JavamailProperty at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getJavamailProperty

public JavamailProperty[] getJavamailProperty()

Method getJavamailProperty.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:

this collection as an Array

getJavamailPropertyCollection

public List<JavamailProperty> getJavamailPropertyCollection()

Method getJavamailPropertyCollection.Returns a reference to '_javamailPropertyList'. No type checking is performed on any modifications to the Vector.

Returns:

a reference to the Vector backing this class

getJavamailPropertyCount

public int getJavamailPropertyCount()

Method getJavamailPropertyCount.

Returns:

the size of this collection

getMailFolder

public String getMailFolder()

Returns the value of field 'mailFolder'.

Returns:

the value of field 'MailFolder'.

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getReadmailHost

public ReadmailHost getReadmailHost()

Returns the value of field 'readmailHost'. The field 'readmailHost' has the following description: Define the host and port of a service for reading email.

Returns:

the value of field 'ReadmailHost'.

getUserAuth

public UserAuth getUserAuth()

Returns the value of field 'userAuth'. The field 'userAuth' has the following description: Configure user based authentication.

Returns:

the value of field 'UserAuth'.

hasAttemptInterval

public boolean hasAttemptInterval()

Method hasAttemptInterval.

Returns:

true if at least one AttemptInterval has been added

hasDebug

public boolean hasDebug()

Method hasDebug.

Returns:

true if at least one Debug has been added

hasDeleteAllMail

public boolean hasDeleteAllMail()

Method hasDeleteAllMail.

Returns:

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

isDebug

public boolean isDebug()

Returns the value of field 'debug'.

Returns:

the value of field 'Debug'.

isDeleteAllMail

public boolean isDeleteAllMail()

Returns the value of field 'deleteAllMail'.

Returns:

the value of field 'DeleteAllMail'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateJavamailProperty

public Iterator<JavamailProperty> iterateJavamailProperty()

Method iterateJavamailProperty.

Returns:

an Iterator over all possible elements in this collection

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

removeAllJavamailProperty

public void removeAllJavamailProperty()

removeJavamailProperty

public boolean removeJavamailProperty(JavamailProperty vJavamailProperty)

Method removeJavamailProperty.

Parameters:

vJavamailProperty -

Returns:

true if the object was removed from the collection.

removeJavamailPropertyAt

public JavamailProperty removeJavamailPropertyAt(int index)

Method removeJavamailPropertyAt.

Parameters:

index -

Returns:

the element removed from the collection

setAttemptInterval

public void setAttemptInterval(long attemptInterval)

Sets the value of field 'attemptInterval'.

Parameters:

attemptInterval - the value of field 'attemptInterval'.

setDebug

public void setDebug(boolean debug)

Sets the value of field 'debug'.

Parameters:

debug - the value of field 'debug'.

setDeleteAllMail

public void setDeleteAllMail(boolean deleteAllMail)

Sets the value of field 'deleteAllMail'.

Parameters:

deleteAllMail - the value of field 'deleteAllMail'.

setJavamailProperty

public void setJavamailProperty(int index,
                       JavamailProperty vJavamailProperty)
                         throws IndexOutOfBoundsException

Parameters:

index -

vJavamailProperty -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setJavamailProperty

public void setJavamailProperty(JavamailProperty[] vJavamailPropertyArray)

Parameters:

vJavamailPropertyArray -

setJavamailProperty

public void setJavamailProperty(List<JavamailProperty> vJavamailPropertyList)

Sets the value of '_javamailPropertyList' by copying the given Vector. All elements will be checked for type safety.

Parameters:

vJavamailPropertyList - the Vector to copy.

setJavamailPropertyCollection

public void setJavamailPropertyCollection(List<JavamailProperty> javamailPropertyList)

Deprecated.

Sets the value of '_javamailPropertyList' by setting it to the given Vector. No type checking is performed.

Parameters:

javamailPropertyList - the Vector to set.

setMailFolder

public void setMailFolder(String mailFolder)

Sets the value of field 'mailFolder'.

Parameters:

mailFolder - the value of field 'mailFolder'.

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setReadmailHost

public void setReadmailHost(ReadmailHost readmailHost)

Sets the value of field 'readmailHost'. The field 'readmailHost' has the following description: Define the host and port of a service for reading email.

Parameters:

readmailHost - the value of field 'readmailHost'.

setUserAuth

public void setUserAuth(UserAuth userAuth)

Sets the value of field 'userAuth'. The field 'userAuth' has the following description: Configure user based authentication.

Parameters:

userAuth - the value of field 'userAuth'.

unmarshal

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

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