org.azyva.dragom.model.plugin.impl

Class MavenBuilderPluginImpl

java.lang.Object

org.azyva.dragom.model.plugin.impl.NodePluginAbstractImpl

org.azyva.dragom.model.plugin.impl.ModulePluginAbstractImpl

org.azyva.dragom.model.plugin.impl.MavenBuilderPluginImpl

All Implemented Interfaces:

org.azyva.dragom.model.plugin.BuilderPlugin, org.azyva.dragom.model.plugin.ModulePlugin, org.azyva.dragom.model.plugin.NodePlugin

public class MavenBuilderPluginImpl
extends ModulePluginAbstractImpl
implements org.azyva.dragom.model.plugin.BuilderPlugin

BuilderPlugin that supports Maven.

This plugin uses many properties to build the command line for invoking Maven. Although many such properties are generally expected to be defined at the Model level, most, if not all, of them can be overridden at many levels so they are accessed as runtime properties using RuntimePropertiesPlugin.

Also, many properties can also be overridden by Module instances checked out from the SCM, allowing the definition of Module's, including how to build them, to be self-contained. Such properties are read from an optional dragom.properties file at the root of the workspace directory for for the Module.

This implementation interprets the build context passed to the build(java.nio.file.Path, java.lang.String, java.io.Writer) method as a comma-separated list of Maven profiles that are passed to Maven. These profiles are combined with those specified by the MAVEN_PROFILES runtime property.

This implementation does not support user input during the build process.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
MavenBuilderPluginImpl(org.azyva.dragom.model.Module module) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	build(Path pathModuleWorkspace, String buildContext, Writer writerLog)
boolean	clean(Path pathModuleWorkspace, Writer writerLog)
boolean	invokeMaven(Path pathModuleWorkspace, String buildContext, Writer writerLog, boolean indCleanOnly) Main method that invokes Maven either for building or cleaning.
boolean	isCleanSupported()
boolean	isSomethingToBuild(Path pathModuleWorkspace)
boolean	isSomethingToClean(Path pathModuleWorkspace)

Methods inherited from class org.azyva.dragom.model.plugin.impl.ModulePluginAbstractImpl

getModule, toString

Methods inherited from class org.azyva.dragom.model.plugin.impl.NodePluginAbstractImpl

getNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.azyva.dragom.model.plugin.ModulePlugin

getModule

Methods inherited from interface org.azyva.dragom.model.plugin.NodePlugin

getNode

Constructor Detail

MavenBuilderPluginImpl

public MavenBuilderPluginImpl(org.azyva.dragom.model.Module module)

Constructor.

This constructor is trivial since all properties are accessed as runtime properties.

Parameters:

module - Module.

Method Detail

isSomethingToBuild

public boolean isSomethingToBuild(Path pathModuleWorkspace)

Specified by:

isSomethingToBuild in interface org.azyva.dragom.model.plugin.BuilderPlugin

Returns:

true since Maven does not really implement build avoidance aka incremental builds. Individual Maven plugins (e.g., Java compiler) can/may be optimized in this regard, but the knowledge of whether there is actually something to build is kept within each such plugins, and not exposed to the outside world (the one who invokes Maven). Therefore from the point of view of this plugin implementation, there is always something to build.

build

public boolean build(Path pathModuleWorkspace,
                     String buildContext,
                     Writer writerLog)

Specified by:

build in interface org.azyva.dragom.model.plugin.BuilderPlugin

isCleanSupported

public boolean isCleanSupported()

Specified by:

isCleanSupported in interface org.azyva.dragom.model.plugin.BuilderPlugin

Returns:

true since Maven builds always generate files that can be cleaned.

isSomethingToClean

public boolean isSomethingToClean(Path pathModuleWorkspace)

Specified by:

isSomethingToClean in interface org.azyva.dragom.model.plugin.BuilderPlugin

Returns:

true since it is hard to tell from the outside world (the one who invokes Maven) whether or not there is actually something to clean. It may actually be possible since generally Maven stores all generated files in a target sub-directory of each module and submodule, but for now we consider it is not worth trying to make that optimization.

clean

public boolean clean(Path pathModuleWorkspace,
                     Writer writerLog)

Specified by:

clean in interface org.azyva.dragom.model.plugin.BuilderPlugin

invokeMaven

public boolean invokeMaven(Path pathModuleWorkspace,
                           String buildContext,
                           Writer writerLog,
                           boolean indCleanOnly)

Main method that invokes Maven either for building or cleaning.

For we invoke Maven in nearly the same way given the runtime properties, whether we are building or cleaning, hence the factoring of the code in a single method.

Parameters:

pathModuleWorkspace - Path to the Module within the workspace.

buildContext - Build context.

writerLog - Writer where the log of the build or clean process can be written. Can be null if the caller is not interested in the log.

indCleanOnly - Indicates to clean only.

Returns:

Indicates if the build or clean process was successful.