com.tsgrp.opencontent.activiti.listener

Class SendEndWorkflowEmailsListener

java.lang.Object

com.tsgrp.opencontent.activiti.listener.OCSendEmailListenerBase

com.tsgrp.opencontent.activiti.listener.SendEndWorkflowEmailsListener

All Implemented Interfaces:

org.activiti.engine.delegate.JavaDelegate

public class SendEndWorkflowEmailsListener
extends OCSendEmailListenerBase
implements org.activiti.engine.delegate.JavaDelegate

Default listener for the 'end' event of an Activiti workflow. Attach this listener to the end event for an activiti process and the following emails will be sent to the workflow supervisor:

• When the workflow finishes normally. Note, the end task must be named 'End', the Activiti default. If you change the name of the end task, you must extend this class and override the #getEndActivityName method to provide the end task name.
• When the workflow is cancelled/aborted

See this page in the OC wiki for more information.

Constructor Summary

Constructors

Constructor and Description
SendEndWorkflowEmailsListener()

Method Summary

Modifier and Type	Method and Description
void	execute(org.activiti.engine.delegate.DelegateExecution execution)
protected java.lang.String	getEmailBodyTemplate(java.util.Map<java.lang.String,java.lang.Object> emailModel) Get the FTL template to use for the email body.
protected java.lang.String	getEmailSubjectTemplate(java.util.Map<java.lang.String,java.lang.Object> emailModel) Get the FTL template to use for the email subject.
protected java.lang.String	getEndActivityName() Gets the name of the 'end' activity in the process template.
protected void	sendWorkflowAbortedEmail(java.lang.String ticket, java.lang.String initiatorEmailAddr, org.activiti.engine.delegate.DelegateExecution execution, java.util.Map<java.lang.String,java.lang.Object> emailModel) Send the email in the case of the workflow being aborted
protected void	sendWorkflowCompletedEmail(java.lang.String ticket, java.lang.String initiatorEmailAddr, org.activiti.engine.delegate.DelegateExecution execution, java.util.Map<java.lang.String,java.lang.Object> emailModel) Send the email in the case of the workflow route completing successfully

Methods inherited from class com.tsgrp.opencontent.activiti.listener.OCSendEmailListenerBase

getEmailModel, getEmailModel, getProcessDefinitionName, getTaskURL, sendEmail, sendEmail

Methods inherited from class java.lang.Object

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

Constructor Detail

SendEndWorkflowEmailsListener

public SendEndWorkflowEmailsListener()

Method Detail

execute

public void execute(org.activiti.engine.delegate.DelegateExecution execution)
             throws java.lang.Exception

Specified by:

execute in interface org.activiti.engine.delegate.JavaDelegate

Throws:

java.lang.Exception

getEndActivityName

protected java.lang.String getEndActivityName()

Gets the name of the 'end' activity in the process template. By default, this method returns the string "End", which is the Activiti default. This method is provided in case a template has a custom end activity name. In this case, you must create a subclass of this listener and override this method to provide the new end activity name.

Returns:

the End activity name.

sendWorkflowCompletedEmail

protected void sendWorkflowCompletedEmail(java.lang.String ticket,
                                          java.lang.String initiatorEmailAddr,
                                          org.activiti.engine.delegate.DelegateExecution execution,
                                          java.util.Map<java.lang.String,java.lang.Object> emailModel)

Send the email in the case of the workflow route completing successfully

Parameters:

ticket - OC ticket

initiatorEmailAddr - the email address

execution - the workflow execution

emailModel - the email model

sendWorkflowAbortedEmail

protected void sendWorkflowAbortedEmail(java.lang.String ticket,
                                        java.lang.String initiatorEmailAddr,
                                        org.activiti.engine.delegate.DelegateExecution execution,
                                        java.util.Map<java.lang.String,java.lang.Object> emailModel)

Send the email in the case of the workflow being aborted

Parameters:

ticket - OC ticket

initiatorEmailAddr - the email address

execution - the workflow execution

emailModel - the email model

getEmailBodyTemplate

protected java.lang.String getEmailBodyTemplate(java.util.Map<java.lang.String,java.lang.Object> emailModel)

Get the FTL template to use for the email body. This implementation ignores the email model and simply calls ActivitiConfig.getWfCompletedEmailTemplate(). Overriding subclasses can utilize the model to get different templates as necessary. For example, different workflow processes could have different templates.

Parameters:

emailModel - the email model

Returns:

the FTL template to use

getEmailSubjectTemplate

protected java.lang.String getEmailSubjectTemplate(java.util.Map<java.lang.String,java.lang.Object> emailModel)

Get the FTL template to use for the email subject. This implementation ignores the email model and simply calls ActivitiConfig.getWfCompletedEmailSubjectTemplate(). Overriding subclasses can utilize the model to get different templates as necessary. For example, different workflow processes could have different templates.

Parameters:

emailModel - the email model

Returns:

the FTL template to use