org.camunda.bpm.engine.migration

Interface MigrationPlanExecutionBuilder

All Known Implementing Classes:

MigrationPlanExecutionBuilderImpl

public interface MigrationPlanExecutionBuilder

Builder to execute a migration.

Method Summary

Modifier and Type	Method and Description
void	execute() Execute the migration synchronously.
Batch	executeAsync() Execute the migration asynchronously as batch.
MigrationPlanExecutionBuilder	processInstanceIds(List<String> processInstanceIds)
MigrationPlanExecutionBuilder	processInstanceIds(String... processInstanceIds)
MigrationPlanExecutionBuilder	processInstanceQuery(ProcessInstanceQuery processInstanceQuery)
MigrationPlanExecutionBuilder	skipCustomListeners() Skips custom execution listeners when creating/removing activity instances during migration
MigrationPlanExecutionBuilder	skipIoMappings() Skips io mappings when creating/removing activity instances during migration

Method Detail

processInstanceIds

MigrationPlanExecutionBuilder processInstanceIds(List<String> processInstanceIds)

Parameters:

processInstanceIds - the process instance ids to migrate.

processInstanceIds

MigrationPlanExecutionBuilder processInstanceIds(String... processInstanceIds)

Parameters:

processInstanceIds - the process instance ids to migrate.

processInstanceQuery

MigrationPlanExecutionBuilder processInstanceQuery(ProcessInstanceQuery processInstanceQuery)

Parameters:

processInstanceQuery - a query which selects the process instances to migrate. Query results are restricted to process instances for which the user has Permissions.READ permission.

skipCustomListeners

MigrationPlanExecutionBuilder skipCustomListeners()

Skips custom execution listeners when creating/removing activity instances during migration

skipIoMappings

MigrationPlanExecutionBuilder skipIoMappings()

Skips io mappings when creating/removing activity instances during migration

execute

void execute()

Execute the migration synchronously.

Throws:

MigratingProcessInstanceValidationException - if the migration plan contains instructions that are not applicable to any of the process instances

AuthorizationException - if the user has not all of the following permissions

• if the user has no Permissions.UPDATE permission on Resources.PROCESS_INSTANCE or
• no Permissions.UPDATE_INSTANCE permission on Resources.PROCESS_DEFINITION

BadUserRequestException - When the affected instances count exceeds the maximum results limit. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE). Please use the batch operation executeAsync() instead.

executeAsync

Batch executeAsync()

Execute the migration asynchronously as batch. The returned batch can be used to track the progress of the migration.

Returns:

the batch which executes the migration asynchronously.

Throws:

AuthorizationException - if the user has not all of the following permissions

• Permissions.MIGRATE_INSTANCE permission on Resources.PROCESS_DEFINITION for source and target
• Permissions.CREATE or BatchPermissions.CREATE_BATCH_MIGRATE_PROCESS_INSTANCES permission on Resources.BATCH