|
Email Answering System Version 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ninecode.email.connector.EmailConnectionData | +--com.ninecode.email.connector.EmailConfigurationData
A bean containing all email configuration data.
Configuration data is not the same as connection data. Configuration data
is the necessary information required to be able to connect while
connection data is only the user data needed to connect.
Since this class subclasses the EmailConnectionData
class,
it contains connection data such as user name and password, but adds such
items as servers and ports, which are details the user need not be
concerned with.
Field Summary | |
protected boolean |
mBackgroundThread
Controls the state of the background thread. |
protected int |
mBackgroundThreadInitialDelay
Initial thread startup delay in milliseconds. |
protected int |
mBackgroundThreadPollDelay
Holds value of property backgroundThreadPollDelay. |
protected int |
mBackgroundThreadReconnectDelay
Reconnection delay in milliseconds. |
protected String |
mQueueConnectionFactoryResourceReference
Holds value of property queueConnectionFactoryResourceReference. |
protected String |
mQueueConnectionReference
Holds value of property queueConnectionReference. |
protected String |
mStoreFile
Holds value of property storeFile. |
protected String |
mStoreHost
Holds value of property storeHost. |
protected int |
mStorePort
Holds value of property storePort. |
protected String |
mStoreProtocol
Holds value of property storeProtocol. |
protected String |
mTransportFile
Holds value of property transportFile. |
protected String |
mTransportHost
Holds value of property transportHost. |
protected int |
mTransportPort
Holds value of property transportPort. |
protected String |
mTransportProtocol
Holds value of property transportProtocol. |
Fields inherited from class com.ninecode.email.connector.EmailConnectionData |
mMailProperties, mPropertySupport, mStorePassword, mStoreUserName, mTransportPassword, mTransportUserName |
Constructor Summary | |
EmailConfigurationData()
Creates a new instance of EmailConfigurationData. |
|
EmailConfigurationData(EmailConfigurationData data)
Creates a new instance of EmailConfigurationData from an existing one. |
Method Summary | |
boolean |
equals(Object other)
Returns true if the other object is equal to this one. |
boolean |
getBackgroundThread()
Getter for property backgroundThread. |
int |
getBackgroundThreadInitialDelay()
Getter for property backgroundThreadInitialDelay. |
int |
getBackgroundThreadPollDelay()
Getter for property backgroundThreadPollDelay. |
int |
getBackgroundThreadReconnectDelay()
Getter for property backgroundThreadReconnectDelay. |
String |
getQueueConnectionFactoryResourceReference()
Getter for property queueConnectionFactoryResourceReference. |
String |
getQueueConnectionReference()
Getter for property queueConnectionReference. |
String |
getStoreFile()
Getter for property storeFile. |
String |
getStoreHost()
Getter for property storeHost. |
int |
getStorePort()
Getter for property storePort. |
String |
getStoreProtocol()
Getter for property storeProtocol. |
String |
getTransportFile()
Getter for property transportFile. |
String |
getTransportHost()
Getter for property transportHost. |
int |
getTransportPort()
Getter for property transportPort. |
String |
getTransportProtocol()
Getter for property transportProtocol. |
int |
hashCode()
Returns a hash code for this object. |
void |
setBackgroundThread(boolean state)
Setter for property backgroundThread. |
void |
setBackgroundThread(Boolean state)
Setter for property backgroundThread. |
void |
setBackgroundThreadInitialDelay(int delay)
Setter for property backgroundThreadInitialDelay. |
void |
setBackgroundThreadInitialDelay(Integer delay)
Setter for property backgroundThreadInitialDelay. |
void |
setBackgroundThreadPollDelay(int delay)
Setter for property backgroundThreadPollDelay. |
void |
setBackgroundThreadPollDelay(Integer delay)
Setter for property backgroundThreadPollDelay. |
void |
setBackgroundThreadReconnectDelay(int delay)
Setter for property backgroundThreadReconnectDelay. |
void |
setBackgroundThreadReconnectDelay(Integer delay)
Setter for property backgroundThreadReconnectDelay. |
void |
setQueueConnectionFactoryResourceReference(String reference)
Setter for property queueConnectionFactoryResourceReference. |
void |
setQueueConnectionReference(String reference)
Setter for property queueConnectionReference. |
void |
setStoreFile(String file)
Setter for property storeFile. |
void |
setStoreHost(String host)
Setter for property storeHost. |
void |
setStorePort(int port)
Setter for property storePort. |
void |
setStorePort(Integer port)
Setter for property storePort. |
void |
setStoreProtocol(String protocol)
Setter for property storeProtocol. |
void |
setTransportFile(String file)
Setter for property transportFile. |
void |
setTransportHost(String host)
Setter for property transportHost. |
void |
setTransportPort(int port)
Setter for property transportPort. |
void |
setTransportPort(Integer port)
Setter for property storePort. |
void |
setTransportProtocol(String protocol)
Setter for property transportProtocol. |
boolean |
storeEquals(Object other)
Returns true if the other object has a Store configuration
equal to this one. |
String |
toString()
Converts this data object into a printable string. |
Methods inherited from class com.ninecode.email.connector.EmailConnectionData |
addPropertyChangeListener, clone, dup, getMailProperties, getPassword, getStorePassword, getStoreUserName, getTransportPassword, getTransportUserName, getUserName, override, removePropertyChangeListener, setMailProperties, setPassword, setStorePassword, setStoreUserName, setTransportPassword, setTransportUserName, setUserName |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected String mTransportProtocol
protected String mTransportHost
protected int mTransportPort
protected String mTransportFile
protected String mStoreProtocol
protected String mStoreHost
protected int mStorePort
protected String mStoreFile
protected int mBackgroundThreadPollDelay
protected boolean mBackgroundThread
protected int mBackgroundThreadInitialDelay
protected int mBackgroundThreadReconnectDelay
protected String mQueueConnectionFactoryResourceReference
protected String mQueueConnectionReference
Constructor Detail |
public EmailConfigurationData()
Property | Default |
---|---|
transportProtocol | smtp |
transportHost | localhost |
transportPort | -1 |
transportFile | |
storeProtocol | pop3 |
storeHost | localhost |
storePort | -1 |
storeFile | |
backgroundThreadPollDelay | 30000 |
backgroundThreadInitialDelay | 15000 |
backgroundThreadReconnectDelay | 300000 |
queueConnectionFactoryResourceReference | jms/QueueConnectionFactory |
queueConnectionReference | jms/Inbox |
backgroundThread | false |
The backgroundThread property is set last because it could cause
a new Thread
to be started, and that will need a fully
constructed object.
public EmailConfigurationData(EmailConfigurationData data)
Thread
to be started, and that will need a fully
constructed object.
data
- The configuration data to copy.Method Detail |
public boolean equals(Object other)
true
if the other object is equal to this one.
equals
in interface ConnectionRequestInfo
equals
in class EmailConnectionData
true
if the other object is equal to this one.public boolean storeEquals(Object other)
true
if the other object has a Store configuration
equal to this one.
The Transport, background threading, and target queue are not considered
in the comparison.
storeEquals
in class EmailConnectionData
true
if the other object has a Store configuration
the same as this one.public int hashCode()
hashCode
in interface ConnectionRequestInfo
hashCode
in class EmailConnectionData
public String getTransportProtocol()
public void setTransportProtocol(String protocol)
protocol
- New value of property transportProtocol.
IllegalArgumentException
- if the protocol is null
.public String getTransportHost()
public void setTransportHost(String host)
host
- New value of property transportHost.
IllegalArgumentException
- if the host is null
.public int getTransportPort()
public void setTransportPort(Integer port)
port
- New value of property storePort.
IllegalArgumentException
- if the port is not in the range -1 <= port <= 65535.setTransportPort(int)
public void setTransportPort(int port)
port
- New value of property transportPort.
IllegalArgumentException
- if the port is not in the range -1 <= port <= 65535.public String getTransportFile()
public void setTransportFile(String file)
file
- New value of property transportFile.
IllegalArgumentException
- if the file is null
.public String getStoreProtocol()
public void setStoreProtocol(String protocol)
protocol
- New value of property storeProtocol.
IllegalArgumentException
- if the protocol is null
.public String getStoreHost()
public void setStoreHost(String host)
host
- New value of property storeHost.
IllegalArgumentException
- if the host is null
.public int getStorePort()
public void setStorePort(Integer port)
port
- New value of property storePort.
IllegalArgumentException
- if the port is not in the range -1 <= port <= 65535.setStorePort(int)
public void setStorePort(int port)
port
- New value of property storePort.
IllegalArgumentException
- if the port is not in the range -1 <= port <= 65535.public String getStoreFile()
public void setStoreFile(String file)
file
- New value of property storeFile.
IllegalArgumentException
- if the file is null
.public int getBackgroundThreadPollDelay()
public void setBackgroundThreadPollDelay(Integer delay)
delay
- New value of property backgroundThreadPollDelay.
IllegalArgumentException
- if the delay is negative.setBackgroundThreadPollDelay(int)
public void setBackgroundThreadPollDelay(int delay)
delay
- New value of property backgroundThreadPollDelay.
IllegalArgumentException
- if the delay is negative.public boolean getBackgroundThread()
public void setBackgroundThread(Boolean state)
state
- New value of property backgroundThread.setBackgroundThread(boolean)
public void setBackgroundThread(boolean state)
state
- New value of property backgroundThread.public int getBackgroundThreadInitialDelay()
public void setBackgroundThreadInitialDelay(Integer delay)
delay
- New value of property backgroundThreadInitialDelay.
Time is milliseconds between thread start and any interaction with
the container or other components.
IllegalArgumentException
- if the delay is negative.setBackgroundThreadInitialDelay(int)
public void setBackgroundThreadInitialDelay(int delay)
delay
- New value of property backgroundThreadInitialDelay.
Time is milliseconds between thread start and any interaction with
the container or other components.
IllegalArgumentException
- if the delay is negative.public int getBackgroundThreadReconnectDelay()
public void setBackgroundThreadReconnectDelay(Integer delay)
delay
- New value of property backgroundThreadReconnectDelay.
Time is milliseconds between reconnect attempts in the event of a
series of failures that places the thread in a waiting state.
IllegalArgumentException
- if the delay is negative.setBackgroundThreadReconnectDelay(int)
public void setBackgroundThreadReconnectDelay(int delay)
delay
- New value of property backgroundThreadReconnectDelay.
Time is milliseconds between reconnect attempts in the event of a
series of failures that places the thread in a waiting state.
IllegalArgumentException
- if the delay is negative.public String getQueueConnectionFactoryResourceReference()
public void setQueueConnectionFactoryResourceReference(String reference)
reference
- New value of property queueConnectionFactoryResourceReference.
IllegalArgumentException
- if the reference is null
.public String getQueueConnectionReference()
public void setQueueConnectionReference(String reference)
reference
- New value of property queueConnectionReference.
IllegalArgumentException
- if the reference is null
.public String toString()
toString
in class EmailConnectionData
|
Email Answering System Version 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |