org.apache.geronimo.mail.POP3StoreGBean Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.geronimo.mail;
import java.util.Properties;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
/**
* 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 10:42:02 -0500 (Tue, 12 Dec 2006) $
* @see MailGBean
*/
public class POP3StoreGBean extends ProtocolGBean {
// the POP3 configuration property names
static public final String POP3_PORT = "mail.pop3.port";
static public final String POP3_CONNECTION_TIMEOUT = "mail.pop3.connectiontimeout";
static public final String POP3_TIMEOUT = "mail.pop3.timeout";
static public final String POP3_FACTORY_CLASS = "mail.pop3.socketFactory.class";
static public final String POP3_FACTORY_FALLBACK = "mail.pop3.socketFactory.fallback";
static public final String POP3_FACTORY_PORT = "mail.pop3.socketFactory.port";
static public final String POP3_LOCALHOST = "mail.pop3.localhost";
static public final String POP3_LOCALADDRESS = "mail.pop3.localaddress";
static public final String POP3_LOCALPORT = "mail.pop3.localport";
static public final String POP3_RESET = "mail.pop3.resetbeforequit";
static public final String POP3_MESSAGE_CLASS = "mail.pop3.message.class";
static public final String POP3_APOP = "mail.pop3.apop.enable";
static public final String GBEAN_RESET = "rsetBeforeQuit";
static public final String GBEAN_APOP = "apopEnable";
static public final String GBEAN_MESSAGE_CLASS = "messageClass";
private final Log log = LogFactory.getLog(POP3StoreGBean.class);
private Integer port;
private Integer connectionTimeout;
private Integer timeout;
private Boolean rsetBeforeQuit;
private String messageClass;
private String localaddress;
private Integer localport;
private Boolean apopEnable;
private String socketFactoryClass;
private Boolean socketFactoryFallback;
private 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.
*
* @param objectName the object name of the protocol
* @param properties the set of default properties for the protocol
* @param host the host the protocol connects to
* @param user the default name for the protocol
* @param port the POP3 server port
* @param connectionTimeout the socket connection timeout value in milliseconds
* @param timeout the socket I/O timeout value in milliseconds
* @param rsetBeforeQuit whether an attempt will be made send a POP3 RSET command when closing
* the folder, before sending the QUIT command
* @param messageClass the class name of a subclass of com.sun.mail.pop3.POP3Message
* @param localaddress the local address (host name) to bind to when creating the POP3 socket
* @param localport the local port number to bind to when creating the POP3 socket
* @param apopEnable whether to use APOP instead of USER/PASS to login to the POP3 server,
* if the POP3 server supports APOP
* @param socketFactoryClass the class that will be used to create POP3 sockets
* @param socketFactoryFallback whether java.net.Socket class will be created if the specified
* socket factory class cannot be created
* @param socketFactoryPort whether java.net.Socket class will be created if the specified
* socket factory class cannot be created
*/
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) {
super(objectName, "pop3", properties, host, user);
setPort(port);
setConnectionTimeout(connectionTimeout);
setTimeout(timeout);
setRsetBeforeQuit(rsetBeforeQuit);
setMessageClass(messageClass);
setLocaladdress(localaddress);
setLocalport(localport);
setApopEnable(apopEnable);
setSocketFactoryClass(socketFactoryClass);
setSocketFactoryFallback(socketFactoryFallback);
setSocketFactoryPort(socketFactoryPort);
}
/**
* Returns the POP3 server port to connect to, if the connect() method
* doesn't explicitly specify one.
*
* Defaults to 110.
*/
public Integer getPort() {
return port;
}
/**
* 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.
*
* @param port the POP3 server port to connect to, if the connect() method
* doesn't explicitly specify one
*/
public void setPort(Integer port) {
this.port = port;
}
/**
* Returns the socket connection timeout value in milliseconds.
*/
public Integer getConnectionTimeout() {
return connectionTimeout;
}
/**
* 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.
*
* @param connectionTimeout the socket connection timeout value in milliseconds.
*/
public void setConnectionTimeout(Integer connectionTimeout) {
this.connectionTimeout = connectionTimeout;
}
/**
* Returns the socket I/O timeout value in milliseconds.
*/
public Integer getTimeout() {
return timeout;
}
/**
* 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.
*
* @param timeout the socket I/O timeout value in milliseconds
*/
public void setTimeout(Integer timeout) {
this.timeout = timeout;
}
/**
* 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.
*/
public Boolean getRsetBeforeQuit() {
return 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. 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.
*
* @param rsetBeforeQuit whether an attempt will be made send a POP3 RSET command when
* closing the folder, before sending the QUIT command
*/
public void setRsetBeforeQuit(Boolean rsetBeforeQuit) {
this.rsetBeforeQuit = rsetBeforeQuit;
}
/**
* 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.
*/
public String getMessageClass() {
return 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. 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.
*
* @param messageClass the class name of a subclass of com.sun.mail.pop3.POP3Message.
*/
public void setMessageClass(String messageClass) {
this.messageClass = messageClass;
}
/**
* Returns the local address (host name) to bind to when creating the POP3 socket.
*/
public String getLocaladdress() {
return 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. 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.
*
* @param localaddress the local address (host name) to bind to when creating the POP3 socket
*/
public void setLocaladdress(String localaddress) {
this.localaddress = localaddress;
}
/**
* Returns the local port number to bind to when creating the POP3 socket.
*/
public Integer getLocalport() {
return 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. 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.
*
* @param localport the local port number to bind to when creating the POP3 socket
*/
public void setLocalport(Integer localport) {
this.localport = localport;
}
/**
* 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.
*/
public Boolean isApopEnable() {
return 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. APOP sends a digest of the
* password rather than the clear text password. Defaults to false.
*
* @param apopEnable whether to use APOP instead of USER/PASS to login to the POP3
* server, if the POP3 server supports APOP
*/
public void setApopEnable(Boolean apopEnable) {
this.apopEnable = apopEnable;
}
/**
* 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.
*/
public String getSocketFactoryClass() {
return 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. 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.
*
* @param socketFactoryClass the class that will be used to create POP3 sockets
*/
public void setSocketFactoryClass(String socketFactoryClass) {
this.socketFactoryClass = socketFactoryClass;
}
/**
* 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.
*/
public Boolean isSocketFactoryFallback() {
return 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. Defaults to true.
*
* Values that are set here will override any of the corresponding value
* that has been set in the properties.
*
* @param socketFactoryFallback whether java.net.Socket class will be created if the specified
* socket factory class cannot be created
*/
public void setSocketFactoryFallback(Boolean socketFactoryFallback) {
this.socketFactoryFallback = socketFactoryFallback;
}
/**
* 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.
*/
public Integer getSocketFactoryPort() {
return 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. 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.
*
* @param socketFactoryPort the port to connect to when using the specified socket factory
*/
public void setSocketFactoryPort(Integer socketFactoryPort) {
this.socketFactoryPort = socketFactoryPort;
}
/**
* Add the overrides from the member variables to the properties file.
*/
public void addOverrides(Properties props) {
super.addOverrides(props);
if (port != null) props.setProperty(POP3_PORT, port.toString());
if (connectionTimeout != null) props.setProperty(POP3_CONNECTION_TIMEOUT, connectionTimeout.toString());
if (timeout != null) props.setProperty(POP3_TIMEOUT, timeout.toString());
if (rsetBeforeQuit != null) props.setProperty(POP3_RESET, rsetBeforeQuit.toString());
if (messageClass != null) props.setProperty(POP3_MESSAGE_CLASS, messageClass);
if (localaddress != null) props.setProperty(POP3_LOCALADDRESS, localaddress);
if (localport != null) props.setProperty(POP3_LOCALPORT, localport.toString());
if (apopEnable != null) props.setProperty(POP3_APOP, apopEnable.toString());
if (socketFactoryClass != null) props.setProperty(POP3_FACTORY_CLASS, socketFactoryClass);
if (socketFactoryFallback != null) props.setProperty(POP3_FACTORY_FALLBACK, socketFactoryFallback.toString());
if (socketFactoryPort != null) props.setProperty(POP3_FACTORY_PORT, socketFactoryPort.toString());
}
public void doStart() throws Exception {
log.debug("Started " + getObjectName());
}
public void doStop() throws Exception {
log.debug("Stopped " + getObjectName());
}
public void doFail() {
log.warn("Failed " + getObjectName());
}
public static final GBeanInfo GBEAN_INFO;
static {
GBeanInfoBuilder infoFactory = GBeanInfoBuilder.createStatic(POP3StoreGBean.class, ProtocolGBean.GBEAN_INFO);
infoFactory.addAttribute(GBEAN_PORT, Integer.class, true);
infoFactory.addAttribute(GBEAN_CONNECTION_TIMEOUT, Integer.class, true);
infoFactory.addAttribute(GBEAN_TIMEOUT, Integer.class, true);
infoFactory.addAttribute(GBEAN_RESET, Boolean.class, true);
infoFactory.addAttribute(GBEAN_MESSAGE_CLASS, String.class, true);
infoFactory.addAttribute(GBEAN_LOCALADDRESS, String.class, true);
infoFactory.addAttribute(GBEAN_LOCALPORT, Integer.class, true);
infoFactory.addAttribute(GBEAN_APOP, Boolean.class, true);
infoFactory.addAttribute(GBEAN_FACTORY_CLASS, String.class, true);
infoFactory.addAttribute(GBEAN_FACTORY_FALLBACK, Boolean.class, true);
infoFactory.addAttribute(GBEAN_FACTORY_PORT, Integer.class, true);
infoFactory.addAttribute(GBEAN_OBJECTNAME, String.class, false);
infoFactory.addAttribute(GBEAN_PROTOCOL, String.class, true);
infoFactory.addAttribute(GBEAN_PROPERTIES, Properties.class, true);
infoFactory.addAttribute(GBEAN_HOST, String.class, true);
infoFactory.addAttribute(GBEAN_USER, String.class, true);
infoFactory.addOperation(GBEAN_ADD_OVERRIDES, new Class[]{Properties.class});
infoFactory.setConstructor(new String[]{GBEAN_OBJECTNAME, GBEAN_PROPERTIES, GBEAN_HOST, GBEAN_USER,
GBEAN_PORT,
GBEAN_CONNECTION_TIMEOUT,
GBEAN_TIMEOUT,
GBEAN_RESET,
GBEAN_MESSAGE_CLASS,
GBEAN_LOCALADDRESS,
GBEAN_LOCALPORT,
GBEAN_APOP,
GBEAN_FACTORY_CLASS,
GBEAN_FACTORY_FALLBACK,
GBEAN_FACTORY_PORT});
GBEAN_INFO = infoFactory.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy