io.flamingock.internal.core.change.loaded

Class AbstractTemplateLoadedChange<CONFIG extends io.flamingock.api.template.TemplateField,APPLY extends io.flamingock.api.template.TemplatePayload,ROLLBACK extends io.flamingock.api.template.TemplatePayload>

java.lang.Object

io.flamingock.internal.common.core.change.AbstractChangeDescriptor

io.flamingock.internal.core.change.loaded.AbstractLoadedChange

io.flamingock.internal.core.change.loaded.AbstractReflectionLoadedChange

io.flamingock.internal.core.change.loaded.AbstractTemplateLoadedChange<CONFIG,APPLY,ROLLBACK>

Type Parameters:

CONFIG - the configuration type for the template

APPLY - the apply payload type

ROLLBACK - the rollback payload type

All Implemented Interfaces:

io.flamingock.internal.common.core.change.ChangeDescriptor, io.flamingock.internal.common.core.error.validation.Validatable<StageValidationContext>, java.lang.Comparable<io.flamingock.internal.common.core.change.ChangeDescriptor>

Direct Known Subclasses:

MultiStepTemplateLoadedChange, SimpleTemplateLoadedChange

public abstract class AbstractTemplateLoadedChange<CONFIG extends io.flamingock.api.template.TemplateField,APPLY extends io.flamingock.api.template.TemplatePayload,ROLLBACK extends io.flamingock.api.template.TemplatePayload>
extends AbstractReflectionLoadedChange

Abstract base class for template-based loaded changes. Contains common fields and methods shared by both SimpleTemplateLoadedChange and SteppableTemplateLoadedChange.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected boolean	rollbackPayloadRequired

Fields inherited from class io.flamingock.internal.core.change.loaded.AbstractReflectionLoadedChange

fileName, implementationClass

Fields inherited from class io.flamingock.internal.common.core.change.AbstractChangeDescriptor

author, id, legacy, order, recovery, runAlways, source, sourceFile, system, targetSystem, transactionalFlag

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AbstractTemplateLoadedChange(java.lang.String changeFileName, java.lang.String id, java.lang.String order, java.lang.String author, java.lang.Class<? extends io.flamingock.api.template.ChangeTemplate<CONFIG,APPLY,ROLLBACK>> templateClass, java.lang.reflect.Constructor<?> constructor, java.util.List<java.lang.String> profiles, java.lang.Boolean transactionalFlag, boolean transactional, boolean runAlways, boolean systemChange, CONFIG configurationPayload, io.flamingock.internal.common.core.change.TargetSystemDescriptor targetSystem, io.flamingock.internal.common.core.change.RecoveryDescriptor recovery, boolean rollbackPayloadRequired)

Method Summary

Modifier and Type	Method and Description
protected io.flamingock.api.template.TemplateValidationContext	buildValidationContext()
protected java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError>	checkPayloadTransactionSupport(io.flamingock.api.template.TemplatePayload payload, java.lang.String payloadLabel)
java.lang.reflect.Method	getApplyMethod() Returns the method to be invoked for executing the change.
CONFIG	getConfigurationPayload()
protected static java.lang.Boolean	getExplicitTransactionSupport(io.flamingock.api.template.TemplatePayload payload)
java.util.List<java.lang.String>	getProfiles()
java.util.Optional<java.lang.reflect.Method>	getRollbackMethod() Returns the optional method to be invoked for rolling back the change.
java.lang.Class<? extends io.flamingock.api.template.ChangeTemplate<CONFIG,APPLY,ROLLBACK>>	getTemplateClass()
java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError>	getValidationErrors(StageValidationContext context)
protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError>	validateApplyPayload()
protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError>	validateConfigurationPayload()
protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError>	validateRollbackPayload()
protected abstract void	warnIfAllPayloadsSupportTransactions()

Methods inherited from class io.flamingock.internal.core.change.loaded.AbstractReflectionLoadedChange

getConstructor, getFileName, getImplementationClass

Methods inherited from class io.flamingock.internal.core.change.loaded.AbstractLoadedChange

isTransactional

Methods inherited from class io.flamingock.internal.common.core.change.AbstractChangeDescriptor

equals, getAuthor, getId, getOrder, getRecovery, getSource, getSourceFile, getTargetSystem, getTransactionalFlag, hashCode, isLegacy, isRunAlways, isSystem, setAuthor, setId, setLegacy, setOrder, setRecovery, setRunAlways, setSource, setSourceFile, setSystem, setTargetSystem, setTransactionalFlag, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.flamingock.internal.common.core.error.validation.Validatable

isValid

Methods inherited from interface io.flamingock.internal.common.core.change.ChangeDescriptor

compareTo, isSortable, isStandard, pretty

Field Detail

logger

protected static final org.slf4j.Logger logger

rollbackPayloadRequired

protected final boolean rollbackPayloadRequired

Constructor Detail

AbstractTemplateLoadedChange

protected AbstractTemplateLoadedChange(java.lang.String changeFileName,
                                       java.lang.String id,
                                       java.lang.String order,
                                       java.lang.String author,
                                       java.lang.Class<? extends io.flamingock.api.template.ChangeTemplate<CONFIG,APPLY,ROLLBACK>> templateClass,
                                       java.lang.reflect.Constructor<?> constructor,
                                       java.util.List<java.lang.String> profiles,
                                       java.lang.Boolean transactionalFlag,
                                       boolean transactional,
                                       boolean runAlways,
                                       boolean systemChange,
                                       CONFIG configurationPayload,
                                       io.flamingock.internal.common.core.change.TargetSystemDescriptor targetSystem,
                                       io.flamingock.internal.common.core.change.RecoveryDescriptor recovery,
                                       boolean rollbackPayloadRequired)

Method Detail

getConfigurationPayload

public CONFIG getConfigurationPayload()

getProfiles

public java.util.List<java.lang.String> getProfiles()

getTemplateClass

public java.lang.Class<? extends io.flamingock.api.template.ChangeTemplate<CONFIG,APPLY,ROLLBACK>> getTemplateClass()

getApplyMethod

public java.lang.reflect.Method getApplyMethod()

Description copied from class: AbstractReflectionLoadedChange

Returns the method to be invoked for executing the change.

This method typically:

• Is annotated with @Apply
• Contains the main change logic
• May accept dependency-injected parameters

Specified by:

getApplyMethod in class AbstractReflectionLoadedChange

Returns:

the method to execute the change logic

getRollbackMethod

public java.util.Optional<java.lang.reflect.Method> getRollbackMethod()

Description copied from class: AbstractReflectionLoadedChange

Returns the optional method to be invoked for rolling back the change.

This method, if present:

• Is annotated with @Rollback
• Contains logic to undo the changes made by the execution method
• May accept dependency-injected parameters

Specified by:

getRollbackMethod in class AbstractReflectionLoadedChange

Returns:

an Optional containing the rollback method, or empty if no rollback is defined

getValidationErrors

public java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError> getValidationErrors(StageValidationContext context)

Specified by:

getValidationErrors in interface io.flamingock.internal.common.core.error.validation.Validatable<StageValidationContext>

Overrides:

getValidationErrors in class AbstractReflectionLoadedChange

buildValidationContext

protected io.flamingock.api.template.TemplateValidationContext buildValidationContext()

checkPayloadTransactionSupport

protected java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError> checkPayloadTransactionSupport(io.flamingock.api.template.TemplatePayload payload,
                                                                                                                             java.lang.String payloadLabel)

getExplicitTransactionSupport

protected static java.lang.Boolean getExplicitTransactionSupport(io.flamingock.api.template.TemplatePayload payload)

validateConfigurationPayload

protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError> validateConfigurationPayload()

validateApplyPayload

protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError> validateApplyPayload()

validateRollbackPayload

protected abstract java.util.List<io.flamingock.internal.common.core.error.validation.ValidationError> validateRollbackPayload()

warnIfAllPayloadsSupportTransactions

protected abstract void warnIfAllPayloadsSupportTransactions()