org.datamanager.passiveentityvalue
Class EmailParametersEntityValue

java.lang.Object
  |
  +--org.datamanager.passiveentityvalue.EmailParametersEntityValue

All Implemented Interfaces:

EntityValue, PassiveEntityValue, Serializable

public class EmailParametersEntityValue

extends Object

implements PassiveEntityValue

This class represents the various JavaMail email account configuration settings for a user's email account. Encapsulates a String username, PasswordEntityValue, String host machine name, String access protocol, String mailbox name, String from address and String SMTP Host.

Version:

$Revision: 1.8 $

Author:

Team Helium

See Also:

Serialized Form

Constructor Summary

EmailParametersEntityValue(String username, PasswordEntityValue passwordEntityValue, String hostMachineName, String accessProtocolName, String mailboxName, String fromAddress, String SMTPHost)

Method Summary

boolean	equals(Object object) Compares the specified Object with this EmailParametersEntityValue for equality.
String	getAccessProtocolName() Returns a String representation of the access protocol ("imap", "imaps", "pop3", etc.) to be used when connecting to the host machine.
String	getFromAddress() Returns the address the user would like outgoing email to be sent as from.
String	getHostMachineName() Returns a String representation of the host machine to which this EmailParametersEntityValue can connect.
String	getMailboxName() Returns the name of the mailbox data store to be opened after connecting to the host machine.
PasswordEntityValue	getPasswordEntityValue() Returns the PasswordEntityValue encapsulated by this EmailParametersEntityValue.
String	getSMTPHost() Returns the SMTP host to which outgoing mail is delivered.
String	getUsername() Returns the String username encapsulated by this EmailParametersEntityValue.
int	hashCode() Returns the int hashCode() of this EmailParametersEntityValue.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailParametersEntityValue

public EmailParametersEntityValue(String username,
                                  PasswordEntityValue passwordEntityValue,
                                  String hostMachineName,
                                  String accessProtocolName,
                                  String mailboxName,
                                  String fromAddress,
                                  String SMTPHost)

Method Detail

getUsername

public String getUsername()

Returns the String username encapsulated by this EmailParametersEntityValue.

getPasswordEntityValue

public PasswordEntityValue getPasswordEntityValue()

Returns the PasswordEntityValue encapsulated by this EmailParametersEntityValue. The PasswordEntityValue _should_ take care of authenticating anyone attempting to access its password field.

getHostMachineName

public String getHostMachineName()

Returns a String representation of the host machine to which this EmailParametersEntityValue can connect.

getAccessProtocolName

public String getAccessProtocolName()

Returns a String representation of the access protocol ("imap", "imaps", "pop3", etc.) to be used when connecting to the host machine.

getMailboxName

public String getMailboxName()

Returns the name of the mailbox data store to be opened after connecting to the host machine. A mailbox name of "*" signifies all mailboxes at the top level of the email data store.

getFromAddress

public String getFromAddress()

Returns the address the user would like outgoing email to be sent as from.

getSMTPHost

public String getSMTPHost()

Returns the SMTP host to which outgoing mail is delivered.

equals

public boolean equals(Object object)

Compares the specified Object with this EmailParametersEntityValue for equality. Returns true if and only if the specified Object is an instance of a EmailParametersEntityValue and all fields of the EmailParametersEntityValue satisfy equals() with all fields of this EmailParametersEntityValue. It is expected that all member fields for EmailParametersEntityValue-s override Object's equals() method.

Specified by:

equals in interface PassiveEntityValue

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the int hashCode() of this EmailParametersEntityValue. FIXME: this doesn't include from address and stmp host, should it?

Specified by:

hashCode in interface PassiveEntityValue

Overrides:

hashCode in class Object