All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nervousync.commons.beans.mail.MailServerConfig Maven / Gradle / Ivy

There is a newer version: 1.0.1
Show newest version
/*
 * Licensed to the Nervousync Studio (NSYC) 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 com.nervousync.commons.beans.mail;

import java.io.Serializable;
import java.util.Properties;

import com.nervousync.commons.beans.mail.protocol.BaseProtocol;
import com.nervousync.commons.beans.mail.protocol.impl.IMAPProtocol;
import com.nervousync.commons.beans.mail.protocol.impl.POP3Protocol;
import com.nervousync.commons.beans.mail.protocol.impl.SMTPProtocol;
import com.nervousync.commons.core.Globals;
import com.nervousync.enumerations.mail.ProtocolOption;

/**
 * Mail server configuration
 * @author Steven Wee	[email protected]
 * @version $Revision: 1.0 $ $Date: Sep 18, 2012 9:54:37 PM $
 */
public final class MailServerConfig implements Serializable {

	/**
	 * 
	 */
	private static final long serialVersionUID = -2026891055081503726L;
	
	/**
	 * Send server configuration, using SMTP
	 */
	private ServerConfig sendServerConfig;
	/**
	 * Receive server configuration, supported POP3 and IMAP
	 */
	private ServerConfig recvServerConfig;
	
	/**
	 * Initialize MailServerConfig
	 * @param recvProtocolName		Receive protocol name, "IMAP" or "POP3"
	 * @param recvHostName			Receive server domain name or address
	 * @param recvHostPort			Receive server port
	 * @param recvSsl				Using SSL to connect receive server
	 * @param recvAuthLogin			Receive server authentication login status
	 * @param sendProtocolName		Send protocol name, "SMTP" only at this time
	 * @param sendHostName			Send server domain name or address
	 * @param sendHostPort			Send server port
	 * @param sendSsl				Using SSL to connect send server
	 * @param sendAuthLogin			Send server authentication login status
	 * @throws Exception
	 */
	public MailServerConfig(String recvProtocolName, String recvHostName, int recvHostPort, boolean recvSsl, boolean recvAuthLogin, 
			String sendProtocolName, String sendHostName, int sendHostPort, boolean sendSsl, boolean sendAuthLogin) throws Exception {
		if (recvProtocolName == null || recvHostName == null || sendProtocolName == null || sendHostName == null) {
			throw new Exception("Mail Server Info Error");
		}
		
		BaseProtocol recvProtocol;
		if (recvProtocolName.equalsIgnoreCase("IMAP")) {
			recvProtocol = new IMAPProtocol();
		} else if (recvProtocolName.equalsIgnoreCase("POP3")) {
			recvProtocol = new POP3Protocol();
		} else {
			throw new Exception("Receive Mail Protocol Unknown");
		}
		
		this.recvServerConfig = new ServerConfig(recvProtocol, recvHostName, recvHostPort, recvSsl, recvAuthLogin);
		this.sendServerConfig = new ServerConfig(new SMTPProtocol(), sendHostName, sendHostPort, sendSsl, sendAuthLogin);
	}
	
	/**
	 * Read send config info
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getSendConfigInfo() {
		return this.sendServerConfig.getConfigInfo();
	}

	/**
	 * Read send config info by given user name
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getSendConfigInfo(String userName) {
		return this.sendServerConfig.getConfigInfo(userName);
	}

	/**
	 * Read send config info by given user name and timeout settings
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getSendConfigInfo(String userName, int connectionTimeout, int timeout) {
		return this.sendServerConfig.getConfigInfo(userName, connectionTimeout, timeout);
	}

	/**
	 * Read receive config info
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getRecvConfigInfo() {
		return this.recvServerConfig.getConfigInfo();
	}

	/**
	 * Read send receive info by given user name
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getRecvConfigInfo(String userName) {
		return this.recvServerConfig.getConfigInfo(userName);
	}

	/**
	 * Read send receive info by given user name and timeout settings
	 * @return	java.util.Properties for JavaMail using
	 */
	public Properties getRecvConfigInfo(String userName, int connectionTimeout, int timeout) {
		return this.recvServerConfig.getConfigInfo(userName, connectionTimeout, timeout);
	}
	
	/**
	 * @return the sendServerConfig
	 */
	public ServerConfig getSendServerConfig() {
		return sendServerConfig;
	}

	/**
	 * @param sendServerConfig the sendServerConfig to set
	 */
	public void setSendServerConfig(ServerConfig sendServerConfig) {
		this.sendServerConfig = sendServerConfig;
	}

	/**
	 * @return the recvServerConfig
	 */
	public ServerConfig getRecvServerConfig() {
		return recvServerConfig;
	}

	/**
	 * @param recvServerConfig the recvServerConfig to set
	 */
	public void setRecvServerConfig(ServerConfig recvServerConfig) {
		this.recvServerConfig = recvServerConfig;
	}

	/**
	 * @return the serialversionuid
	 */
	public static long getSerialversionuid() {
		return serialVersionUID;
	}

	public final static class ServerConfig implements Serializable {
		
		/**
		 * 
		 */
		private static final long serialVersionUID = 4918987878564423832L;
		
		private BaseProtocol protocol;
		private String hostName;
		private int hostPort = Globals.DEFAULT_VALUE_INT;
		private boolean ssl = false;
		private boolean authLogin = false;
		private ProtocolOption protocolOption;
		
		public ServerConfig(BaseProtocol protocol, String hostName, int hostPort, boolean ssl, boolean authLogin) {
			this.protocol = protocol;
			this.hostName = hostName;
			this.hostPort = hostPort;
			this.ssl = ssl;
			this.authLogin = authLogin;
			
			if (protocol instanceof SMTPProtocol) {
				protocolOption = ProtocolOption.SMTP;
			} else if (protocol instanceof POP3Protocol) {
				protocolOption = ProtocolOption.POP3;
			} else if (protocol instanceof IMAPProtocol) {
				protocolOption = ProtocolOption.IMAP;
			} else {
				protocolOption = ProtocolOption.UNKNOWN;
			}
		}
		
		public Properties getConfigInfo() {
			return this.protocol.getConfigInfo(this.hostName, this.hostPort, this.ssl, this.authLogin);
		}
		
		public Properties getConfigInfo(String userName) {
			return this.protocol.getConfigInfo(this.hostName, this.hostPort, userName, this.ssl, this.authLogin);
		}
		
		public Properties getConfigInfo(String userName, int connectionTimeout, int timeout) {
			return this.protocol.getConfigInfo(this.hostName, this.hostPort, userName, 
					connectionTimeout, timeout, this.ssl, this.authLogin);
		}
		
		/**
		 * @return the protocol
		 */
		public BaseProtocol getProtocol() {
			return protocol;
		}

		/**
		 * @param protocol the protocol to set
		 */
		public void setProtocol(BaseProtocol protocol) {
			this.protocol = protocol;
		}

		/**
		 * @return the hostName
		 */
		public String getHostName() {
			return hostName;
		}

		/**
		 * @param hostName the hostName to set
		 */
		public void setHostName(String hostName) {
			this.hostName = hostName;
		}

		/**
		 * @return the hostPort
		 */
		public int getHostPort() {
			return hostPort;
		}

		/**
		 * @param hostPort the hostPort to set
		 */
		public void setHostPort(int hostPort) {
			this.hostPort = hostPort;
		}

		/**
		 * @return the ssl
		 */
		public boolean isSsl() {
			return ssl;
		}

		/**
		 * @param ssl the ssl to set
		 */
		public void setSsl(boolean ssl) {
			this.ssl = ssl;
		}

		/**
		 * @return the authLogin
		 */
		public boolean isAuthLogin() {
			return authLogin;
		}

		/**
		 * @param authLogin the authLogin to set
		 */
		public void setAuthLogin(boolean authLogin) {
			this.authLogin = authLogin;
		}

		/**
		 * @return the protocolOption
		 */
		public ProtocolOption getProtocolOption() {
			return protocolOption;
		}

		/**
		 * @param protocolOption the protocolOption to set
		 */
		public void setProtocolOption(ProtocolOption protocolOption) {
			this.protocolOption = protocolOption;
		}

		/**
		 * @return the serialversionuid
		 */
		public static long getSerialversionuid() {
			return serialVersionUID;
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy