Page History

...

Major version backward compatibility: can 9.0.0 ACM-runtime has to be backward compatible with 8.0.0? How many versions? can ACM-runtime 9.0.0 has to be backward compatible with ACM-runtime 7.0.0?
Minor version backward compatibility: as example, any 8.x.0 ACM-runtime has to be backward compatible with all ACM-runtime 8.y.0 versions.
Decouple between ACM-runtime and intermediary library: ACM-runtime 8.x.0 version has to be backward compatible with all intermediary library 8.y.0 versions.
Participant java code backward compatibility: intermediary library 9.0.0 version has to be java code backward compatible with participant 8.0.0 version.

What impacts backward compatibility?

...

About the regression tests, the only flows that could be tested will be based on what functionalities support the older version installed for the test.

Java code backward compatibility

Example of refactoring of the interface "AutomationCompositionElementListener " in New Delhi release.

Code Block

language	java
title	AutomationCompositionElementListener

public record CompositionDto(UUID compositionId,
                             List<AutomationCompositionElementDefinition> elementDefinitionList,
                             Map<ToscaConceptIdentifier, Map<String, Object>> outPropertiesMap) {
}

public record CompositionElementDto(UUID compositionId, ToscaConceptIdentifier elementDefinitionId,
                                    Map<String, Object> inProperties, Map<String, Object> outProperties) {
}

public record InstanceElementDto(UUID instanceId, UUID elementId, DeployOrder orderedState,
                                 Map<String, Object> inProperties, Map<String, Object> outProperties) {
}


/**
 * This interface is implemented by participant implementations to receive updates on automation composition elements.
 * Valid since New Delhi release.
 */
public interface AutomationCompositionElementListener {
    void deploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement) throws PfModelException;

    void undeploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement) throws PfModelException;

    void lock(CompositionElementDto compositionElement, InstanceElementDto instanceElement) throws PfModelException;

    void unlock(CompositionElementDto compositionElement, InstanceElementDto instanceElement) throws PfModelException;

    void delete(CompositionElementDto compositionElement, InstanceElementDto instanceElement) throws PfModelException;

    void update(CompositionElementDto compositionElement, InstanceElementDto instanceElement,
                InstanceElementDto instanceElementUpdated) throws PfModelException;

    void prime(CompositionDto composition) throws PfModelException;

    void deprime(CompositionDto composition) throws PfModelException;

    void handleRestartComposition(CompositionDto composition, AcTypeState state) throws PfModelException;

    void handleRestartInstance(CompositionElementDto compositionElement, InstanceElementDto instanceElement,
                               DeployState deployState, LockState lockState) throws PfModelException;

    void migrate(CompositionElementDto compositionElement, CompositionElementDto compositionElementTarget,
                 InstanceElementDto instanceElement, InstanceElementDto instanceElementMigrate) throws PfModelException;

    void migratePrecheck(CompositionElementDto compositionElement, CompositionElementDto compositionElementTarget,
                 InstanceElementDto instanceElement, InstanceElementDto instanceElementMigrate) throws PfModelException;
}

Wrapper class "AcElementListenerMontreal" for participant that was developed in Montreal release

Code Block

language	java
title	AcElementListenerMontreal

/**
 * Wrapper of AutomationCompositionElementListener.
 * Valid since Montreal release.
 */
public abstract class AcElementListenerMontreal implements AutomationCompositionElementListener {

    private final ParticipantIntermediaryApi intermediaryApi;

    protected AcElementListenerVer7(ParticipantIntermediaryApi intermediaryApi) {
        this.intermediaryApi = intermediaryApi;
    }

    @Override
    public void deploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
        throws PfModelException {
        var element = new  AcElementDeploy();
        element.setId(instanceElement.elementId());
        element.setDefinition(compositionElement.elementDefinitionId());
        element.setOrderedState(instanceElement.orderedState());
        element.setProperties(instanceElement.inProperties());
        Map<String, Object> properties = new HashMap<>(instanceElement.inProperties());
        properties.putAll(compositionElement.inProperties());
        deploy(instanceElement.instanceId(), element, properties);
    }

    public abstract void deploy(UUID instanceId, AcElementDeploy element, Map<String, Object> properties)
        throws PfModelException;

    @Override
    public void undeploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
        throws PfModelException {
        undeploy(instanceElement.instanceId(), instanceElement.elementId());
    }

    public abstract void undeploy(UUID instanceId, UUID elementId) throws PfModelException;

    @Override
    public void lock(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
        throws PfModelException {
        lock(instanceElement.instanceId(), instanceElement.elementId());
    }

    public abstract void lock(UUID instanceId, UUID elementId) throws PfModelException;

    @Override
    public void unlock(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
        throws PfModelException {
        unlock(instanceElement.instanceId(), instanceElement.elementId());
    }

    public abstract void unlock(UUID instanceId, UUID elementId) throws PfModelException;

    @Override
    public void delete(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
        throws PfModelException {
        delete(instanceElement.instanceId(), instanceElement.elementId());
    }

    public abstract void delete(UUID instanceId, UUID elementId) throws PfModelException;

    @Override
    public void update(CompositionElementDto compositionElement, InstanceElementDto instanceElement,
                InstanceElementDto instanceElementUpdated) throws PfModelException {
        var element = new  AcElementDeploy();
        element.setId(instanceElementUpdated.elementId());
        element.setDefinition(compositionElement.elementDefinitionId());
        element.setOrderedState(instanceElement.orderedState());
        element.setProperties(instanceElementUpdated.inProperties());
        update(instanceElementUpdated.instanceId(), element, element.getProperties());
    }

    public abstract void update(UUID instanceId, AcElementDeploy element, Map<String, Object> properties)
        throws PfModelException;

    @Override
    public void prime(CompositionDto composition) throws PfModelException {
        prime(composition.compositionId(), composition.elementDefinitionList());
    }

    public abstract void prime(UUID compositionId, List<AutomationCompositionElementDefinition> elementDefinitionList)
        throws PfModelException;

    @Override
    public void deprime(CompositionDto composition) throws PfModelException {
        deprime(composition.compositionId());
    }

    public abstract void deprime(UUID compositionId) throws PfModelException;

    @Override
    public void handleRestartComposition(CompositionDto composition, AcTypeState state) throws PfModelException {
        handleRestartComposition(composition.compositionId(), composition.elementDefinitionList(), state);
    }

    public abstract void handleRestartComposition(UUID compositionId,
                                         List<AutomationCompositionElementDefinition> elementDefinitionList,
                                         AcTypeState state) throws PfModelException;

    @Override
    public void handleRestartInstance(CompositionElementDto compositionElement, InstanceElementDto instanceElement,
        DeployState deployState, LockState lockState) throws PfModelException {
        var element = new  AcElementDeploy();
        element.setId(instanceElement.elementId());
        element.setDefinition(compositionElement.elementDefinitionId());
        element.setOrderedState(instanceElement.orderedState());
        element.setProperties(instanceElement.inProperties());
        Map<String, Object> properties = new HashMap<>(instanceElement.inProperties());
        properties.putAll(compositionElement.inProperties());
        handleRestartInstance(instanceElement.instanceId(), element, properties, deployState, lockState);
    }

    public abstract void handleRestartInstance(UUID instanceId, AcElementDeploy element,
        Map<String, Object> properties, DeployState deployState, LockState lockState) throws PfModelException;

    @Override
    public void migrate(CompositionElementDto compositionElement, CompositionElementDto compositionElementTarget,
        InstanceElementDto instanceElement, InstanceElementDto instanceElementMigrate) throws PfModelException {
        var element = new  AcElementDeploy();
        element.setId(instanceElement.elementId());
        element.setDefinition(compositionElement.elementDefinitionId());
        element.setOrderedState(instanceElement.orderedState());
        element.setProperties(instanceElement.inProperties());
        migrate(instanceElementMigrate.instanceId(), element, compositionElementTarget.compositionId(),
            element.getProperties());
    }

    public abstract void migrate(UUID instanceId, AcElementDeploy element, UUID compositionTargetId,
        Map<String, Object> properties) throws PfModelException;

    @Override
    public void migratePrecheck(CompositionElementDto compositionElement,
        CompositionElementDto compositionElementTarget, InstanceElementDto instanceElement,
        InstanceElementDto instanceElementMigrate) throws PfModelException {

        intermediaryApi.updateAutomationCompositionElementState(instanceElementMigrate.instanceId(),
            instanceElementMigrate.elementId(), DeployState.DEPLOYED, null, StateChangeResult.NO_ERROR,
            "Migrate precheck not supported");
    }
}

With that solution a Participant that was developed in Montreal release, could be use the wrapper "AcElementListenerMontreal" and do not need other changes.

Code Block

language	java
title	AutomationCompositionElementHandler

@Component
public class AutomationCompositionElementHandler extends AcElementListenerMontreal {

    private final ParticipantIntermediaryApi intermediaryApi;

    protected AutomationCompositionElementHandler(ParticipantIntermediaryApi intermediaryApi) {
        super(intermediaryApi);
        this.intermediaryApi = intermediaryApi;
    }

    @Override
    public void deploy(UUID automationCompositionId, AcElementDeploy element, Map<String, Object> properties)
            throws PfModelException {
----------

If participant needs the functionality of New Delhi version, they need to use "AcElementListenerNewDelhi"

Code Block

language	java

/**
 * Wrapper of AutomationCompositionElementListener.
 * Valid since New Delhi release.
 */
public abstract class AcElementListenerNewDelhi implements AutomationCompositionElementListener {
}

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Java code backward compatibility