org.jahia.services.workflow.jbpm.custom.email

Class JBPMMailProducer

java.lang.Object

org.jahia.services.workflow.jbpm.custom.email.JBPMMailProducer

public class JBPMMailProducer
extends Object

A work item handler to send email. This implementation extends the built-in JBPM 6 implementation by re-introducing the mail template mechanism available in JBPM 4

Since:

JAHIA 6.5

Author:

rincevent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JBPMMailProducer.MyBindings

Field Summary

Fields

Modifier and Type	Field and Description
protected Bindings	bindings
protected JahiaGroupManagerService	groupManagerService
protected MailTemplateRegistry	mailTemplateRegistry
protected ScriptEngine	scriptEngine
protected org.kie.internal.task.api.TaskIdentityService	taskIdentityService
protected JahiaUserManagerService	userManagerService
protected WorkflowService	workflowService

Constructor Summary

Constructors

Constructor and Description
JBPMMailProducer()

Method Summary

Modifier and Type	Method and Description
protected void	addAttachments(MailTemplate template, org.kie.api.runtime.process.WorkItem workItem, javax.mail.Multipart multipart, JCRSessionWrapper session)
protected void	addStaticClasses(Bindings bindings)
protected DataHandler	createDataHandler(AttachmentTemplate attachmentTemplate, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected String	evaluateExpression(org.kie.api.runtime.process.WorkItem workItem, String scriptToExecute, JCRSessionWrapper session)
protected static String	extractResourceName(URL url)
protected void	fillContent(MailTemplate template, javax.mail.Message email, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected void	fillFrom(MailTemplate template, javax.mail.Message email, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session) Fills the from attribute of the given email.
protected void	fillRecipients(AddressTemplate addressTemplate, javax.mail.Message email, javax.mail.Message.RecipientType recipientType, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected void	fillRecipients(MailTemplate template, javax.mail.Message email, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected void	fillSubject(MailTemplate template, javax.mail.Message email, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected javax.mail.Address	getAddress(String firstName, String lastName, String email)
protected javax.mail.Address	getAddress(org.kie.api.task.model.User user)
protected javax.mail.Address[]	getAddresses(org.kie.api.task.model.Group group)
protected javax.mail.Address[]	getAddresses(List<org.kie.api.task.model.User> users) construct recipient addresses from user entities
protected Bindings	getBindings(org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)
protected javax.mail.Message	instantiateEmail()
Collection<javax.mail.Message>	produce(org.kie.api.runtime.process.WorkItem workItem)
void	setGroupManagerService(JahiaGroupManagerService groupManagerService)
void	setMailTemplateRegistry(MailTemplateRegistry mailTemplateRegistry)
void	setTaskIdentityService(org.kie.internal.task.api.TaskIdentityService taskIdentityService)
void	setUserManagerService(JahiaUserManagerService userManagerService)
void	setWorkflowService(WorkflowService workflowService)
protected String[]	tokenizeActors(String recipients, org.kie.api.runtime.process.WorkItem workItem, JCRSessionWrapper session)

Methods inherited from class java.lang.Object

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

Field Detail

scriptEngine

protected ScriptEngine scriptEngine

bindings

protected Bindings bindings

workflowService

protected WorkflowService workflowService

mailTemplateRegistry

protected MailTemplateRegistry mailTemplateRegistry

taskIdentityService

protected org.kie.internal.task.api.TaskIdentityService taskIdentityService

userManagerService

protected JahiaUserManagerService userManagerService

groupManagerService

protected JahiaGroupManagerService groupManagerService

Constructor Detail

JBPMMailProducer

public JBPMMailProducer()

Method Detail

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

setMailTemplateRegistry

public void setMailTemplateRegistry(MailTemplateRegistry mailTemplateRegistry)

setTaskIdentityService

public void setTaskIdentityService(org.kie.internal.task.api.TaskIdentityService taskIdentityService)

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userManagerService)

setGroupManagerService

public void setGroupManagerService(JahiaGroupManagerService groupManagerService)

produce

public Collection<javax.mail.Message> produce(org.kie.api.runtime.process.WorkItem workItem)

instantiateEmail

protected javax.mail.Message instantiateEmail()

fillFrom

protected void fillFrom(MailTemplate template,
                        javax.mail.Message email,
                        org.kie.api.runtime.process.WorkItem workItem,
                        JCRSessionWrapper session)
                 throws Exception

Fills the from attribute of the given email. The sender addresses are an optional element in the mail template. If absent, each mail server supplies the current user's email address.

Throws:

Exception

See Also:

InternetAddress#getLocalAddress(Session)}

fillRecipients

protected void fillRecipients(MailTemplate template,
                              javax.mail.Message email,
                              org.kie.api.runtime.process.WorkItem workItem,
                              JCRSessionWrapper session)
                       throws Exception

Throws:

Exception

fillRecipients

protected void fillRecipients(AddressTemplate addressTemplate,
                              javax.mail.Message email,
                              javax.mail.Message.RecipientType recipientType,
                              org.kie.api.runtime.process.WorkItem workItem,
                              JCRSessionWrapper session)
                       throws Exception

Throws:

Exception

tokenizeActors

protected String[] tokenizeActors(String recipients,
                                  org.kie.api.runtime.process.WorkItem workItem,
                                  JCRSessionWrapper session)
                           throws Exception

Throws:

Exception

getAddresses

protected javax.mail.Address[] getAddresses(List<org.kie.api.task.model.User> users)

construct recipient addresses from user entities

getAddresses

protected javax.mail.Address[] getAddresses(org.kie.api.task.model.Group group)

getAddress

protected javax.mail.Address getAddress(org.kie.api.task.model.User user)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getAddress

protected javax.mail.Address getAddress(String firstName,
                                        String lastName,
                                        String email)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

fillSubject

protected void fillSubject(MailTemplate template,
                           javax.mail.Message email,
                           org.kie.api.runtime.process.WorkItem workItem,
                           JCRSessionWrapper session)
                    throws Exception

Throws:

Exception

fillContent

protected void fillContent(MailTemplate template,
                           javax.mail.Message email,
                           org.kie.api.runtime.process.WorkItem workItem,
                           JCRSessionWrapper session)
                    throws Exception

Throws:

Exception

evaluateExpression

protected String evaluateExpression(org.kie.api.runtime.process.WorkItem workItem,
                                    String scriptToExecute,
                                    JCRSessionWrapper session)
                             throws javax.jcr.RepositoryException,
                                    ScriptException

Throws:

javax.jcr.RepositoryException

ScriptException

addStaticClasses

protected void addStaticClasses(Bindings bindings)

getBindings

protected Bindings getBindings(org.kie.api.runtime.process.WorkItem workItem,
                               JCRSessionWrapper session)
                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addAttachments

protected void addAttachments(MailTemplate template,
                              org.kie.api.runtime.process.WorkItem workItem,
                              javax.mail.Multipart multipart,
                              JCRSessionWrapper session)
                       throws Exception

Throws:

Exception

createDataHandler

protected DataHandler createDataHandler(AttachmentTemplate attachmentTemplate,
                                        org.kie.api.runtime.process.WorkItem workItem,
                                        JCRSessionWrapper session)
                                 throws Exception

Throws:

Exception

extractResourceName

protected static String extractResourceName(URL url)