io.flamingock.internal.core.external.targets.operations

Interface TransactionalTargetSystemOps

All Superinterfaces:

io.flamingock.api.external.ExternalSystem, io.flamingock.api.external.TargetSystem, TargetSystemAuditMarker, TargetSystemOps

All Known Implementing Classes:

TransactionalTargetSystemOpsImpl

public interface TransactionalTargetSystemOps
extends TargetSystemOps, TargetSystemAuditMarker

Operational interface for target systems that support transactional operations.

Extends TargetSystemOps to add transactional change execution and audit marking capabilities. This interface is used by the execution engine when processing changes marked as transactional.

Implementations typically wrap a TransactionalTargetSystem instance and delegate operations to it.

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.

Methods inherited from interface io.flamingock.internal.core.external.targets.operations.TargetSystemOps

applyChange, getOperationType, rollbackChange

Methods inherited from interface io.flamingock.api.external.ExternalSystem

getId

Methods inherited from interface io.flamingock.internal.core.external.targets.mark.TargetSystemAuditMarker

clearMark, listAll, mark, markApplied

Method Detail

applyChangeTransactional

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

Applies a change operation within a transaction.

This method coordinates transactional execution by:

• Injecting session-scoped dependencies via the target system
• Starting a transaction and injecting transaction-scoped dependencies
• Executing the change function within the transaction
• Committing or rolling back based on the operation result

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

Throws:

java.lang.RuntimeException - if the transaction fails

getAuditAuditReader

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