io.flamingock.api.template

Class AbstractSteppableTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

java.lang.Object

io.flamingock.api.template.AbstractChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

io.flamingock.api.template.AbstractSteppableTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

Type Parameters:

SHARED_CONFIG - the type of shared configuration

APPLY - the type of the apply payload for each step

ROLLBACK - the type of the rollback payload for each step

All Implemented Interfaces:

ChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>, ReflectionMetadataProvider

public abstract class AbstractSteppableTemplate<SHARED_CONFIG,APPLY,ROLLBACK>
extends AbstractChangeTemplate<SHARED_CONFIG,APPLY,ROLLBACK>

Abstract base class for templates with multiple steps.

Use this class when your template processes multiple operations, each with its own apply and optional rollback. The YAML structure for this template type is:

 id: create-orders-collection
 template: MongoChangeTemplate
 steps:
   - apply:
       type: createCollection
       collection: orders
     rollback:
       type: dropCollection
       collection: orders
   - apply:
       type: insert
       collection: orders
       parameters:
         documents:
           - orderId: "ORD-001"
     rollback:
       type: delete
       collection: orders
       parameters:
         filter: {}
 

The framework will automatically parse the steps from the YAML and inject them via setSteps(java.util.List<io.flamingock.api.template.TemplateStep<APPLY, ROLLBACK>>).

Rollback Behavior:

• When a step fails, all previously successful steps are rolled back in reverse order
• Steps without rollback operations are skipped during rollback
• Rollback errors are logged but don't stop the rollback process

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<TemplateStep<APPLY,ROLLBACK>>	steps

Fields inherited from class io.flamingock.api.template.AbstractChangeTemplate

changeId, configuration, isTransactional

Constructor Summary

Constructors

Constructor and Description
AbstractSteppableTemplate(java.lang.Class<?>... additionalReflectiveClass)

Method Summary

Modifier and Type	Method and Description
java.util.List<TemplateStep<APPLY,ROLLBACK>>	getSteps() Returns the list of steps.
void	setSteps(java.util.List<TemplateStep<APPLY,ROLLBACK>> steps) Sets the list of steps to execute.

Methods inherited from class io.flamingock.api.template.AbstractChangeTemplate

getApplyPayloadClass, getConfigurationClass, getReflectiveClasses, getRollbackPayloadClass, setChangeId, setConfiguration, setTransactional

Methods inherited from class java.lang.Object

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

Field Detail

steps

protected java.util.List<TemplateStep<APPLY,ROLLBACK>> steps

Constructor Detail

AbstractSteppableTemplate

public AbstractSteppableTemplate(java.lang.Class<?>... additionalReflectiveClass)

Method Detail

setSteps

public void setSteps(java.util.List<TemplateStep<APPLY,ROLLBACK>> steps)

Sets the list of steps to execute.

Parameters:

steps - the list of template steps

getSteps

public java.util.List<TemplateStep<APPLY,ROLLBACK>> getSteps()

Returns the list of steps.

Returns:

the list of template steps, or null if not set