All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.network.mail.pop3.protocol.CoreProtocolBean
java.lang.Object
|
+----com.ibm.network.mail.pop3.protocol.CoreProtocolBean
- public class CoreProtocolBean
- extends Object
- implements Serializable
This bean implements the Post Office Protocol and interacts with the POP3
server to receive mails for the user. The user must have an account
on the POP3 server. The received mails may either be deleted or left on
the server. For POP3 servers outside a firewall, the bean provides
support for connection via a socks server.
The received mails are passed on to a UserInterfaceBean
which displays the mails. If the received message contains MIME data
it would have to be decoded by a MimeDecoderBean
before
the mails can be viewed. The received mails can also be stored to
a local file.
The CoreProtocolBean
also allows configuration of user
and server options. These options include POP3 and socks server host
name and port number, user login name and other user options.
The bean also provides continuous status information to the
UserInterfaceBean
as it receives mails from the server.
The status information conveys error conditions also, if any.
This bean throws the following events:
-
MessageEvent
to
-
UserInterfaceBean
to provide newly received message.
-
StatusEvent
to
-
UserInterfaceBean
to convey the status information.
It supports the following event listener interfaces:
-
RequestMessageListener
which is called by:
-
UserInterfaceBean
for receiving new messages.
-
ConfigListener
which is called by:
-
UserInterfaceBean
to set POP3 and socks
server details and also user options.
- Author:
- Mohit M Sant, Abdul Majeed Ghadialy
- See Also:
- MessageEvent, StatusEvent, RequestMessageListener, ConfigListener
-
CoreProtocolBean()
- Constructor for
CoreProtocolBean
.
-
abort()
- Aborts the operation of receiving messages.
-
addMessageListener(MessageListener)
- Adds a listener for
MessageEvent
.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds the specified
PropertyChangeListener
for receiving PropertyChangeEvent
from this bean.
-
addStatusListener(StatusListener)
- Adds a listeners for
StatusEvent
.
-
getLoginId()
- Returns login ID of user.
-
getMessage()
- Returns the newly received message.
-
getPOP3ServerHost()
- Returns the host name of the POP3 server.
-
getPOP3ServerPort()
- Returns the port number of the POP3 server.
-
getSaveMessagesToFile()
- Returns the name of file to which messages are being saved.
-
getSocksServerHost()
- Returns the socks server host name.
-
getSocksServerPort()
- Returns the port number of the socks server.
-
getStatus()
- Returns the current status.
-
isLeaveMessagesOnServer()
- Returns 'true' if messages are being left on server after receiving.
-
isReady()
- Returns true if no operation is currently in progress.
-
isRememberPassword()
- Returns 'true' if user login password is to be remembered.
-
isSaveIncomingMessages()
- Returns true if messages are being saved to a local file.
-
isSocksified()
- Returns 'true' if socks server is being used.
-
receiveMessage()
- Receives new messages.
-
removeMessageListener(MessageListener)
- Removes listener of
MessageEvent
.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes the specified
PropertyChangeListener
.
-
removeStatusListener(StatusListener)
- Removes listeners of
StatusEvent
.
-
setConfigOptions(ConfigEvent)
- Sets POP3, socks server and user settings.
-
setLeaveMessagesOnServer(boolean)
- Indicates whether messages are to be left on POP3 server after receiving.
-
setLoginId(String)
- Sets the POP3 login id of the user.
-
setPOP3Server(String, int)
- Sets the POP server options.
-
setPOP3ServerHost(String)
- Sets the host name/IP address of the POP3 server.
-
setPOP3ServerPort(int)
- Sets port number of the POP3 server.
-
setRememberPassword(boolean)
- Indicates whether user login password is to be remembered.
-
setSaveIncomingMessages(boolean)
- Indicates whether incoming messages are to be saved to a local file.
-
setSaveMessagesToFile(String)
- Sets file to which messages are to be saved.
-
setSocksified(boolean)
- Indicates whether socks server is being used
while receiving messages from POP3 server.
-
setSocksServer(String, int)
- Sets socks server options.
-
setSocksServerHost(String)
- Sets the host name/IP address of the socks server.
-
setSocksServerPort(int)
- Sets the port number of the socks server.
-
setUserOptions(String, String, boolean, boolean)
- Sets POP3 user options.
-
setUserPassword(String)
- Sets the user login password.
CoreProtocolBean
public CoreProtocolBean()
- Constructor for
CoreProtocolBean
.
abort
public void abort()
- Aborts the operation of receiving messages.
addMessageListener
public void addMessageListener(MessageListener ml)
- Adds a listener for
MessageEvent
.
For adding the listeners which:
- Display received new message (
UserInterfaceBean
).
- Parameters:
- ml - com.ibm.network.mail.pop3.event.MessageListener.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds the specified
PropertyChangeListener
for receiving PropertyChangeEvent
from this bean.
Adds the specified property change listener to receive property change
events about all the bound properties in this bean.
Note: This event is thrown for all the bound properties in this
bean. Currently, it is thrown for the only bound property, Ready
whenever the bean's ready status toggles.
- Parameters:
- listener -
PropertyChangeListener
.
addStatusListener
public void addStatusListener(StatusListener sl)
- Adds a listeners for
StatusEvent
.
For adding the listeners which:
- display status information (
UserInterfaceBean
).
- Parameters:
- ml - com.ibm.network.mail.pop3.event.StatusListener.
getLoginId
public String getLoginId()
- Returns login ID of user.
- Returns:
- login ID of user.
- See Also:
- UserOptions
getMessage
public MimeMessage getMessage()
- Returns the newly received message.
- Returns:
- the newly received message.
- See Also:
- MimeMessage
getPOP3ServerHost
public String getPOP3ServerHost()
- Returns the host name of the POP3 server.
- Returns:
- POP3 server's host name/IP address.
- See Also:
- ServerOptions
getPOP3ServerPort
public int getPOP3ServerPort()
- Returns the port number of the POP3 server.
- Returns:
- POP3 server's port number.
- See Also:
- ServerOptions
getSaveMessagesToFile
public String getSaveMessagesToFile()
- Returns the name of file to which messages are being saved.
- Returns:
- the name of file used to store messages.
getSocksServerHost
public String getSocksServerHost()
- Returns the socks server host name.
- Returns:
- socks server's host name/IP address.
- See Also:
- ServerOptions
getSocksServerPort
public int getSocksServerPort()
- Returns the port number of the socks server.
- Returns:
- socks server's port number.
- See Also:
- ServerOptions
getStatus
public String getStatus()
- Returns the current status.
- Returns:
- status information.
isLeaveMessagesOnServer
public boolean isLeaveMessagesOnServer()
- Returns 'true' if messages are being left on server after receiving.
- Returns:
- true if messages are not deleted after receiving, false otherwise.
- See Also:
- UserOptions
isReady
public boolean isReady()
- Returns true if no operation is currently in progress.
Only if "Ready", it can be requested to receive messages.
This is a read-only bound property.
- Returns:
- true if bean is ready to receive new messages, false otherwise.
isRememberPassword
public boolean isRememberPassword()
- Returns 'true' if user login password is to be remembered.
If so, user is not prompted for password at login.
- Returns:
- true if password of user is being remembered, false otherwise.
- See Also:
- UserOptions
isSaveIncomingMessages
public boolean isSaveIncomingMessages()
- Returns true if messages are being saved to a local file.
- Returns:
- true if messages are saved to a file, false otherwise.
isSocksified
public boolean isSocksified()
- Returns 'true' if socks server is being used.
Socksification is required while receiving messages from POP3 server
running outside a firewall.
- Returns:
- true if socksification has been applied, false otherwise.
- See Also:
- UserOptions
receiveMessage
public void receiveMessage()
- Receives new messages.
This method is invoked by the
UserInterfaceBean
to receive new messages from the POP3 server.
- See Also:
- MimeMessage
removeMessageListener
public void removeMessageListener(MessageListener ml)
- Removes listener of
MessageEvent
.
For removing the listeners which:
- receive new messages (
UserInterfaceBean
)
- Parameters:
- ml - com.ibm.network.mail.pop3.event.MessageListener.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- Removes the specified
PropertyChangeListener
.
The listener may be any application interested in change of read-only bound property Ready
.
- Parameters:
- cl -
PropertyChangeListener
to be removed.
removeStatusListener
public void removeStatusListener(StatusListener sl)
- Removes listeners of
StatusEvent
.
For removing the listeners which:
- display status information (
UserInterfaceBean
).
- Parameters:
- ml - com.ibm.network.mail.pop3.event.StatusListener.
setConfigOptions
public void setConfigOptions(ConfigEvent evt)
- Sets POP3, socks server and user settings.
- Parameters:
- evt -
ConfigEvent
containing the options.
- See Also:
- ConfigEvent
setLeaveMessagesOnServer
public void setLeaveMessagesOnServer(boolean b)
- Indicates whether messages are to be left on POP3 server after receiving.
- Parameters:
- b - true if messages are to be left on server, false otherwise.
- See Also:
- UserOptions
setLoginId
public void setLoginId(String id)
- Sets the POP3 login id of the user.
- Parameters:
- id - login ID of user..
- Throws: IllegalArgumentException
- if POP3 Login name is null or blank.
- See Also:
- UserOptions
setPOP3Server
public void setPOP3Server(String hostName,
int portNumber)
- Sets the POP server options.
- Parameters:
- hostName - host name/IP address of POP3 server.
- portNumber - of POP3 server.
setPOP3ServerHost
public void setPOP3ServerHost(String server)
- Sets the host name/IP address of the POP3 server.
- Parameters:
- server - POP3 server's host name/IP address.
- Throws: IllegalArgumentException
- if POP3 server name is null or blank.
- See Also:
- ServerOptions
setPOP3ServerPort
public void setPOP3ServerPort(int port)
- Sets port number of the POP3 server.
- Parameters:
- port - POP3 server's port number (default=110).
setRememberPassword
public void setRememberPassword(boolean b)
- Indicates whether user login password is to be remembered.
If so, user is not prompted for password at login.
- Parameters:
- b - true if password of user is to be remembered, false otherwise.
- See Also:
- UserOptions
setSaveIncomingMessages
public void setSaveIncomingMessages(boolean b)
- Indicates whether incoming messages are to be saved to a local file.
- Parameters:
- b - true if messages are to be saved, false otherwise.
setSaveMessagesToFile
public void setSaveMessagesToFile(String fileName)
- Sets file to which messages are to be saved.
- Parameters:
- fileName - name of file to which messages will be saved.
- Throws: IllegalArgumentException
- if File name is null or blank.
setSocksified
public void setSocksified(boolean b)
- Indicates whether socks server is being used
while receiving messages from POP3 server.
- Parameters:
- b - true if socksification is to be applied.
- See Also:
- ServerOptions
setSocksServer
public void setSocksServer(String hostName,
int portNumber)
- Sets socks server options.
- Parameters:
- hostName - socks server host name/IP address.
- portNumber - port number of socks server.
- See Also:
- ServerOptions
setSocksServerHost
public void setSocksServerHost(String server)
- Sets the host name/IP address of the socks server.
- Parameters:
- server - socks server's host name/IP address.
- Throws: IllegalArgumentException
- if socks host name is null or blank.
- See Also:
- ServerOptions
setSocksServerPort
public void setSocksServerPort(int port)
- Sets the port number of the socks server.
- Parameters:
- port - socks server's port number.
- Throws: IllegalArgumentException
- if socks port is < 1.
- See Also:
- ServerOptions
setUserOptions
public void setUserOptions(String popLoginName,
String password,
boolean leaveMessagesOnServer,
boolean rememberPassword)
- Sets POP3 user options.
- Parameters:
- popLoginName - login name of user.
- password - login password.
- leaveMessagesOnServer - true if messages are to be left on server, false otherwise.
- rememberPassword - whether user login password is to be remembered, false otherwise.
- Throws: IllegalArgumentException
- if POP3 login name/password is null or blank.
- See Also:
- UserOptions
setUserPassword
public void setUserPassword(String password)
- Sets the user login password.
- Parameters:
- password - password of user.
- Throws: IllegalArgumentException
- if user password is null.
All Packages Class Hierarchy This Package Previous Next Index