com.edorasware.cloud.core.transfer

Interface AppVersioningStrategy

public interface AppVersioningStrategy

Defines a strategy for managing app versions and detecting updates and conflicts as the apps are transferred between systems.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<String,String>	getAppVersioningMetaData(com.edorasware.commons.core.entity.GlobalId appModelGlobalId) Returns the metadata that should be stored as part of the export.
void	incrementVersion(com.edorasware.commons.core.entity.GlobalId appModelGlobalId, String comment) Increments the version number for the given app.
boolean	isNewerVersion(com.edorasware.commons.core.entity.GlobalId appModelGlobalId, Map<String,String> incomingMetaData) Checks that the incoming app is a newer version of the current app.
void	markAsModified(com.edorasware.commons.core.entity.GlobalId appModelGlobalId) Called whenever an app has been modified (e.g. when it transitions to the 'pending' state).

Method Detail

incrementVersion

void incrementVersion(com.edorasware.commons.core.entity.GlobalId appModelGlobalId,
                    String comment)
                      throws AppVersioningException

Increments the version number for the given app.

Parameters:

appModelGlobalId - the global ID of the app model whose version is to be incremented

comment - the modification comment

Throws:

AppVersioningException - if the global ID does not correspond to a valid app model

getAppVersioningMetaData

com.google.common.collect.ImmutableMap<String,String> getAppVersioningMetaData(com.edorasware.commons.core.entity.GlobalId appModelGlobalId)
                                                                               throws AppVersioningException

Returns the metadata that should be stored as part of the export. This metadata will be needed to check whether or not a particular version should be imported.

Parameters:

appModelGlobalId - the global ID of the app model being exported

Returns:

the map of metadata key/value pairs

Throws:

AppVersioningException - if the app does not contain versioning information

isNewerVersion

boolean isNewerVersion(com.edorasware.commons.core.entity.GlobalId appModelGlobalId,
                     Map<String,String> incomingMetaData)
                       throws AppVersioningException

Checks that the incoming app is a newer version of the current app.

Parameters:

appModelGlobalId - the global ID of the local app model to be checked

incomingMetaData - the incoming app versioning metadata

Returns:

true if the incoming app is a newer version

Throws:

AppVersioningException - if the app versioning information is incompatible

markAsModified

void markAsModified(com.edorasware.commons.core.entity.GlobalId appModelGlobalId)

Called whenever an app has been modified (e.g. when it transitions to the 'pending' state).

Parameters:

appModelGlobalId - the modified app model global ID