io.flamingock.internal.core.external.targets.mark

Interface TargetSystemAuditMarker

All Known Subinterfaces:

TransactionalTargetSystemOps

All Known Implementing Classes:

NoOpTargetSystemAuditMarker, TransactionalTargetSystemOpsImpl

public interface TargetSystemAuditMarker

Local repository that persists lightweight TargetSystemAuditMark entries indicating that a Change has been successfully applied on a transactional Target System.

This repository acts as a local advisory source of truth used during reconciliation with the remote Audit Store (e.g., in the Cloud edition). Its purpose is to reduce false negatives caused by incomplete or delayed remote audit state. Presence of a mark strongly indicates that the change was applied locally; absence is inconclusive and may require manual intervention.

Characteristics:

• Advisory, not critical: Missing marks do not corrupt the system; they only reduce the ability to auto-resolve discrepancies.
• Durable enough for recovery: Implementations should persist marks so they survive process crashes until synchronization is completed.
• Idempotent operations: Repeated inserts for the same change must be safe; removals should be no-ops if the mark does not exist.

Method Summary

Modifier and Type	Method and Description
void	clearMark(java.lang.String changeId) Removes the local audit mark for the given change identifier.
java.util.Set<TargetSystemAuditMark>	listAll() Returns all known local audit marks for the Target System.
void	mark(TargetSystemAuditMark auditMark) Creates or updates a local audit mark.
default void	markApplied(ExecutableTask change) Convenience method to record that the given Change has been applied on the local Target System.

Method Detail

listAll

java.util.Set<TargetSystemAuditMark> listAll()

Returns all known local audit marks for the Target System.

Returns:

a non-null, possibly empty set of TargetSystemAuditMark.

Throws:

io.flamingock.internal.common.core.error.FlamingockException - if the underlying storage cannot be read.

clearMark

void clearMark(java.lang.String changeId)

Removes the local audit mark for the given change identifier.

This is a hygienic cleanup step that should be invoked after the remote Audit Store has acknowledged the change, but not critical. It is idempotent: if no mark exists for changeId, the call completes without error.

Parameters:

changeId - the identifier of the change whose local mark should be removed.

Throws:

io.flamingock.internal.common.core.error.FlamingockException - if the operation fails (e.g., storage unavailable).

mark

void mark(TargetSystemAuditMark auditMark)

Creates or updates a local audit mark.

Implementations should ensure this operation is idempotent. The write operation must participate in the same transaction as the Target System operation that is being confirmed.

Parameters:

auditMark - the mark to persist.

Throws:

io.flamingock.internal.common.core.error.FlamingockException - if the operation fails (e.g., storage unavailable).

markApplied

default void markApplied(ExecutableTask change)

Convenience method to record that the given Change has been applied on the local Target System. Equivalent to calling mark(TargetSystemAuditMark) with a mark of type TargetSystemAuditMarkType.APPLIED.

Implementations should ensure this operation is idempotent. The write operation must participate in the same transaction as the Target System operation that is being confirmed.

Parameters:

change - the applied change to be marked locally.

Throws:

io.flamingock.internal.common.core.error.FlamingockException - if the operation fails (e.g., storage unavailable).