io.flamingock.api.template

Class TemplateStep<APPLY,ROLLBACK>

java.lang.Object

io.flamingock.api.template.TemplateStep<APPLY,ROLLBACK>

Type Parameters:

APPLY - the type of the apply payload

ROLLBACK - the type of the rollback payload

public class TemplateStep<APPLY,ROLLBACK>
extends java.lang.Object

Represents a single step in a step-based change template.

Each step contains an apply operation that executes during the forward migration, and an optional rollback operation that executes if the step or a subsequent step fails.

YAML Structure

 steps:
   - apply:
       type: createCollection
       collection: users
     rollback:
       type: dropCollection
       collection: users
   - apply:
       type: insert
       collection: users
       parameters:
         documents:
           - name: "John"
     rollback:
       type: delete
       collection: users
       parameters:
         filter: {}
 

Rollback Behavior

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

Constructor Summary

Constructors

Constructor and Description
TemplateStep()
TemplateStep(APPLY apply, ROLLBACK rollback)

Method Summary

Modifier and Type	Method and Description
APPLY	getApply() Returns the apply payload for this step.
ROLLBACK	getRollback() Returns the rollback payload for this step.
boolean	hasRollback() Checks if this step has a rollback payload defined.
void	setApply(APPLY apply) Sets the apply payload for this step.
void	setRollback(ROLLBACK rollback) Sets the rollback payload for this step.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateStep

public TemplateStep()

TemplateStep

public TemplateStep(APPLY apply,
                    ROLLBACK rollback)

Method Detail

getApply

public APPLY getApply()

Returns the apply payload for this step.

Returns:

the apply payload (required)

setApply

public void setApply(APPLY apply)

Sets the apply payload for this step.

Parameters:

apply - the apply payload

getRollback

public ROLLBACK getRollback()

Returns the rollback payload for this step.

Returns:

the rollback payload, or null if no rollback is defined

setRollback

public void setRollback(ROLLBACK rollback)

Sets the rollback payload for this step.

Parameters:

rollback - the rollback payload (optional)

hasRollback

public boolean hasRollback()

Checks if this step has a rollback payload defined.

Returns:

true if a rollback payload is defined

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object