org.azyva.dragom.job

Class RootModuleVersionJobAbstractImpl

java.lang.Object

org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

Direct Known Subclasses:

Build, BuildReferenceGraph, BuildRemote, ChangeReferenceToModuleVersion, Checkout, MergeMain, MergeReferenceGraph, ReferenceGraphReport, Release, SetupJenkinsJobs, SwitchToDynamicVersion

public abstract class RootModuleVersionJobAbstractImpl
extends Object

Base class for implementing jobs based on root ModuleVersion's and which traverse the reference graph by checking out the ModuleVersion source code and using ReferenceManagerPlugin and other (@link NodePlugin}'s to obtain Reference's.

It factors out code that is often encountered in these types of tasks.

After validating the root ModuleVersion's, it iterates over them. For each ModuleVersion it calls visitModuleVersion(org.azyva.dragom.reference.Reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version>).

This class does not attempt to completely encapsulate its implementation. It has protected instance variables available to subclasses to simplify implementation.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior Possible behaviors related to unsynchronized changes in a user working directory.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	indAvoidReentry Indicates that visitModuleVersion(org.azyva.dragom.reference.Reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version>) avoids reentry by using ModuleReentryAvoider.
protected boolean	indDepthFirst Indicates that traversal must be depth first, as opposed to parent first.
protected boolean	indHandleDynamicVersion Indicates that dynamic Version's must be considered during the traversal of the reference graphs.
protected boolean	indHandleStaticVersion Indicates that static Version's must be considered during the traversal of the reference graphs.
protected boolean	indListModuleVersionRootChanged Indicates that the List of root ModuleVersion passed to the constructor was changed and should be saved by the caller if persisted.
protected List<String>	listActionsPerformed Used to accumulate a description for the actions performed.
protected List<org.azyva.dragom.model.ModuleVersion>	listModuleVersionRoot List root ModuleVersion's on which to initiate the traversal of the reference graphs.
protected ModuleReentryAvoider	moduleReentryAvoider ModuleReentryAvoider.
protected static String	MSG_PATTERN_KEY_ACTIONS_PERFORMED See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_CANNOT_PROCEED_WITH_UNSYNC_LOCAL_CHANGES See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_CONFLICTS_WHILE_UPDATING See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_DO_YOU_WANT_TO_UPDATE_UNSYNC_REMOTE_CHANGES See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_INITIATING_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_MODULE_VERSION_ALREADY_PROCESSED See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_MULTIPLE_WORKSPACE_DIRECTORIES_FOR_MODULE See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_NO_ACTIONS_PERFORMED See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_ROOT_MODULE_VERSION_NOT_KNOWN See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION_COMPLETED See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_UPDATE_CHANGED_ROOT_MODULE_VERSION See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_DEFAULT See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_WORKSPACE_DIRECTORY_VERSION See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_UPDATING See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_VISITING_LEAF_MODULE_VERSION See description in ResourceBundle.
protected static String	MSG_PATTERN_KEY_VISITING_LEAF_REFERENCE_MATCHED See description in ResourceBundle.
protected org.azyva.dragom.reference.ReferencePath	referencePath Subclasses can use this variable during the traversal of a reference graph to maintain the current ReferencePath being visited.
protected static ResourceBundle	resourceBundle ResourceBundle specific to this class.
protected static String	RUNTIME_PROPERTY_PROJECT_CODE Runtime property specifying a project code which many job honour when traversing ReferenceGraph's.
protected static String	RUNTIME_PROPERTY_SYNC_WORKSPACE_DIR Runtime property of the type AlwaysNeverYesNoAskUserResponse indicating whether to synchronize the workspace directory when unsynced remote changes exist.
protected RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior	unsyncChangesBehaviorLocal Specifies the behavior related to unsynchronized local changes.
protected RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior	unsyncChangesBehaviorRemote Specifies the behavior related to unsynchronized remote changes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RootModuleVersionJobAbstractImpl(List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	afterIterateListModuleVersionRoot() Called by performJob().
protected void	beforeIterateListModuleVersionRoot() Called by performJob().
protected void	beforeValidateListModuleVersionRoot() Called by performJob().
protected String	getProjectCode()
protected org.azyva.dragom.reference.ReferencePathMatcher	getReferencePathMatcher()
boolean	isListModuleVersionRootChanged()
protected void	iterateListModuleVersionRoot() Called by performJob() to iterate through the List of root ModuleVersion's calling visitModuleVersion for each root ModuleVersion.
void	performJob() Main method for performing the job.
protected void	setIndAvoidReentry(boolean indAvoidReentry)
protected void	setIndDepthFirst(boolean indDepthFirst)
protected void	setIndHandleDynamicVersion(boolean indHandleDynamicVersion)
protected void	setIndHandleStaticVersion(boolean indHandleStaticVersion)
protected void	setIndListModuleVersionRootChanged() Called by methods of this class or subclasses to indicate that the List of root ModuleVersion passed to the constructor was changed and should be saved by the caller if persisted.
void	setReferencePathMatcherProvided(org.azyva.dragom.reference.ReferencePathMatcher referencePathMatcherProvided) Sets the ReferencePathMatcher profided by the caller defining on which ModuleVersion's in the reference graphs the job will be applied.
void	setUnsyncChangesBehaviorLocal(RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorLocal)
void	setUnsyncChangesBehaviorRemote(RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorRemote)
protected void	setupReferencePathMatcherForProjectCode() Setup the ReferencePathMatcher so that only ModuleVersion's having the Version attribute dragom-project-code equal to that defined by the runtime property PROJECT_CODE are matched.
protected void	validateListModuleVersionRoot() Called by performJob() to validate the root ModuleVersion's.
protected boolean	visitMatchedModuleVersion(org.azyva.dragom.reference.Reference reference) Called by visitModuleVersion(org.azyva.dragom.reference.Reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version>) for each matched ModuleVersion.
protected boolean	visitModuleVersion(org.azyva.dragom.reference.Reference reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version> byReferenceVersion) This method is called for each root ModuleVersion.

Methods inherited from class java.lang.Object

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

Field Detail

RUNTIME_PROPERTY_SYNC_WORKSPACE_DIR

protected static final String RUNTIME_PROPERTY_SYNC_WORKSPACE_DIR

Runtime property of the type AlwaysNeverYesNoAskUserResponse indicating whether to synchronize the workspace directory when unsynced remote changes exist.

See Also:

Constant Field Values

RUNTIME_PROPERTY_PROJECT_CODE

protected static final String RUNTIME_PROPERTY_PROJECT_CODE

Runtime property specifying a project code which many job honour when traversing ReferenceGraph's.

This provides a matching mechanism for ModuleVersion's within a ReferenceGraph. It also has impacts on Version creations.

The idea is that in some cases, Dragom will be used to manage ReferenceGraph's in the context of a project, in the sense of a time-constrained development effort. When switching to dynamic Version's of Module's, (@link SwitchToDynamicVesion} can optionnally specify a project code as a Version attribute for newly created dynamic Versions. Similarly with Release for static Versions. And for may other jobs which traverse a ReferenceGraph (Checkout, MergeMain, etc.), this same project code specified by this runtime property is used for matching ModuleVersion's based on their Version's project code attribute, in addition to the matching performed by ReferencePathMatcher's (implied "and").

Accessed on the root ClassificationNode.

See Also:

Constant Field Values

MSG_PATTERN_KEY_ROOT_MODULE_VERSION_NOT_KNOWN

protected static final String MSG_PATTERN_KEY_ROOT_MODULE_VERSION_NOT_KNOWN

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_MULTIPLE_WORKSPACE_DIRECTORIES_FOR_MODULE

protected static final String MSG_PATTERN_KEY_MULTIPLE_WORKSPACE_DIRECTORIES_FOR_MODULE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_WORKSPACE_DIRECTORY_VERSION

protected static final String MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_WORKSPACE_DIRECTORY_VERSION

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_DEFAULT

protected static final String MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_DEFAULT

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST

protected static final String MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_INITIATING_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION

protected static final String MSG_PATTERN_KEY_INITIATING_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION_COMPLETED

protected static final String MSG_PATTERN_KEY_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION_COMPLETED

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_UPDATE_CHANGED_ROOT_MODULE_VERSION

protected static final String MSG_PATTERN_KEY_UPDATE_CHANGED_ROOT_MODULE_VERSION

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VISITING_LEAF_MODULE_VERSION

protected static final String MSG_PATTERN_KEY_VISITING_LEAF_MODULE_VERSION

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_CANNOT_PROCEED_WITH_UNSYNC_LOCAL_CHANGES

protected static final String MSG_PATTERN_KEY_CANNOT_PROCEED_WITH_UNSYNC_LOCAL_CHANGES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_DO_YOU_WANT_TO_UPDATE_UNSYNC_REMOTE_CHANGES

protected static final String MSG_PATTERN_KEY_DO_YOU_WANT_TO_UPDATE_UNSYNC_REMOTE_CHANGES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_UPDATING

protected static final String MSG_PATTERN_KEY_UPDATING

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_CONFLICTS_WHILE_UPDATING

protected static final String MSG_PATTERN_KEY_CONFLICTS_WHILE_UPDATING

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VISITING_LEAF_REFERENCE_MATCHED

protected static final String MSG_PATTERN_KEY_VISITING_LEAF_REFERENCE_MATCHED

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_MODULE_VERSION_ALREADY_PROCESSED

protected static final String MSG_PATTERN_KEY_MODULE_VERSION_ALREADY_PROCESSED

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_ACTIONS_PERFORMED

protected static final String MSG_PATTERN_KEY_ACTIONS_PERFORMED

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_NO_ACTIONS_PERFORMED

protected static final String MSG_PATTERN_KEY_NO_ACTIONS_PERFORMED

See description in ResourceBundle.

See Also:

Constant Field Values

resourceBundle

protected static final ResourceBundle resourceBundle

ResourceBundle specific to this class.

listModuleVersionRoot

protected List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot

List root ModuleVersion's on which to initiate the traversal of the reference graphs.

indHandleDynamicVersion

protected boolean indHandleDynamicVersion

Indicates that dynamic Version's must be considered during the traversal of the reference graphs. The default value is true.

indHandleStaticVersion

protected boolean indHandleStaticVersion

Indicates that static Version's must be considered during the traversal of the reference graphs. The default value is true.

indAvoidReentry

protected boolean indAvoidReentry

Indicates that visitModuleVersion(org.azyva.dragom.reference.Reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version>) avoids reentry by using ModuleReentryAvoider. The default value is true.

indDepthFirst

protected boolean indDepthFirst

Indicates that traversal must be depth first, as opposed to parent first.

unsyncChangesBehaviorLocal

protected RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorLocal

Specifies the behavior related to unsynchronized local changes.

unsyncChangesBehaviorRemote

protected RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorRemote

Specifies the behavior related to unsynchronized remote changes.

moduleReentryAvoider

protected ModuleReentryAvoider moduleReentryAvoider

ModuleReentryAvoider.

Used by this class when matching ReferencePath if indAvoidReentry. Available to subclasses as well independently of indAvoidReentry.

referencePath

protected org.azyva.dragom.reference.ReferencePath referencePath

Subclasses can use this variable during the traversal of a reference graph to maintain the current ReferencePath being visited. Upon entry in a method that visits a ModuleVersion, this variable represents the ReferencePath of the parent. During processing it is modified to represent the ReferencePath of the current ModuleVersion and referenced modules as the graph is traversed. Upon exit it is reset to what it was upon entry. This is used mainly in messages since it is useful for the user to know from which Reference a ModuleVersion within a ReferencePath comes from. A root ModuleVersion is wrapped in a Reference.

listActionsPerformed

protected List<String> listActionsPerformed

Used to accumulate a description for the actions performed.

indListModuleVersionRootChanged

protected boolean indListModuleVersionRootChanged

Indicates that the List of root ModuleVersion passed to the constructor was changed and should be saved by the caller if persisted.

Constructor Detail

RootModuleVersionJobAbstractImpl

protected RootModuleVersionJobAbstractImpl(List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot)

Constructor.

Parameters:

listModuleVersionRoot - List of root ModuleVersion's on which to initiate the traversal of the reference graphs.

Method Detail

setReferencePathMatcherProvided

public void setReferencePathMatcherProvided(org.azyva.dragom.reference.ReferencePathMatcher referencePathMatcherProvided)

Sets the ReferencePathMatcher profided by the caller defining on which ModuleVersion's in the reference graphs the job will be applied.

Parameters:

referencePathMatcherProvided - See description.

getProjectCode

protected String getProjectCode()

Returns:

The project code specified by the user with the PROJECT_CODE runtime property.

setupReferencePathMatcherForProjectCode

protected void setupReferencePathMatcherForProjectCode()

Setup the ReferencePathMatcher so that only ModuleVersion's having the Version attribute dragom-project-code equal to that defined by the runtime property PROJECT_CODE are matched.

getReferencePathMatcher

protected org.azyva.dragom.reference.ReferencePathMatcher getReferencePathMatcher()

Returns:

ReferencePathMatcher to use for matching the ReferencePath's. "and" combination of the ReferencePathMatcher provided with setReferencePathMatcherProvided(org.azyva.dragom.reference.ReferencePathMatcher) and that setup by setupReferencePathMatcherForProjectCode().

setIndHandleDynamicVersion

protected void setIndHandleDynamicVersion(boolean indHandleDynamicVersion)

Parameters:

indHandleDynamicVersion - Specifies to handle or not dynamic Version's. The default is to handle dynamic Version.

setIndHandleStaticVersion

protected void setIndHandleStaticVersion(boolean indHandleStaticVersion)

Parameters:

indHandleStaticVersion - Specifies to handle or not static Version's. The default is to handle static Version.

setIndAvoidReentry

protected void setIndAvoidReentry(boolean indAvoidReentry)

Parameters:

indAvoidReentry - Specifies to avoid reentry by using ModuleReentryAvoider. The default is to avoid reentry.

setIndDepthFirst

protected void setIndDepthFirst(boolean indDepthFirst)

Parameters:

indDepthFirst - Specifies to traverse depth first. The default is to traverse parent-first.

setUnsyncChangesBehaviorLocal

public void setUnsyncChangesBehaviorLocal(RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorLocal)

Parameters:

unsyncChangesBehaviorLocal - Behavior related to unsynchronized local changes. The default is RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior.DO_NOT_HANDLE.

setUnsyncChangesBehaviorRemote

public void setUnsyncChangesBehaviorRemote(RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior unsyncChangesBehaviorRemote)

Parameters:

unsyncChangesBehaviorRemote - Behavior related to unsynchronized remote changes. The default is RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior.DO_NOT_HANDLE.

setIndListModuleVersionRootChanged

protected void setIndListModuleVersionRootChanged()

Called by methods of this class or subclasses to indicate that the List of root ModuleVersion passed to the constructor was changed and should be saved by the caller if persisted.

isListModuleVersionRootChanged

public boolean isListModuleVersionRootChanged()

Returns:

Indicate that the List of root ModuleVersion passed to the constructor was changed and should be saved by the caller if persisted.

performJob

public void performJob()

Main method for performing the job.

This class provides a default implementation which calls beforeValidateListModuleVersionRoot(), validateListModuleVersionRoot(), beforeIterateListModuleVersionRoot(), afterIterateListModuleVersionRoot(). If ever this behavior is not appropriate for the job, subclasses can simply override the method. Alternatively, the methods mentioned above can be overridden individually.

beforeValidateListModuleVersionRoot

protected void beforeValidateListModuleVersionRoot()

Called by performJob(). Subclasses can override to introduce job-specific behavior.

This implementation does nothing.

validateListModuleVersionRoot

protected void validateListModuleVersionRoot()

Called by performJob() to validate the root ModuleVersion's.

This performs a first pass to validate the root ModuleVersion's. The reason is that if one ModuleVersion is invalid (module not known to the model or Version does not exist), many actions may have already been performed and it is better for the user to detect the error before doing anything.

beforeIterateListModuleVersionRoot

protected void beforeIterateListModuleVersionRoot()

Called by performJob(). Subclasses can override to introduce job-specific behavior.

This implementation does nothing.

iterateListModuleVersionRoot

protected void iterateListModuleVersionRoot()

Called by performJob() to iterate through the List of root ModuleVersion's calling visitModuleVersion for each root ModuleVersion.

visitModuleVersion

protected boolean visitModuleVersion(org.azyva.dragom.reference.Reference reference,
                                     org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version> byReferenceVersion)

This method is called for each root ModuleVersion. Subclasses can override it to provide a job-specific behavior at the root ModuleVersion level.

It could have been called visitRootModuleVersion to make more obvious the context in which is it called, but it is expected to often be called recursively by itself for the Reference's within the reference graph, which this implementation actually does.

This implementation does a traversal of the reference graph rooted at the root ModuleVersion by recursively invoking itself and for each ModuleVersion matching the ReferencePathMatcher provided to the class using setReferencePathMatcherProvided(org.azyva.dragom.reference.ReferencePathMatcher), it calls visitMatchedModuleVersion(org.azyva.dragom.reference.Reference).

If indDepthFirst, the traversal is depth first. Otherwise it is parent first.

This implementation returns false as it does not handle Version changes.

Parameters:

reference - Root ModuleVersion passed as a Reference so that the initial parent element of the ReferencePath can be created.

byReferenceVersion - If the method returns true, contains the new Version of the root ModuleVersion.

Returns:

Indicates if the Version of the root ModuleVersion was changed and this change deserves to be reflected in the List of root ModuleVersion's provided by the caller.

visitMatchedModuleVersion

protected boolean visitMatchedModuleVersion(org.azyva.dragom.reference.Reference reference)

Called by visitModuleVersion(org.azyva.dragom.reference.Reference, org.azyva.dragom.apiutil.ByReference<org.azyva.dragom.model.Version>) for each matched ModuleVersion. Subclasses can override it to provide a job-specific behavior at the matched ModuleVersion level.

If the ReferencePathMatcher is such that a ModuleVeresion is matched and this method is called, it can signal the caller that children must not be visited by returning false. But if the ModuleVersion is not matched, this method is not called and children will be visited. In all cases, the ReferencePathMatcher will be applied to children as well. This applies only if the traversal is parent first.

This implementation raises an exception. This method is not abstract since if the subclass overrides visitModuleVersion, it may not be called or need to be overridden at all.

Parameters:

reference - Reference to the matched ModuleVersion.

Returns:

Indicates if children must be visited. The return value is ignore if the traversal is depth first.

afterIterateListModuleVersionRoot

protected void afterIterateListModuleVersionRoot()

Called by performJob(). Subclasses can override to introduce job-specific behavior.

This implementation does nothing.