org.opennms.netmgt.config.javamail
Class JavamailConfiguration

java.lang.Object
  org.opennms.netmgt.config.javamail.JavamailConfiguration

All Implemented Interfaces:

Serializable

public class JavamailConfiguration
extends Object
implements Serializable

Read and Send configuration groups

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

JavamailConfiguration()

Method Summary

void	addEnd2endMailConfig(End2endMailConfig vEnd2endMailConfig)
void	addEnd2endMailConfig(int index, End2endMailConfig vEnd2endMailConfig)
void	addReadmailConfig(int index, ReadmailConfig vReadmailConfig)
void	addReadmailConfig(ReadmailConfig vReadmailConfig)
void	addSendmailConfig(int index, SendmailConfig vSendmailConfig)
void	addSendmailConfig(SendmailConfig vSendmailConfig)
Enumeration<End2endMailConfig>	enumerateEnd2endMailConfig() Method enumerateEnd2endMailConfig.
Enumeration<ReadmailConfig>	enumerateReadmailConfig() Method enumerateReadmailConfig.
Enumeration<SendmailConfig>	enumerateSendmailConfig() Method enumerateSendmailConfig.
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getDefaultReadConfigName() Returns the value of field 'defaultReadConfigName'.
String	getDefaultSendConfigName() Returns the value of field 'defaultSendConfigName'.
End2endMailConfig[]	getEnd2endMailConfig() Method getEnd2endMailConfig.Returns the contents of the collection in an Array.
End2endMailConfig	getEnd2endMailConfig(int index) Method getEnd2endMailConfig.
List<End2endMailConfig>	getEnd2endMailConfigCollection() Method getEnd2endMailConfigCollection.Returns a reference to '_end2endMailConfigList'.
int	getEnd2endMailConfigCount() Method getEnd2endMailConfigCount.
ReadmailConfig[]	getReadmailConfig() Method getReadmailConfig.Returns the contents of the collection in an Array.
ReadmailConfig	getReadmailConfig(int index) Method getReadmailConfig.
List<ReadmailConfig>	getReadmailConfigCollection() Method getReadmailConfigCollection.Returns a reference to '_readmailConfigList'.
int	getReadmailConfigCount() Method getReadmailConfigCount.
SendmailConfig[]	getSendmailConfig() Method getSendmailConfig.Returns the contents of the collection in an Array.
SendmailConfig	getSendmailConfig(int index) Method getSendmailConfig.
List<SendmailConfig>	getSendmailConfigCollection() Method getSendmailConfigCollection.Returns a reference to '_sendmailConfigList'.
int	getSendmailConfigCount() Method getSendmailConfigCount.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
Iterator<End2endMailConfig>	iterateEnd2endMailConfig() Method iterateEnd2endMailConfig.
Iterator<ReadmailConfig>	iterateReadmailConfig() Method iterateReadmailConfig.
Iterator<SendmailConfig>	iterateSendmailConfig() Method iterateSendmailConfig.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllEnd2endMailConfig()
void	removeAllReadmailConfig()
void	removeAllSendmailConfig()
boolean	removeEnd2endMailConfig(End2endMailConfig vEnd2endMailConfig) Method removeEnd2endMailConfig.
End2endMailConfig	removeEnd2endMailConfigAt(int index) Method removeEnd2endMailConfigAt.
boolean	removeReadmailConfig(ReadmailConfig vReadmailConfig) Method removeReadmailConfig.
ReadmailConfig	removeReadmailConfigAt(int index) Method removeReadmailConfigAt.
boolean	removeSendmailConfig(SendmailConfig vSendmailConfig) Method removeSendmailConfig.
SendmailConfig	removeSendmailConfigAt(int index) Method removeSendmailConfigAt.
void	setDefaultReadConfigName(String defaultReadConfigName) Sets the value of field 'defaultReadConfigName'.
void	setDefaultSendConfigName(String defaultSendConfigName) Sets the value of field 'defaultSendConfigName'.
void	setEnd2endMailConfig(End2endMailConfig[] vEnd2endMailConfigArray)
void	setEnd2endMailConfig(int index, End2endMailConfig vEnd2endMailConfig)
void	setEnd2endMailConfig(List<End2endMailConfig> vEnd2endMailConfigList) Sets the value of '_end2endMailConfigList' by copying the given Vector.
void	setEnd2endMailConfigCollection(List<End2endMailConfig> end2endMailConfigList) Deprecated.
void	setReadmailConfig(int index, ReadmailConfig vReadmailConfig)
void	setReadmailConfig(List<ReadmailConfig> vReadmailConfigList) Sets the value of '_readmailConfigList' by copying the given Vector.
void	setReadmailConfig(ReadmailConfig[] vReadmailConfigArray)
void	setReadmailConfigCollection(List<ReadmailConfig> readmailConfigList) Deprecated.
void	setSendmailConfig(int index, SendmailConfig vSendmailConfig)
void	setSendmailConfig(List<SendmailConfig> vSendmailConfigList) Sets the value of '_sendmailConfigList' by copying the given Vector.
void	setSendmailConfig(SendmailConfig[] vSendmailConfigArray)
void	setSendmailConfigCollection(List<SendmailConfig> sendmailConfigList) Deprecated.
static JavamailConfiguration	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

JavamailConfiguration

public JavamailConfiguration()

Method Detail

addEnd2endMailConfig

public void addEnd2endMailConfig(End2endMailConfig vEnd2endMailConfig)
                          throws IndexOutOfBoundsException

Parameters:

vEnd2endMailConfig -

Throws:

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

addEnd2endMailConfig

public void addEnd2endMailConfig(int index,
                                 End2endMailConfig vEnd2endMailConfig)
                          throws IndexOutOfBoundsException

Parameters:

index -

vEnd2endMailConfig -

Throws:

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

addReadmailConfig

public void addReadmailConfig(ReadmailConfig vReadmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

vReadmailConfig -

Throws:

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

addReadmailConfig

public void addReadmailConfig(int index,
                              ReadmailConfig vReadmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

index -

vReadmailConfig -

Throws:

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

addSendmailConfig

public void addSendmailConfig(SendmailConfig vSendmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

vSendmailConfig -

Throws:

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

addSendmailConfig

public void addSendmailConfig(int index,
                              SendmailConfig vSendmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

index -

vSendmailConfig -

Throws:

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

enumerateEnd2endMailConfig

public Enumeration<End2endMailConfig> enumerateEnd2endMailConfig()

Method enumerateEnd2endMailConfig.

Returns:

an Enumeration over all possible elements of this collection

enumerateReadmailConfig

public Enumeration<ReadmailConfig> enumerateReadmailConfig()

Method enumerateReadmailConfig.

Returns:

an Enumeration over all possible elements of this collection

enumerateSendmailConfig

public Enumeration<SendmailConfig> enumerateSendmailConfig()

Method enumerateSendmailConfig.

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.

getDefaultReadConfigName

public String getDefaultReadConfigName()

Returns the value of field 'defaultReadConfigName'.

Returns:

the value of field 'DefaultReadConfigName'.

getDefaultSendConfigName

public String getDefaultSendConfigName()

Returns the value of field 'defaultSendConfigName'.

Returns:

the value of field 'DefaultSendConfigName'.

getEnd2endMailConfig

public End2endMailConfig getEnd2endMailConfig(int index)
                                       throws IndexOutOfBoundsException

Method getEnd2endMailConfig.

Parameters:

index -

Returns:

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

Throws:

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

getEnd2endMailConfig

public End2endMailConfig[] getEnd2endMailConfig()

Method getEnd2endMailConfig.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

getEnd2endMailConfigCollection

public List<End2endMailConfig> getEnd2endMailConfigCollection()

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

Returns:

a reference to the Vector backing this class

getEnd2endMailConfigCount

public int getEnd2endMailConfigCount()

Method getEnd2endMailConfigCount.

Returns:

the size of this collection

getReadmailConfig

public ReadmailConfig getReadmailConfig(int index)
                                 throws IndexOutOfBoundsException

Method getReadmailConfig.

Parameters:

index -

Returns:

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

Throws:

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

getReadmailConfig

public ReadmailConfig[] getReadmailConfig()

Method getReadmailConfig.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

getReadmailConfigCollection

public List<ReadmailConfig> getReadmailConfigCollection()

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

Returns:

a reference to the Vector backing this class

getReadmailConfigCount

public int getReadmailConfigCount()

Method getReadmailConfigCount.

Returns:

the size of this collection

getSendmailConfig

public SendmailConfig getSendmailConfig(int index)
                                 throws IndexOutOfBoundsException

Method getSendmailConfig.

Parameters:

index -

Returns:

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

Throws:

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

getSendmailConfig

public SendmailConfig[] getSendmailConfig()

Method getSendmailConfig.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

getSendmailConfigCollection

public List<SendmailConfig> getSendmailConfigCollection()

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

Returns:

a reference to the Vector backing this class

getSendmailConfigCount

public int getSendmailConfigCount()

Method getSendmailConfigCount.

Returns:

the size of this collection

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

iterateEnd2endMailConfig

public Iterator<End2endMailConfig> iterateEnd2endMailConfig()

Method iterateEnd2endMailConfig.

Returns:

an Iterator over all possible elements in this collection

iterateReadmailConfig

public Iterator<ReadmailConfig> iterateReadmailConfig()

Method iterateReadmailConfig.

Returns:

an Iterator over all possible elements in this collection

iterateSendmailConfig

public Iterator<SendmailConfig> iterateSendmailConfig()

Method iterateSendmailConfig.

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

removeAllEnd2endMailConfig

public void removeAllEnd2endMailConfig()

removeAllReadmailConfig

public void removeAllReadmailConfig()

removeAllSendmailConfig

public void removeAllSendmailConfig()

removeEnd2endMailConfig

public boolean removeEnd2endMailConfig(End2endMailConfig vEnd2endMailConfig)

Method removeEnd2endMailConfig.

Parameters:

vEnd2endMailConfig -

Returns:

true if the object was removed from the collection.

removeEnd2endMailConfigAt

public End2endMailConfig removeEnd2endMailConfigAt(int index)

Method removeEnd2endMailConfigAt.

Parameters:

index -

Returns:

the element removed from the collection

removeReadmailConfig

public boolean removeReadmailConfig(ReadmailConfig vReadmailConfig)

Method removeReadmailConfig.

Parameters:

vReadmailConfig -

Returns:

true if the object was removed from the collection.

removeReadmailConfigAt

public ReadmailConfig removeReadmailConfigAt(int index)

Method removeReadmailConfigAt.

Parameters:

index -

Returns:

the element removed from the collection

removeSendmailConfig

public boolean removeSendmailConfig(SendmailConfig vSendmailConfig)

Method removeSendmailConfig.

Parameters:

vSendmailConfig -

Returns:

true if the object was removed from the collection.

removeSendmailConfigAt

public SendmailConfig removeSendmailConfigAt(int index)

Method removeSendmailConfigAt.

Parameters:

index -

Returns:

the element removed from the collection

setDefaultReadConfigName

public void setDefaultReadConfigName(String defaultReadConfigName)

Sets the value of field 'defaultReadConfigName'.

Parameters:

defaultReadConfigName - the value of field 'defaultReadConfigName'.

setDefaultSendConfigName

public void setDefaultSendConfigName(String defaultSendConfigName)

Sets the value of field 'defaultSendConfigName'.

Parameters:

defaultSendConfigName - the value of field 'defaultSendConfigName'.

setEnd2endMailConfig

public void setEnd2endMailConfig(int index,
                                 End2endMailConfig vEnd2endMailConfig)
                          throws IndexOutOfBoundsException

Parameters:

index -

vEnd2endMailConfig -

Throws:

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

setEnd2endMailConfig

public void setEnd2endMailConfig(End2endMailConfig[] vEnd2endMailConfigArray)

Parameters:

vEnd2endMailConfigArray -

setEnd2endMailConfig

public void setEnd2endMailConfig(List<End2endMailConfig> vEnd2endMailConfigList)

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

Parameters:

vEnd2endMailConfigList - the Vector to copy.

setEnd2endMailConfigCollection

public void setEnd2endMailConfigCollection(List<End2endMailConfig> end2endMailConfigList)

Deprecated.

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

Parameters:

end2endMailConfigList - the Vector to set.

setReadmailConfig

public void setReadmailConfig(int index,
                              ReadmailConfig vReadmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

index -

vReadmailConfig -

Throws:

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

setReadmailConfig

public void setReadmailConfig(ReadmailConfig[] vReadmailConfigArray)

Parameters:

vReadmailConfigArray -

setReadmailConfig

public void setReadmailConfig(List<ReadmailConfig> vReadmailConfigList)

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

Parameters:

vReadmailConfigList - the Vector to copy.

setReadmailConfigCollection

public void setReadmailConfigCollection(List<ReadmailConfig> readmailConfigList)

Deprecated.

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

Parameters:

readmailConfigList - the Vector to set.

setSendmailConfig

public void setSendmailConfig(int index,
                              SendmailConfig vSendmailConfig)
                       throws IndexOutOfBoundsException

Parameters:

index -

vSendmailConfig -

Throws:

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

setSendmailConfig

public void setSendmailConfig(SendmailConfig[] vSendmailConfigArray)

Parameters:

vSendmailConfigArray -

setSendmailConfig

public void setSendmailConfig(List<SendmailConfig> vSendmailConfigList)

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

Parameters:

vSendmailConfigList - the Vector to copy.

setSendmailConfigCollection

public void setSendmailConfigCollection(List<SendmailConfig> sendmailConfigList)

Deprecated.

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

Parameters:

sendmailConfigList - the Vector to set.

unmarshal

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

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