io.flamingock.internal.core.task.navigation.navigator.strategy

Class AbstractChangeProcessStrategy<TS_OPS extends TargetSystemOps>

java.lang.Object

io.flamingock.internal.core.task.navigation.navigator.strategy.AbstractChangeProcessStrategy<TS_OPS>

Type Parameters:

TS_OPS - The type of target system operations supported by this strategy

All Implemented Interfaces:

ChangeProcessStrategy

Direct Known Subclasses:

NonTxChangeProcessStrategy, SharedTxChangeProcessStrategy, SimpleTxChangeProcessStrategy

public abstract class AbstractChangeProcessStrategy<TS_OPS extends TargetSystemOps>
extends java.lang.Object
implements ChangeProcessStrategy

Abstract base class for change process strategies implementing common audit and execution patterns.

This class provides the foundational infrastructure for executing changes across different target system types while maintaining consistent audit trails and execution results. Concrete implementations define the specific transaction handling and execution flow patterns appropriate for their target system characteristics.

Common Execution Pattern

1. Check if change is already applied (skip if so)
2. Audit change start in audit store
3. Execute change using strategy-specific approach
4. Audit execution result
5. Handle rollbacks and cleanup as needed
6. Return execution result

Audit Operations

All strategies use consistent audit operations provided by this base class:

• auditAndLogStartExecution - Records change initiation
• auditAndLogExecution - Records execution results
• auditAndLogManualRollback - Records manual rollback operations
• auditAndLogAutoRollback - Records automatic transaction rollbacks

Execution Runtime

The execution runtime provides dependency injection and security context for change execution, ensuring changes have access to required dependencies while maintaining proper lock management.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuditStoreStepOperations	auditStoreOperations
protected ExecutableTask	change
protected ExecutionContext	executionContext
protected ChangeResultBuilder	resultBuilder
protected static ChangeProcessLogger	stepLogger
protected TS_OPS	targetSystemOps
protected io.flamingock.internal.util.TimeService	timeService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChangeProcessStrategy(ExecutableTask change, ExecutionContext executionContext, TS_OPS targetSystemOps, AuditStoreStepOperations auditStoreOperations, ChangeResultBuilder resultBuilder, LockGuardProxyFactory proxyFactory, io.flamingock.internal.common.core.context.ContextResolver baseContext, io.flamingock.internal.util.TimeService timeService)

Method Summary

Modifier and Type	Method and Description
ChangeProcessResult	applyChange() Applies the change and returns the result.
protected void	auditAndLogAutoRollback(CompleteAutoRolledBackStep rolledBackStep, ExecutionContext executionContext)
protected AfterExecutionAuditStep	auditAndLogExecution(ExecutionStep executionStep) Audits and logs the execution result of a change.
protected void	auditAndLogManualRollback(ManualRolledBackStep rolledBackStep, ExecutionContext executionContext)
protected ExecutableStep	auditAndLogStartExecution(StartStep startStep, ExecutionContext executionContext) Audits and logs the start of change execution.
protected ExecutionRuntime	buildExecutionRuntime() Builds the execution runtime for change execution.
protected abstract ChangeProcessResult	doApplyChange() Strategy-specific implementation of change application.

Methods inherited from class java.lang.Object

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

Field Detail

stepLogger

protected static final ChangeProcessLogger stepLogger

change

protected final ExecutableTask change

targetSystemOps

protected final TS_OPS extends TargetSystemOps targetSystemOps

executionContext

protected final ExecutionContext executionContext

resultBuilder

protected final ChangeResultBuilder resultBuilder

auditStoreOperations

protected final AuditStoreStepOperations auditStoreOperations

timeService

protected final io.flamingock.internal.util.TimeService timeService

Constructor Detail

AbstractChangeProcessStrategy

protected AbstractChangeProcessStrategy(ExecutableTask change,
                                        ExecutionContext executionContext,
                                        TS_OPS targetSystemOps,
                                        AuditStoreStepOperations auditStoreOperations,
                                        ChangeResultBuilder resultBuilder,
                                        LockGuardProxyFactory proxyFactory,
                                        io.flamingock.internal.common.core.context.ContextResolver baseContext,
                                        io.flamingock.internal.util.TimeService timeService)

Method Detail

applyChange

public final ChangeProcessResult applyChange()

Description copied from interface: ChangeProcessStrategy

Applies the change and returns the result.

Specified by:

applyChange in interface ChangeProcessStrategy

Returns:

the result of applying the change

doApplyChange

protected abstract ChangeProcessResult doApplyChange()

Strategy-specific implementation of change application.

Concrete strategies must implement this method to define their specific transaction handling, execution flow, and error recovery patterns.

Returns:

Task execution result with success/failure status and details

auditAndLogStartExecution

protected ExecutableStep auditAndLogStartExecution(StartStep startStep,
                                                   ExecutionContext executionContext)

Audits and logs the start of change execution.

Parameters:

startStep - The initial step for the change

executionContext - The execution context

Returns:

The executable step ready for execution

auditAndLogExecution

protected AfterExecutionAuditStep auditAndLogExecution(ExecutionStep executionStep)

Audits and logs the execution result of a change.

Parameters:

executionStep - The execution step with results

Returns:

The after-execution audit step

auditAndLogManualRollback

protected void auditAndLogManualRollback(ManualRolledBackStep rolledBackStep,
                                         ExecutionContext executionContext)

auditAndLogAutoRollback

protected void auditAndLogAutoRollback(CompleteAutoRolledBackStep rolledBackStep,
                                       ExecutionContext executionContext)

buildExecutionRuntime

protected ExecutionRuntime buildExecutionRuntime()

Builds the execution runtime for change execution.

The runtime provides dependency injection context and security proxies needed for safe change execution with proper lock management.

Returns:

Configured execution runtime