Package com.flowable.platform.service.template

Class TemplateChangeServiceImpl

java.lang.Object

com.flowable.platform.service.template.TemplateChangeServiceImpl

All Implemented Interfaces:

TemplateChangeService

@Transactional
public class TemplateChangeServiceImpl
extends java.lang.Object
implements TemplateChangeService

The implementation of the the template change service able to change and deploy a change to a template or template variation at runtime with an optional change process being triggered first.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditService	auditService
protected java.lang.String	changeApprovalProcessKey
protected org.flowable.engine.IdentityService	identityService
protected static org.slf4j.Logger	LOG
static java.lang.String	PRC_BUSINESS_KEY_TEMPLATE_CHANGE
protected org.flowable.engine.RuntimeService	runtimeService
protected org.flowable.engine.TaskService	taskService
protected TemplateEngineConfiguration	templateEngineConfiguration
protected TemplateRepositoryService	templateRepositoryService
protected static java.time.format.DateTimeFormatter	VERSION_DATETIME_FORMAT

Fields inherited from interface com.flowable.platform.service.template.TemplateChangeService

AUDIT_ENTRY_SUB_TYPE_TEMPLATE_VARIATION, AUDIT_ENTRY_TYPE_DEPLOYMENT, AUDIT_ENTRY_VAR_NAME_APPROVAL_USER_ID, AUDIT_ENTRY_VAR_NAME_CHANGE_USER_ID, AUDIT_ENTRY_VAR_OLD_VERSION_TIMESTAMP, PRC_VAR_NAME_APPROVED, PRC_VAR_NAME_NEW_CONTENT, PRC_VAR_NAME_NEW_CONTENT_RESOURCE, PRC_VAR_NAME_TPL_DEF_ID, PRC_VAR_NAME_TRIGGERING_USER_ID, PRC_VAR_NAME_TRIGGERING_USER_NAME

Constructor Summary

Constructors

Constructor	Description
TemplateChangeServiceImpl(TemplateRepositoryService templateRepositoryService, TemplateEngineConfiguration templateEngineConfiguration, org.flowable.engine.RuntimeService runtimeService, org.flowable.engine.TaskService taskService, org.flowable.engine.IdentityService identityService, AuditService auditService)

Method Summary

Modifier and Type	Method	Description
protected void	completeApprovalTask(java.lang.String templateVariationId, org.flowable.engine.runtime.ProcessInstance approvalPrc, UpdateTemplateVariationRequest updateRequest)
void	deployTemplateVariationContentChange(java.lang.String templateVariationId, java.lang.String tenantId, java.lang.String newVariationContent, java.lang.String newVariationContentResource)	Directly changes and deploys the variation content of the given template variation at runtime.
org.flowable.engine.runtime.ProcessInstance	findApprovalProcessInstance(java.lang.String combinedTemplateVariationKey, java.lang.String tenantId)	Find a running approval / change process for the specified template variation.
java.lang.String	getChangeApprovalProcessKey()
protected TemplateVariationHolder	loadAndCheckTemplateVariation(java.lang.String templateVariationId, java.lang.String tenantId, boolean throwIfNotEditable)
void	setChangeApprovalProcessKey(java.lang.String changeApprovalProcessKey)
protected org.flowable.engine.runtime.ProcessInstance	triggerChangeAndApprovalProcess(java.lang.String templateVariationId, java.lang.String tenantId, TemplateVariationModel variationModel, java.lang.String newVariationContent, java.lang.String newVariationContentResource)
void	triggerTemplateVariationContentChange(java.lang.String templateVariationId, java.lang.String tenantId, UpdateTemplateVariationRequest updateRequest)	Changes and deploys the variation content of the given template variation at runtime.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

VERSION_DATETIME_FORMAT

protected static final java.time.format.DateTimeFormatter VERSION_DATETIME_FORMAT

PRC_BUSINESS_KEY_TEMPLATE_CHANGE

public static final java.lang.String PRC_BUSINESS_KEY_TEMPLATE_CHANGE

See Also:

Constant Field Values

changeApprovalProcessKey

@Value("${flowable.template.changeApprovalProcessKey:TM_P01_templateChangeApprovalProcess}")
protected java.lang.String changeApprovalProcessKey

templateRepositoryService

protected final TemplateRepositoryService templateRepositoryService

templateEngineConfiguration

protected final TemplateEngineConfiguration templateEngineConfiguration

runtimeService

protected final org.flowable.engine.RuntimeService runtimeService

taskService

protected final org.flowable.engine.TaskService taskService

identityService

protected final org.flowable.engine.IdentityService identityService

auditService

protected final AuditService auditService

Constructor Detail

TemplateChangeServiceImpl

public TemplateChangeServiceImpl(TemplateRepositoryService templateRepositoryService,
                                 TemplateEngineConfiguration templateEngineConfiguration,
                                 org.flowable.engine.RuntimeService runtimeService,
                                 org.flowable.engine.TaskService taskService,
                                 org.flowable.engine.IdentityService identityService,
                                 AuditService auditService)

Method Detail

triggerTemplateVariationContentChange

public void triggerTemplateVariationContentChange(java.lang.String templateVariationId,
                                                  java.lang.String tenantId,
                                                  UpdateTemplateVariationRequest updateRequest)

Description copied from interface: TemplateChangeService

Changes and deploys the variation content of the given template variation at runtime. This will start a change / approval process, if configured. And if that's the case, the change and deploy does not happen immediately, but will be done as part of the process. If there is no such process in place, this method will directly invoke TemplateChangeService.deployTemplateVariationContentChange(String, String, String, String).

Specified by:

triggerTemplateVariationContentChange in interface TemplateChangeService

Parameters:

templateVariationId - the id of the template variation to change its variation content

updateRequest - the update request containing the necessary data (e.g. new variation content, etc) for the update

completeApprovalTask

protected void completeApprovalTask(java.lang.String templateVariationId,
                                    org.flowable.engine.runtime.ProcessInstance approvalPrc,
                                    UpdateTemplateVariationRequest updateRequest)

triggerChangeAndApprovalProcess

protected org.flowable.engine.runtime.ProcessInstance triggerChangeAndApprovalProcess(java.lang.String templateVariationId,
                                                                                      java.lang.String tenantId,
                                                                                      TemplateVariationModel variationModel,
                                                                                      java.lang.String newVariationContent,
                                                                                      java.lang.String newVariationContentResource)

findApprovalProcessInstance

public org.flowable.engine.runtime.ProcessInstance findApprovalProcessInstance(java.lang.String combinedTemplateVariationKey,
                                                                               java.lang.String tenantId)

Description copied from interface: TemplateChangeService

Find a running approval / change process for the specified template variation.

Specified by:

findApprovalProcessInstance in interface TemplateChangeService

Parameters:

combinedTemplateVariationKey - the combined id of the template and variation key (as being returned by TemplateVariationModel.getKey()

Returns:

the optional, running approval process, if any found, null otherwise

deployTemplateVariationContentChange

public void deployTemplateVariationContentChange(java.lang.String templateVariationId,
                                                 java.lang.String tenantId,
                                                 java.lang.String newVariationContent,
                                                 java.lang.String newVariationContentResource)

Description copied from interface: TemplateChangeService

Directly changes and deploys the variation content of the given template variation at runtime. This method is either invoked by TemplateChangeService.triggerTemplateVariationContentChange(String, String, UpdateTemplateVariationRequest) or as part of the change / approval process to eventually deploy the changed content.

Specified by:

deployTemplateVariationContentChange in interface TemplateChangeService

Parameters:

templateVariationId - the id of the template variation to change and deploy its content

tenantId - the optional id of the tenant

newVariationContent - the new variation content to change and deploy (can be null if newVariationContentResource is passed)

newVariationContentResource - the new variation content resource to change and deploy (can be null if newVariationContent is passed)

loadAndCheckTemplateVariation

protected TemplateVariationHolder loadAndCheckTemplateVariation(java.lang.String templateVariationId,
                                                                java.lang.String tenantId,
                                                                boolean throwIfNotEditable)

getChangeApprovalProcessKey

public java.lang.String getChangeApprovalProcessKey()

setChangeApprovalProcessKey

public void setChangeApprovalProcessKey(java.lang.String changeApprovalProcessKey)