org.craftercms.cstudio.publishing.processor

Class EmailProcessor

java.lang.Object

org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

org.craftercms.cstudio.publishing.processor.EmailProcessor

All Implemented Interfaces:

PublishingProcessor, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class EmailProcessor
extends AbstractPublishingProcessor

A post processor that sends email with the content published

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHAR_ENCODING

Fields inherited from class org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

name, order

Fields inherited from interface org.craftercms.cstudio.publishing.processor.PublishingProcessor

SITE_NAME_PREVIEW

Constructor Summary

Constructors

Constructor and Description
EmailProcessor()

Method Summary

Modifier and Type	Method and Description
protected javax.mail.Authenticator	createAuthenticator(Properties props, String username, String password) Create mail server authenticator
protected javax.mail.Address	createEmailAddress(String emailStr) create an email address from the string given
protected Properties	createMailProperties() Create mail properties
protected String	createPreviewUrl(String path, String siteName) create a preview url
protected javax.mail.Session	createSession() create email session
void	doProcess(PublishedChangeSet changeSet, Map<String,String> parameters, org.craftercms.core.service.Context context, PublishingTarget target) process files published
protected String	embedImages(String root, javax.mail.Multipart multipart, String content) embed images
String	getCharEncoding() get charEncoding
String	getComponentController() get componentController
Map<String,String>	getContentReplacements() get contentReplacements
String	getDefaultMailFrom() get defaultMailFrom
protected List<javax.mail.Address>	getEmailList(org.dom4j.Element parentEl, String path) get a list of email addresses from content
Map<String,String>	getHeaders() get headers
String	getHost() get host
protected String	getHtmlContent(String path, String siteName) get html content from preview site
String	getImagePattern() get imagePattern
String	getMailBccPath() get mailBccPath
String	getMailCcPath() get mailCcPath
String	getMailFromPath() get mailFromPath
String	getMailToPath() get mailToPath
List<String>	getMatchPatterns() get matchPatterns
List<String>	getNegativeChecks() get negativeChecks
String	getPassword() get password
String	getPort() get port
List<String>	getPositiveChecks() get positiveChecks
String	getPreviewUrl() get previewUrl
String	getProtocol() get protocol
String	getReplyToPath() get replyToPath
String	getSendEmailFlagPath() get sendEmailFlagPath
String	getSiteName() get siteName
String	getTextContentPath() get textContentPath
String	getTitlePath() get titlePath
Map<String,String>	getUrlReplacements() get urlReplacements
String	getUsername() get username
boolean	isAuthenticated() get authenticated
protected boolean	isMatchingPattern(String file) check if the file path is matching one of patterns
protected void	processFile(String site, String root, String file) process each file updated or created
protected void	processFiles(String site, String root, List<String> files) process files
protected void	sendEmail(String root, javax.mail.Address mailFrom, List<javax.mail.Address> replyToList, List<javax.mail.Address> mailToList, List<javax.mail.Address> mailCcList, List<javax.mail.Address> mailBccList, String title, String htmlContent, String textContent) send an email with the properties given
void	setAuthenticated(boolean authenticated) set if authentication is needed
void	setComponentController(String componentController) set the component controller path
void	setContentReplacements(Map<String,String> contentReplacements) set contentReplacement mapping
void	setDefaultMailFrom(String defaultMailFrom) set a defaultMailFrom value
void	setHeaders(Map<String,String> headers) set request headers
void	setHost(String host) set a mail host
void	setImagePattern(String imagePattern) set image pattern
void	setMailBccPath(String mailBccPath) set a mailBccPath value
void	setMailCcPath(String mailCcPath) set a mailCcPath value
void	setMailFromPath(String mailFromPath) set a mailFromPath value
void	setMailToPath(String mailToPath) set a mailToPath value
void	setMatchPatterns(List<String> matchPatterns) set matchPatterns
void	setNegativeChecks(List<String> negativeChecks) set a list of negative check strings
void	setPassword(String password) set the mail server password
void	setPort(String port) set a mail server port
void	setPositiveChecks(List<String> positiveChecks) set a list of positive check string patterns
void	setPreviewUrl(String previewUrl) set previewUrl
void	setProtocol(String protocol) set a protocol
void	setReplyToPath(String replyToPath) set a replyToPath value
void	setSendEmailFlagPath(String sendEmailFlagPath) set sendEmailFlagPath
void	setSiteName(String siteName) set siteName
void	setTextContentPath(String textContentPath) set a textContentPath value
void	setTitlePath(String titlePath) set a titlePath value
void	setUrlReplacements(Map<String,String> urlReplacements) set urlReplacement mapping
void	setUsername(String username) set the mail server username
protected void	validateContent(String htmlContent) validate content

Methods inherited from class org.craftercms.cstudio.publishing.processor.AbstractPublishingProcessor

getName, getOrder, setBeanName, setOrder

Methods inherited from class java.lang.Object

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

Field Detail

CHAR_ENCODING

public static String CHAR_ENCODING

Constructor Detail

EmailProcessor

public EmailProcessor()

Method Detail

doProcess

public void doProcess(PublishedChangeSet changeSet,
                      Map<String,String> parameters,
                      org.craftercms.core.service.Context context,
                      PublishingTarget target)
               throws PublishingException

Description copied from interface: PublishingProcessor

process files published

Throws:

PublishingException

processFiles

protected void processFiles(String site,
                            String root,
                            List<String> files)

process files

Parameters:

site -

root -

files -

processFile

protected void processFile(String site,
                           String root,
                           String file)
                    throws PublishingException

process each file updated or created

Parameters:

site - crafter site

root - root path

file - file path

Throws:

PublishingException

getEmailList

protected List<javax.mail.Address> getEmailList(org.dom4j.Element parentEl,
                                                String path)

get a list of email addresses from content

Parameters:

parentEl -

path -

createEmailAddress

protected javax.mail.Address createEmailAddress(String emailStr)

create an email address from the string given

Parameters:

emailStr - email address or name & email address format

Returns:

email address

sendEmail

protected void sendEmail(String root,
                         javax.mail.Address mailFrom,
                         List<javax.mail.Address> replyToList,
                         List<javax.mail.Address> mailToList,
                         List<javax.mail.Address> mailCcList,
                         List<javax.mail.Address> mailBccList,
                         String title,
                         String htmlContent,
                         String textContent)
                  throws PublishingException

send an email with the properties given

Parameters:

root - site root

mailFrom - from address

replyToList - reply to address

mailToList - to addresses

mailCcList - cc addresses

mailBccList - bcc addresses

title - mail title

htmlContent - HTML content

textContent - text content

Throws:

PublishingException

createSession

protected javax.mail.Session createSession()

create email session

Returns:

session

embedImages

protected String embedImages(String root,
                             javax.mail.Multipart multipart,
                             String content)
                      throws IOException,
                             javax.mail.MessagingException

embed images

Parameters:

root - site root

multipart - email content holder

content - email content

Returns:

email content with embedded images

Throws:

IOException

javax.mail.MessagingException

getHtmlContent

protected String getHtmlContent(String path,
                                String siteName)
                         throws IOException,
                                PublishingException

get html content from preview site

Parameters:

path - content path

siteName - crafter site name

Returns:

HTML page content

Throws:

IOException

PublishingException

createPreviewUrl

protected String createPreviewUrl(String path,
                                  String siteName)

create a preview url

Parameters:

path - content path

siteName - crafter site id

Returns:

the target preview url

validateContent

protected void validateContent(String htmlContent)
                        throws PublishingException

validate content

Parameters:

htmlContent -

Throws:

PublishingException

createAuthenticator

protected javax.mail.Authenticator createAuthenticator(Properties props,
                                                       String username,
                                                       String password)

Create mail server authenticator

Parameters:

props - Mail Properties

username -

password -

Returns:

authenticator

createMailProperties

protected Properties createMailProperties()

Create mail properties

Returns:

properties

isMatchingPattern

protected boolean isMatchingPattern(String file)

check if the file path is matching one of patterns

Parameters:

file -

Returns:

true if matching

getCharEncoding

public String getCharEncoding()

get charEncoding

Returns:

charEncoding

getPreviewUrl

public String getPreviewUrl()

get previewUrl

Returns:

previewUrl

setPreviewUrl

public void setPreviewUrl(String previewUrl)

set previewUrl

Parameters:

previewUrl -

getNegativeChecks

public List<String> getNegativeChecks()

get negativeChecks

Returns:

negativeChecks

setNegativeChecks

public void setNegativeChecks(List<String> negativeChecks)

set a list of negative check strings

Parameters:

negativeChecks -

getPositiveChecks

public List<String> getPositiveChecks()

get positiveChecks

Returns:

positiveChecks

setPositiveChecks

public void setPositiveChecks(List<String> positiveChecks)

set a list of positive check string patterns

Parameters:

positiveChecks -

getMailToPath

public String getMailToPath()

get mailToPath

Returns:

mailToPath

setMailToPath

public void setMailToPath(String mailToPath)

set a mailToPath value

Parameters:

mailToPath -

getMailCcPath

public String getMailCcPath()

get mailCcPath

Returns:

mailCcPath

setMailCcPath

public void setMailCcPath(String mailCcPath)

set a mailCcPath value

Parameters:

mailCcPath -

getMailBccPath

public String getMailBccPath()

get mailBccPath

Returns:

mailBccPath

setMailBccPath

public void setMailBccPath(String mailBccPath)

set a mailBccPath value

Parameters:

mailBccPath -

getMailFromPath

public String getMailFromPath()

get mailFromPath

Returns:

mailFromPath

setMailFromPath

public void setMailFromPath(String mailFromPath)

set a mailFromPath value

Parameters:

mailFromPath -

getReplyToPath

public String getReplyToPath()

get replyToPath

Returns:

replyToPath

setReplyToPath

public void setReplyToPath(String replyToPath)

set a replyToPath value

Parameters:

replyToPath -

getTitlePath

public String getTitlePath()

get titlePath

Returns:

titlePath

setTitlePath

public void setTitlePath(String titlePath)

set a titlePath value

Parameters:

titlePath -

getTextContentPath

public String getTextContentPath()

get textContentPath

Returns:

textContentPath

setTextContentPath

public void setTextContentPath(String textContentPath)

set a textContentPath value

Parameters:

textContentPath -

getDefaultMailFrom

public String getDefaultMailFrom()

get defaultMailFrom

Returns:

defaultMailFrom

setDefaultMailFrom

public void setDefaultMailFrom(String defaultMailFrom)

set a defaultMailFrom value

Parameters:

defaultMailFrom -

getHeaders

public Map<String,String> getHeaders()

get headers

Returns:

headers

setHeaders

public void setHeaders(Map<String,String> headers)

set request headers

Parameters:

headers -

getImagePattern

public String getImagePattern()

get imagePattern

Returns:

imagePattern

setImagePattern

public void setImagePattern(String imagePattern)

set image pattern

Parameters:

imagePattern -

getComponentController

public String getComponentController()

get componentController

Returns:

componentController

setComponentController

public void setComponentController(String componentController)

set the component controller path

Parameters:

componentController -

getUrlReplacements

public Map<String,String> getUrlReplacements()

get urlReplacements

Returns:

urlReplacements

setUrlReplacements

public void setUrlReplacements(Map<String,String> urlReplacements)

set urlReplacement mapping

Parameters:

urlReplacements -

getContentReplacements

public Map<String,String> getContentReplacements()

get contentReplacements

Returns:

contentReplacements

setContentReplacements

public void setContentReplacements(Map<String,String> contentReplacements)

set contentReplacement mapping

Parameters:

contentReplacements -

getMatchPatterns

public List<String> getMatchPatterns()

get matchPatterns

Returns:

matchPatterns

setMatchPatterns

public void setMatchPatterns(List<String> matchPatterns)

set matchPatterns

Parameters:

matchPatterns -

getSiteName

public String getSiteName()

get siteName

Returns:

siteName

setSiteName

public void setSiteName(String siteName)

set siteName

Parameters:

siteName - site name

getHost

public String getHost()

get host

Returns:

host

setHost

public void setHost(String host)

set a mail host

Parameters:

host - a mail host

getPort

public String getPort()

get port

Returns:

port

setPort

public void setPort(String port)

set a mail server port

Parameters:

port - a mail server port

getUsername

public String getUsername()

get username

Returns:

username

setUsername

public void setUsername(String username)

set the mail server username

Parameters:

username -

getPassword

public String getPassword()

get password

Returns:

password

setPassword

public void setPassword(String password)

set the mail server password

Parameters:

password -

isAuthenticated

public boolean isAuthenticated()

get authenticated

Returns:

authenticated

setAuthenticated

public void setAuthenticated(boolean authenticated)

set if authentication is needed

Parameters:

authenticated -

getProtocol

public String getProtocol()

get protocol

Returns:

protocol

setProtocol

public void setProtocol(String protocol)

set a protocol

Parameters:

protocol -

getSendEmailFlagPath

public String getSendEmailFlagPath()

get sendEmailFlagPath

Returns:

sendEmailFlagPath

setSendEmailFlagPath

public void setSendEmailFlagPath(String sendEmailFlagPath)

set sendEmailFlagPath

Parameters:

sendEmailFlagPath -