io.mongock.runner.core.executor

Class ChangeExecutorBase<CONFIG extends ChangeExecutorConfiguration>

java.lang.Object

io.mongock.runner.core.executor.ChangeExecutorBase<CONFIG>

All Implemented Interfaces:

Executor

Direct Known Subclasses:

MigrateExecutorBase, SystemUpdateExecutor

@NotThreadSafe
public abstract class ChangeExecutorBase<CONFIG extends ChangeExecutorConfiguration>
extends Object
implements Executor

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<AnnotatedElement,Boolean>	annotationFilter
protected ChangeLogRuntime	changeLogRuntime
protected ChangeLogServiceBase	changeLogService
protected Deque<Triple<Object,ChangeSetItem,Exception>>	changeSetsToRollBack
protected CONFIG	config
protected ConnectionDriver	driver
protected List<ChangeEntryExecuted>	executedChangeEntries
protected String	executionId
protected boolean	executionInProgress
protected Boolean	globalTransactionEnabled
protected Map<String,Object>	metadata
protected String	serviceIdentifier
protected boolean	trackIgnored

Constructor Summary

Constructors

Constructor and Description
ChangeExecutorBase(String executionId, ChangeLogServiceBase changeLogService, ConnectionDriver driver, ChangeLogRuntime changeLogRuntime, Function<AnnotatedElement,Boolean> annotationFilter, Map<String,Object> metadata, String serviceIdentifier, boolean trackIgnored, Optional<Boolean> transactional, Optional<Boolean> transactionEnabled, TransactionStrategy transactionStrategy, CONFIG config)

Method Summary

Modifier and Type	Method and Description
protected ChangeEntry	buildChangeEntry(String executionId, String executionHostname, ChangeSetItem changeSetItem, long executionTimeMillis, ChangeState state, ChangeType type)
protected ChangeEntry	buildChangeEntry(String executionId, String executionHostname, ChangeSetItem changeSetItem, long executionTimeMillis, ChangeState state, ChangeType type, Exception executionException, Exception rollbackException)
protected void	clearChangeSetsToRollbackIfApply(boolean applyPreparation)
protected void	executeAndLogChangeSet(String executionId, String executionHostname, Object changelogInstance, ChangeSetItem changeSetItem)
protected long	executeChangeSetMethod(Method changeSetMethod, Object changeLogInstance)
protected String	generateExecutionHostname(String executionId)
protected Object	getChangeLogInstance(Class<?> changeLogClass)
protected void	initializationAndValidation()
protected boolean	isAlreadyExecuted(ChangeSetItem changeSetItem)
protected boolean	isDriverTransactional()
boolean	isExecutionInProgress()
protected boolean	isStrategyPerChangeUnit()
protected boolean	isStrategyPerMigration()
protected boolean	isThereAnyChangeSetItemToBeExecuted(Collection<ChangeLogItem> changeLogs)
protected boolean	isThereAnyChangeSetItemToBeRolledBack(Collection<ChangeLogItem> changeLogs)
protected void	loadExecutedChangeEntries()
protected void	logIgnoredChangeLogs(Collection<ChangeLogItem> changeLogs)
protected void	logIgnoredChangeSet(ChangeSetItem changeSetItem)
protected void	loopRawChangeSets(String executionId, String executionHostName, Object changeLogInstance, ChangeLogItem changeLog, List<? extends ChangeSetItem> changeSets)
protected void	prepareChangeLogService()
protected void	prepareForStageExecutionIfApply(boolean applyPreparation)
protected void	processChangeLogInTransactionIfApplies(String executionId, String executionHostname, Object changeLogInstance, ChangeLogItem changeLog)
protected void	processChangeLogs(String executionId, String executionHostname, Collection<ChangeLogItem> changeLogs)
protected void	processExceptionOnChangeSetExecution(Exception exception, ChangeSetItem changeSetItem, boolean throwException)
protected void	processMigration(Collection<ChangeLogItem> changeLogs, String executionId, String executionHostname)
protected void	processSingleChangeLog(String executionId, String executionHostname, ChangeLogItem changeLog)
protected void	processSingleChangeSet(String executionId, String executionHostname, Object changeLogInstance, ChangeSetItem changeSet)
protected void	rollbackIfPresentAndTrackChangeEntry(String executionId, String executionHostname, Object changeLogInstance, ChangeSetItem changeSetItem, Exception changeSetException)
protected void	rollbackProcessedChangeSetsIfApply(String executionId, String hostname, Deque<Triple<Object,ChangeSetItem,Exception>> processedChangeSets) changeSetsToRollBack collection contains "all and only" the changeSets to rollback "manually" in case of any exception occurs, sorted in reverse order.
protected abstract void	validateChangeLog(ChangeLogItem changeLog)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mongock.runner.core.executor.Executor

executeMigration

Field Detail

globalTransactionEnabled

protected final Boolean globalTransactionEnabled

changeSetsToRollBack

protected final Deque<Triple<Object,ChangeSetItem,Exception>> changeSetsToRollBack

changeLogService

protected final ChangeLogServiceBase changeLogService

driver

protected final ConnectionDriver driver

serviceIdentifier

protected final String serviceIdentifier

trackIgnored

protected final boolean trackIgnored

metadata

protected final Map<String,Object> metadata

changeLogRuntime

protected final ChangeLogRuntime changeLogRuntime

annotationFilter

protected final Function<AnnotatedElement,Boolean> annotationFilter

executionInProgress

protected boolean executionInProgress

executionId

protected final String executionId

config

protected final CONFIG extends ChangeExecutorConfiguration config

executedChangeEntries

protected List<ChangeEntryExecuted> executedChangeEntries

Constructor Detail

ChangeExecutorBase

public ChangeExecutorBase(String executionId,
                          ChangeLogServiceBase changeLogService,
                          ConnectionDriver driver,
                          ChangeLogRuntime changeLogRuntime,
                          Function<AnnotatedElement,Boolean> annotationFilter,
                          Map<String,Object> metadata,
                          String serviceIdentifier,
                          boolean trackIgnored,
                          Optional<Boolean> transactional,
                          Optional<Boolean> transactionEnabled,
                          TransactionStrategy transactionStrategy,
                          CONFIG config)

Method Detail

isExecutionInProgress

public boolean isExecutionInProgress()

Specified by:

isExecutionInProgress in interface Executor

processMigration

protected void processMigration(Collection<ChangeLogItem> changeLogs,
                                String executionId,
                                String executionHostname)

processChangeLogs

protected void processChangeLogs(String executionId,
                                 String executionHostname,
                                 Collection<ChangeLogItem> changeLogs)

validateChangeLog

protected abstract void validateChangeLog(ChangeLogItem changeLog)

processSingleChangeLog

protected void processSingleChangeLog(String executionId,
                                      String executionHostname,
                                      ChangeLogItem changeLog)

getChangeLogInstance

protected Object getChangeLogInstance(Class<?> changeLogClass)

processChangeLogInTransactionIfApplies

protected void processChangeLogInTransactionIfApplies(String executionId,
                                                      String executionHostname,
                                                      Object changeLogInstance,
                                                      ChangeLogItem changeLog)

loopRawChangeSets

protected void loopRawChangeSets(String executionId,
                                 String executionHostName,
                                 Object changeLogInstance,
                                 ChangeLogItem changeLog,
                                 List<? extends ChangeSetItem> changeSets)

rollbackProcessedChangeSetsIfApply

protected void rollbackProcessedChangeSetsIfApply(String executionId,
                                                  String hostname,
                                                  Deque<Triple<Object,ChangeSetItem,Exception>> processedChangeSets)

changeSetsToRollBack collection contains "all and only" the changeSets to rollback "manually" in case of any exception occurs, sorted in reverse order.

scenarios for the changeSetsToRollBack collection - strategy == MIGRATION and transactional: It should be empty, as all the changeSets, before included, should be rollBacked in the transaction. - strategy == MIGRATION and non-transactional: It should contain all the executed changeSets in the entire migration, main and before, in execution reverse order - strategy == CHANGE_LOG and transactional: It should contain only the before methods executed for the current changeLog - strategy == CHANGE_LOG and non-transactional: It should contain all the executed changeSets in the current changeLog, main and before, in execution reverse order

processSingleChangeSet

protected void processSingleChangeSet(String executionId,
                                      String executionHostname,
                                      Object changeLogInstance,
                                      ChangeSetItem changeSet)

generateExecutionHostname

protected String generateExecutionHostname(String executionId)

isThereAnyChangeSetItemToBeExecuted

protected boolean isThereAnyChangeSetItemToBeExecuted(Collection<ChangeLogItem> changeLogs)

isThereAnyChangeSetItemToBeRolledBack

protected boolean isThereAnyChangeSetItemToBeRolledBack(Collection<ChangeLogItem> changeLogs)

isAlreadyExecuted

protected boolean isAlreadyExecuted(ChangeSetItem changeSetItem)

executeAndLogChangeSet

protected void executeAndLogChangeSet(String executionId,
                                      String executionHostname,
                                      Object changelogInstance,
                                      ChangeSetItem changeSetItem)
                               throws IllegalAccessException,
                                      InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

rollbackIfPresentAndTrackChangeEntry

protected void rollbackIfPresentAndTrackChangeEntry(String executionId,
                                                    String executionHostname,
                                                    Object changeLogInstance,
                                                    ChangeSetItem changeSetItem,
                                                    Exception changeSetException)
                                             throws InvocationTargetException,
                                                    IllegalAccessException

Throws:

InvocationTargetException

IllegalAccessException

logIgnoredChangeSet

protected void logIgnoredChangeSet(ChangeSetItem changeSetItem)

logIgnoredChangeLogs

protected void logIgnoredChangeLogs(Collection<ChangeLogItem> changeLogs)

buildChangeEntry

protected ChangeEntry buildChangeEntry(String executionId,
                                       String executionHostname,
                                       ChangeSetItem changeSetItem,
                                       long executionTimeMillis,
                                       ChangeState state,
                                       ChangeType type)

buildChangeEntry

protected ChangeEntry buildChangeEntry(String executionId,
                                       String executionHostname,
                                       ChangeSetItem changeSetItem,
                                       long executionTimeMillis,
                                       ChangeState state,
                                       ChangeType type,
                                       Exception executionException,
                                       Exception rollbackException)

executeChangeSetMethod

protected long executeChangeSetMethod(Method changeSetMethod,
                                      Object changeLogInstance)
                               throws IllegalAccessException,
                                      InvocationTargetException

Throws:

IllegalAccessException

InvocationTargetException

processExceptionOnChangeSetExecution

protected void processExceptionOnChangeSetExecution(Exception exception,
                                                    ChangeSetItem changeSetItem,
                                                    boolean throwException)

initializationAndValidation

protected void initializationAndValidation()
                                    throws MongockException

Throws:

MongockException

loadExecutedChangeEntries

protected void loadExecutedChangeEntries()

isDriverTransactional

protected final boolean isDriverTransactional()

isStrategyPerChangeUnit

protected final boolean isStrategyPerChangeUnit()

isStrategyPerMigration

protected final boolean isStrategyPerMigration()

prepareForStageExecutionIfApply

protected void prepareForStageExecutionIfApply(boolean applyPreparation)

clearChangeSetsToRollbackIfApply

protected void clearChangeSetsToRollbackIfApply(boolean applyPreparation)

prepareChangeLogService

protected void prepareChangeLogService()