com.wu.common.email.parse

Class AbstractConfigParser

java.lang.Object

com.wu.common.email.parse.AbstractConfigParser

All Implemented Interfaces:

EmailConfigParser

Direct Known Subclasses:

ConfigCenterParser, YamlConfigParser

public abstract class AbstractConfigParser
extends Object
implements EmailConfigParser

配置信息解析器抽象基类，负责对所有的解析器进行抽象。目前使用的邮件发送是apache-common，而且发送邮件都是需要生成Email的实例， 在现实环境中有三种类型的邮件是很普遍的，例如：

• 发送带有附件的邮件使用的是MultiPartEmail
• 发送普通邮件使用的是SimpleEmail
• 发送html邮件是使用的是HtmlEmail

而解析器的功能就是根据配置文件来选择构建上面哪种实例。

Since:

1.0

Author:

wuxinbo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractConfigParser.EmailType 邮件类型
protected static class	AbstractConfigParser.Encrypt smtp 邮件服务器加密方式

Constructor Summary

Constructors

Constructor and Description
AbstractConfigParser()

Method Summary

Modifier and Type	Method and Description
protected void	addToAndCc(List<String> toList, List<String> ccList, org.apache.commons.mail.Email email) 追加收件人信息和邮件信息，如果之前配置文件里面有定义，在这里将会覆盖之前定义的。
protected org.apache.commons.mail.Email	afterParse(AbstractConfigParser.EmailType type, org.apache.commons.mail.Email email, EmailRecevier recevier) 在完成初步解析之后可以调用此方法来进行二次加工
protected abstract org.apache.commons.mail.Email	doParse(AbstractConfigParser.EmailType type) 真正解析的配置文件不由父类实现，由子类去实现不同的解析。
protected org.apache.commons.mail.HtmlEmail	doParseHtmlEmail(org.apache.commons.mail.HtmlEmail email) 解析带html邮件配置信息，不提供默认实现，由子类去实现
protected org.apache.commons.mail.HtmlEmail	doParseHtmlEmail(org.apache.commons.mail.HtmlEmail email, EmailRecevier recevier) 解析收件人信息，
protected org.apache.commons.mail.MultiPartEmail	doParseMutiPartEmail(org.apache.commons.mail.MultiPartEmail email) 解析带附件的邮件配置信息,该方法留给子类实现
protected org.apache.commons.mail.SimpleEmail	doParseSimpleEmail(org.apache.commons.mail.SimpleEmail email) 解析普通文本邮件的配置信息，如果有需要可以重写该方法，同样本类不提供实现，由子类去实现
org.apache.commons.mail.Email	parse() 初步实现解析配置文件，如果在解析配置信息时没有得到发送邮件类型，默认采用发送文本邮件方案。
org.apache.commons.mail.Email	parseAndattachRecevier(EmailRecevier receiver) 解析配置信息之后在解析收件人和抄送人信息
protected abstract AbstractConfigParser.EmailType	parseEmailType()
protected org.apache.commons.mail.Email	setEncrypt(String encrypt, org.apache.commons.mail.Email email) 解析YAML配置的加密方式，决定加密方式

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractConfigParser

public AbstractConfigParser()

Method Detail

setEncrypt

protected org.apache.commons.mail.Email setEncrypt(String encrypt,
                                                   org.apache.commons.mail.Email email)

解析YAML配置的加密方式，决定加密方式

Parameters:

encrypt - 加密方式

email - 邮件信息

Returns:

解析好的配置信息

addToAndCc

protected void addToAndCc(List<String> toList,
                          List<String> ccList,
                          org.apache.commons.mail.Email email)
                   throws org.apache.commons.mail.EmailException

追加收件人信息和邮件信息，如果之前配置文件里面有定义，在这里将会覆盖之前定义的。

Parameters:

toList - 收件人列表

ccList - 抄送列表

email - 邮件信息

Throws:

org.apache.commons.mail.EmailException - 如果收件人列表为空将会抛出异常

parse

public org.apache.commons.mail.Email parse()
                                    throws Exception

初步实现解析配置文件，如果在解析配置信息时没有得到发送邮件类型，默认采用发送文本邮件方案。

Specified by:

parse in interface EmailConfigParser

Returns:

解析好的配置文件

Throws:

Exception - 解析失败抛出异常

afterParse

protected org.apache.commons.mail.Email afterParse(AbstractConfigParser.EmailType type,
                                                   org.apache.commons.mail.Email email,
                                                   EmailRecevier recevier)
                                            throws Exception

在完成初步解析之后可以调用此方法来进行二次加工

Parameters:

type - 邮件类型

email - 在doParse(EmailType)方法得到的邮件配置

recevier - 收件信息

Returns:

解析完成后的对象

Throws:

Exception - 解析失败抛出异常

parseAndattachRecevier

public org.apache.commons.mail.Email parseAndattachRecevier(EmailRecevier receiver)
                                                     throws Exception

Description copied from interface: EmailConfigParser

解析配置信息之后在解析收件人和抄送人信息

Specified by:

parseAndattachRecevier in interface EmailConfigParser

Parameters:

receiver - 收件人或抄送人信息

Returns:

返回封装好的邮件配置信息

Throws:

Exception - 解析邮件失败抛出异常

parseEmailType

protected abstract AbstractConfigParser.EmailType parseEmailType()
                                                          throws Exception

Throws:

Exception

doParseMutiPartEmail

protected org.apache.commons.mail.MultiPartEmail doParseMutiPartEmail(org.apache.commons.mail.MultiPartEmail email)
                                                               throws Exception

解析带附件的邮件配置信息,该方法留给子类实现

Returns:

解析好的附件邮件

Throws:

Exception - 解析失败抛出异常

doParseHtmlEmail

protected org.apache.commons.mail.HtmlEmail doParseHtmlEmail(org.apache.commons.mail.HtmlEmail email)
                                                      throws Exception

解析带html邮件配置信息，不提供默认实现，由子类去实现

Parameters:

email - 初步解析的配置信息

Returns:

解析好的html配置信息

Throws:

Exception - 解析失败抛出错误

doParseHtmlEmail

protected org.apache.commons.mail.HtmlEmail doParseHtmlEmail(org.apache.commons.mail.HtmlEmail email,
                                                             EmailRecevier recevier)
                                                      throws Exception

解析收件人信息，

Parameters:

email -

recevier -

Returns:

Throws:

Exception

doParseSimpleEmail

protected org.apache.commons.mail.SimpleEmail doParseSimpleEmail(org.apache.commons.mail.SimpleEmail email)
                                                          throws Exception

解析普通文本邮件的配置信息，如果有需要可以重写该方法，同样本类不提供实现，由子类去实现

Parameters:

email - 初步解析的邮件配置信息

Returns:

解析并封装好的配置信息

Throws:

Exception - 解析失败抛出异常

doParse

protected abstract org.apache.commons.mail.Email doParse(AbstractConfigParser.EmailType type)
                                                  throws Exception

真正解析的配置文件不由父类实现，由子类去实现不同的解析。

Returns:

返回解析后的Email实例

Throws:

Exception - 解析失败抛出异常