io.flamingock.internal.core.external.targets

Class TransactionalTargetSystem<HOLDER extends TransactionalTargetSystem<HOLDER>>

java.lang.Object

io.flamingock.internal.core.external.targets.AbstractTargetSystem<HOLDER>

io.flamingock.internal.core.external.targets.TransactionalTargetSystem<HOLDER>

Type Parameters:

HOLDER - the concrete target system type for fluent API support

All Implemented Interfaces:

io.flamingock.api.external.ExternalSystem, io.flamingock.api.external.TargetSystem, io.flamingock.internal.common.core.context.ContextConfigurable<HOLDER>, io.flamingock.internal.common.core.context.ContextInitializable, io.flamingock.internal.common.core.context.ContextProvider

public abstract class TransactionalTargetSystem<HOLDER extends TransactionalTargetSystem<HOLDER>>
extends AbstractTargetSystem<HOLDER>
implements io.flamingock.internal.common.core.context.ContextInitializable

Base implementation for target systems that support transactional operations.

Extends AbstractTargetSystem to add transaction management capabilities, including transaction wrapping, audit marking, etc.

Subclasses must provide:

• A TransactionWrapper for managing transactions
• An audit marker for tracking execution state (optional in Community Edition)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoCreate
protected TargetSystemAuditMarker	markerRepository
protected java.lang.String	onGoingTasksRepositoryName

Fields inherited from class io.flamingock.internal.core.external.targets.AbstractTargetSystem

targetSystemContext

Constructor Summary

Constructors

Constructor and Description
TransactionalTargetSystem(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
<T> T	applyChangeTransactional(java.util.function.Function<ExecutionRuntime,T> changeApplier, ExecutionRuntime executionRuntime) Applies a change operation within a transaction.
java.util.Optional<io.flamingock.internal.common.core.audit.AuditHistoryReader>	getAuditAuditReader(io.flamingock.internal.common.core.audit.AuditReaderType type) Returns an audit history reader for importing audit entries from external migration sources.
TargetSystemAuditMarker	getOnGoingTaskStatusRepository() Returns the audit marker for tracking execution state.
abstract TransactionWrapper	getTxWrapper() Returns the transaction wrapper for this target system.
boolean	hasMarker()

Methods inherited from class io.flamingock.internal.core.external.targets.AbstractTargetSystem

addDependency, addDependency, addDependency, addDependency, applyChange, enhanceExecutionRuntime, getContext, getId, getSelf, rollbackChange, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.flamingock.internal.common.core.context.ContextInitializable

initialize

Field Detail

onGoingTasksRepositoryName

protected java.lang.String onGoingTasksRepositoryName

autoCreate

protected boolean autoCreate

markerRepository

protected TargetSystemAuditMarker markerRepository

Constructor Detail

TransactionalTargetSystem

public TransactionalTargetSystem(java.lang.String id)

Method Detail

hasMarker

public boolean hasMarker()

applyChangeTransactional

public final <T> T applyChangeTransactional(java.util.function.Function<ExecutionRuntime,T> changeApplier,
                                            ExecutionRuntime executionRuntime)

Applies a change operation within a transaction.

This method orchestrates transactional change execution by:

1. Calling AbstractTargetSystem.enhanceExecutionRuntime(ExecutionRuntime, boolean) with isTransactional=true for session-scoped dependency injection
2. Delegating to the TransactionWrapper for transaction management and potential injection of transaction-scoped dependencies

Type Parameters:

T - the return type of the change operation

Parameters:

changeApplier - the function that executes the actual change

executionRuntime - the runtime context for dependency resolution

Returns:

the result of the change operation

getOnGoingTaskStatusRepository

public TargetSystemAuditMarker getOnGoingTaskStatusRepository()

Returns the audit marker for tracking execution state.

In Community Edition, this typically returns a NoOpTargetSystemAuditMarker. In Cloud Edition, it returns an implementation that persists execution state.

Returns:

the audit marker instance

getTxWrapper

public abstract TransactionWrapper getTxWrapper()

Returns the transaction wrapper for this target system.

The wrapper is responsible for starting, committing, and rolling back transactions, as well as injecting transaction-scoped dependencies into the execution runtime.

Returns:

the transaction wrapper instance

getAuditAuditReader

public java.util.Optional<io.flamingock.internal.common.core.audit.AuditHistoryReader> getAuditAuditReader(io.flamingock.internal.common.core.audit.AuditReaderType type)

Returns an audit history reader for importing audit entries from external migration sources.

This method enables Flamingock to import audit history from legacy migration tools or other Flamingock installations, preventing re-execution of already-applied changes. The returned reader provides access to historical audit entries that can be written to Flamingock's audit store.

Common use cases include:

• Mongock migration: Import Mongock change history when migrating from Mongock to Flamingock
• Community to Cloud migration: Import audit history from local database to Flamingock Cloud backend
• Future extensibility: Support for other migration tools (Liquibase, Flyway, etc.)

The default implementation returns Optional.empty(), indicating no audit reader is available. Target system implementations should override this method to provide database-specific readers when migration support is needed.

Parameters:

type - the type of audit reader to retrieve (e.g., AuditReaderType.MONGOCK)

Returns:

an Optional containing the audit history reader if supported for the given type, or Optional.empty() if this target system does not support audit reading for the specified type

See Also:

AuditHistoryReader, AuditReaderType