| java.lang.Object
 org.apache.geronimo.mail.ProtocolGBean
org.apache.geronimo.mail.POP3StoreGBean
| POP3StoreGBean | | public class POP3StoreGBean extends ProtocolGBean (Code) | | A GBean that provides for the configuration of a JavaMail POP3 message store
protocol.
POP3 store properties that are common to all POP3 stores are
provided via member variables of this class. Values that are set in the
individual member variables will override any of the corresponding values
that have been set in the properties set.
version:
$Rev: 486195 $ $Date: 2006-12-12 07:42:02 -0800 (Tue, 12 Dec 2006) $
See Also: MailGBean |
| Constructor Summary | |
| public | POP3StoreGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, Boolean rsetBeforeQuit, String messageClass, String localaddress, Integer localport, Boolean apopEnable, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)
Construct an instance of POP3StoreGBean
Values that are set in the individual member variables will override any of
the corresponding values that have been set in the properties set. |
| Method Summary | |
| public void | addOverrides(Properties props)
Add the overrides from the member variables to the properties file. | | public void | doFail()
| | public void | doStart()
| | public void | doStop()
| | public Integer | getConnectionTimeout()
Returns the socket connection timeout value in milliseconds. | | public static GBeanInfo | getGBeanInfo()
| | public String | getLocaladdress()
Returns the local address (host name) to bind to when creating the POP3 socket. | | public Integer | getLocalport()
Returns the local port number to bind to when creating the POP3 socket. | | public String | getMessageClass()
Returns the class name of a subclass of com.sun.mail.pop3.POP3Message.
Class name of a subclass of com.sun.mail.pop3.POP3Message. | | public Integer | getPort()
Returns the POP3 server port to connect to, if the connect() method
doesn't explicitly specify one. | | public Boolean | getRsetBeforeQuit()
Returns whether an attempt will be made send a POP3 RSET command when
closing the folder, before sending the QUIT command.
Send a POP3 RSET command when closing the folder, before sending the
QUIT command. | | public String | getSocketFactoryClass()
Returns the class that will be used to create POP3 sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | public Integer | getSocketFactoryPort()
Returns the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. | | public Integer | getTimeout()
Returns the socket I/O timeout value in milliseconds. | | public Boolean | isApopEnable()
Returns whether to use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP.
If set to true, use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP. | | public Boolean | isSocketFactoryFallback()
Returns whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. | | public void | setApopEnable(Boolean apopEnable)
Sets whether to use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP.
If set to true, use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP. | | public void | setConnectionTimeout(Integer connectionTimeout)
Sets the socket connection timeout value in milliseconds. | | public void | setLocaladdress(String localaddress)
Sets the local address (host name) to bind to when creating the POP3 socket.
Local address (host name) to bind to when creating the POP3 socket.
Defaults to the address picked by the Socket class. | | public void | setLocalport(Integer localport)
Sets the local port number to bind to when creating the POP3 socket.
Local port number to bind to when creating the POP3 socket. | | public void | setMessageClass(String messageClass)
Sets the class name of a subclass of com.sun.mail.pop3.POP3Message.
Class name of a subclass of com.sun.mail.pop3.POP3Message. | | public void | setPort(Integer port)
Sets the POP3 server port to connect to, if the connect() method
doesn't explicitly specify one. | | public void | setRsetBeforeQuit(Boolean rsetBeforeQuit)
Sets whether an attempt will be made send a POP3 RSET command when
closing the folder, before sending the QUIT command.
Send a POP3 RSET command when closing the folder, before sending the
QUIT command. | | public void | setSocketFactoryClass(String socketFactoryClass)
Sets the class that will be used to create POP3 sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. | | public void | setSocketFactoryFallback(Boolean socketFactoryFallback)
Sets whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. | | public void | setSocketFactoryPort(Integer socketFactoryPort)
Sets the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. | | public void | setTimeout(Integer timeout)
Sets the socket I/O timeout value in milliseconds. |
| GBEAN_INFO | | final public static GBeanInfo GBEAN_INFO(Code) | | |
| GBEAN_MESSAGE_CLASS | | final public static String GBEAN_MESSAGE_CLASS(Code) | | |
| POP3_CONNECTION_TIMEOUT | | final public static String POP3_CONNECTION_TIMEOUT(Code) | | |
| POP3_FACTORY_CLASS | | final public static String POP3_FACTORY_CLASS(Code) | | |
| POP3_FACTORY_FALLBACK | | final public static String POP3_FACTORY_FALLBACK(Code) | | |
| POP3_FACTORY_PORT | | final public static String POP3_FACTORY_PORT(Code) | | |
| POP3_LOCALADDRESS | | final public static String POP3_LOCALADDRESS(Code) | | |
| POP3_LOCALHOST | | final public static String POP3_LOCALHOST(Code) | | |
| POP3_LOCALPORT | | final public static String POP3_LOCALPORT(Code) | | |
| POP3_MESSAGE_CLASS | | final public static String POP3_MESSAGE_CLASS(Code) | | |
| POP3StoreGBean | | public POP3StoreGBean(String objectName, Properties properties, String host, String user, Integer port, Integer connectionTimeout, Integer timeout, Boolean rsetBeforeQuit, String messageClass, String localaddress, Integer localport, Boolean apopEnable, String socketFactoryClass, Boolean socketFactoryFallback, Integer socketFactoryPort)(Code) | | Construct an instance of POP3StoreGBean
Values that are set in the individual member variables will override any of
the corresponding values that have been set in the properties set.
Parameters:
objectName - the object name of the protocol
Parameters:
properties - the set of default properties for the protocol
Parameters:
host - the host the protocol connects to
Parameters:
user - the default name for the protocol
Parameters:
port - the POP3 server port
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds
Parameters:
timeout - the socket I/O timeout value in milliseconds
Parameters:
rsetBeforeQuit - whether an attempt will be made send a POP3 RSET command when closingthe folder, before sending the QUIT command
Parameters:
messageClass - the class name of a subclass of com.sun.mail.pop3.POP3Message
Parameters:
localaddress - the local address (host name) to bind to when creating the POP3 socket
Parameters:
localport - the local port number to bind to when creating the POP3 socket
Parameters:
apopEnable - whether to use APOP instead of USER/PASS to login to the POP3 server,if the POP3 server supports APOP
Parameters:
socketFactoryClass - the class that will be used to create POP3 sockets
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created
Parameters:
socketFactoryPort - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| addOverrides | | public void addOverrides(Properties props)(Code) | | Add the overrides from the member variables to the properties file.
|
| doFail | | public void doFail()(Code) | | |
| getConnectionTimeout | | public Integer getConnectionTimeout()(Code) | | Returns the socket connection timeout value in milliseconds.
|
| getGBeanInfo | | public static GBeanInfo getGBeanInfo()(Code) | | |
| getLocaladdress | | public String getLocaladdress()(Code) | | Returns the local address (host name) to bind to when creating the POP3 socket.
|
| getLocalport | | public Integer getLocalport()(Code) | | Returns the local port number to bind to when creating the POP3 socket.
|
| getMessageClass | | public String getMessageClass()(Code) | | Returns the class name of a subclass of com.sun.mail.pop3.POP3Message.
Class name of a subclass of com.sun.mail.pop3.POP3Message. The subclass
can be used to handle (for example) non-standard Content-Type headers.
The subclass must have a public constructor of the form
MyPOP3Message(Folder f, int msgno) throws MessagingException.
|
| getPort | | public Integer getPort()(Code) | | Returns the POP3 server port to connect to, if the connect() method
doesn't explicitly specify one.
Defaults to 110.
|
| getRsetBeforeQuit | | public Boolean getRsetBeforeQuit()(Code) | | Returns whether an attempt will be made send a POP3 RSET command when
closing the folder, before sending the QUIT command.
Send a POP3 RSET command when closing the folder, before sending the
QUIT command. Useful with POP3 servers that implicitly mark all
messages that are read as "deleted"; this will prevent such messages
from being deleted and expunged unless the client requests so. Default
is false.
|
| getSocketFactoryClass | | public String getSocketFactoryClass()(Code) | | Returns the class that will be used to create POP3 sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create POP3
sockets.
|
| getSocketFactoryPort | | public Integer getSocketFactoryPort()(Code) | | Returns the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. If not set, the default port will be used.
|
| getTimeout | | public Integer getTimeout()(Code) | | Returns the socket I/O timeout value in milliseconds.
|
| isApopEnable | | public Boolean isApopEnable()(Code) | | Returns whether to use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP.
If set to true, use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP. APOP sends a digest of the
password rather than the clear text password. Defaults to false.
|
| isSocketFactoryFallback | | public Boolean isSocketFactoryFallback()(Code) | | Returns whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. Defaults to true.
|
| setApopEnable | | public void setApopEnable(Boolean apopEnable)(Code) | | Sets whether to use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP.
If set to true, use APOP instead of USER/PASS to login to the POP3
server, if the POP3 server supports APOP. APOP sends a digest of the
password rather than the clear text password. Defaults to false.
Parameters:
apopEnable - whether to use APOP instead of USER/PASS to login to the POP3server, if the POP3 server supports APOP |
| setConnectionTimeout | | public void setConnectionTimeout(Integer connectionTimeout)(Code) | | Sets the socket connection timeout value in milliseconds.
Default is infinite timeout.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
connectionTimeout - the socket connection timeout value in milliseconds. |
| setLocaladdress | | public void setLocaladdress(String localaddress)(Code) | | Sets the local address (host name) to bind to when creating the POP3 socket.
Local address (host name) to bind to when creating the POP3 socket.
Defaults to the address picked by the Socket class. Should not normally
need to be set, but useful with multi-homed hosts where it's important
to pick a particular local address to bind to.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
localaddress - the local address (host name) to bind to when creating the POP3 socket |
| setLocalport | | public void setLocalport(Integer localport)(Code) | | Sets the local port number to bind to when creating the POP3 socket.
Local port number to bind to when creating the POP3 socket. Defaults to
the port number picked by the Socket class.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
localport - the local port number to bind to when creating the POP3 socket |
| setMessageClass | | public void setMessageClass(String messageClass)(Code) | | Sets the class name of a subclass of com.sun.mail.pop3.POP3Message.
Class name of a subclass of com.sun.mail.pop3.POP3Message. The subclass
can be used to handle (for example) non-standard Content-Type headers.
The subclass must have a public constructor of the form
MyPOP3Message(Folder f, int msgno) throws MessagingException.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
messageClass - the class name of a subclass of com.sun.mail.pop3.POP3Message. |
| setPort | | public void setPort(Integer port)(Code) | | Sets the POP3 server port to connect to, if the connect() method
doesn't explicitly specify one.
Defaults to 110.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
port - the POP3 server port to connect to, if the connect() methoddoesn't explicitly specify one |
| setRsetBeforeQuit | | public void setRsetBeforeQuit(Boolean rsetBeforeQuit)(Code) | | Sets whether an attempt will be made send a POP3 RSET command when
closing the folder, before sending the QUIT command.
Send a POP3 RSET command when closing the folder, before sending the
QUIT command. Useful with POP3 servers that implicitly mark all messages
that are read as "deleted"; this will prevent such messages from being
deleted and expunged unless the client requests so. Default is false.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
rsetBeforeQuit - whether an attempt will be made send a POP3 RSET command whenclosing the folder, before sending the QUIT command |
| setSocketFactoryClass | | public void setSocketFactoryClass(String socketFactoryClass)(Code) | | Sets the class that will be used to create POP3 sockets.
If set, specifies the name of a class that implements the
javax.net.SocketFactory interface. This class will be used to create POP3
sockets.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryClass - the class that will be used to create POP3 sockets |
| setSocketFactoryFallback | | public void setSocketFactoryFallback(Boolean socketFactoryFallback)(Code) | | Sets whether java.net.Socket class will be created if the specified
socket factory class cannot be created.
If set to true, failure to create a socket using the specified socket
factory class will cause the socket to be created using the
java.net.Socket class. Defaults to true.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryFallback - whether java.net.Socket class will be created if the specifiedsocket factory class cannot be created |
| setSocketFactoryPort | | public void setSocketFactoryPort(Integer socketFactoryPort)(Code) | | Sets the port to connect to when using the specified socket factory.
Specifies the port to connect to when using the specified socket
factory. If not set, the default port will be used.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
socketFactoryPort - the port to connect to when using the specified socket factory |
| setTimeout | | public void setTimeout(Integer timeout)(Code) | | Sets the socket I/O timeout value in milliseconds.
Default is infinite timeout.
Values that are set here will override any of the corresponding value
that has been set in the properties.
Parameters:
timeout - the socket I/O timeout value in milliseconds |
|
|