org.apache.maven.plugin.cxx

Class ScmDependenciesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.dependency.AbstractDependencyMojo

org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

org.apache.maven.plugin.cxx.ScmDependenciesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="scm-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=VALIDATE,
      threadSafe=true)
public class ScmDependenciesMojo
extends org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

Goal that retrieve source dependencies from the SCM.

Since:

0.0.6

Author:

Franck Bonin

Field Summary

Fields

Modifier and Type	Field and Description
protected File	basedir Pom directory location
protected String	connectionType SCM connection information to use
protected String	excludeRegexClassifiers Comma Separated list of Classifiers to exclude.
protected String	includeRegexClassifiers Comma Separated list of Classifiers to include.
protected boolean	sourceFreezeRevision svn:externals shall use precise svn revisions retrieved from scm info at execution time
protected String	sourceSubdir Optional source dependencies sub-directory holder
protected String[]	sourceTargetDirRemovePrefixes List of String prefix to remove when creating dependencies target dirs Example : <sourceTargetDirRemovePrefixes> <sourceRemoveTargetPrefixe>fr/neticoa</sourceRemoveTargetPrefixe> <sourceRemoveTargetPrefixe>module</sourceRemoveTargetPrefixe> </sourceTargetDirRemovePrefixes>

Fields inherited from class org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

classifier, excludeArtifactIds, excludeClassifiers, excludeGroupIds, excludeScope, excludeTransitive, excludeTypes, includeArtifactIds, includeClassifiers, includeGroupIds, includeScope, includeTypes, markersDirectory, overWriteIfNewer, overWriteReleases, overWriteSnapshots, prependGroupId, type

Fields inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo

archiverManager, artifactCollector, artifactMetadataSource, factory, ignorePermissions, outputAbsoluteArtifactFilename, project, reactorProjects, remoteRepos, resolver, silent, useJvmChmod

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ScmDependenciesMojo()

Method Summary

Modifier and Type	Method and Description
String	artifactToString(org.apache.maven.artifact.Artifact artifact)
protected void	doExecute()
protected org.apache.maven.plugin.dependency.utils.DependencyStatusSets	getDependencySets(boolean stopOnFailure, boolean includeParents) Method creates filters and filters the projects dependencies.
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter	getMarkedArtifactFilter() origin : derived from org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo $FB duplicate with UnPackDependenciesMojo

Methods inherited from class org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

filterMarkedDependencies, getClassifierTranslatedDependencies, getDependencySets, getMarkersDirectory, getResolvedDependencies, isPrependGroupId, setMarkersDirectory, setPrependGroupId

Methods inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo

copyFile, execute, getArchiverManager, getArtifactCollector, getArtifactMetadataSource, getFactory, getLocal, getLog, getProject, getRemoteRepos, getResolver, isSkip, isUseJvmChmod, setArchiverManager, setArtifactCollector, setArtifactMetadataSource, setFactory, setLocal, setRemoteRepos, setResolver, setSkip, setUseJvmChmod, unpack, unpack

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

basedir

@Parameter(property="basedir",
           readonly=true,
           required=true)
protected File basedir

Pom directory location

Since:

0.0.6

sourceSubdir

@Parameter(property="sourceSubdir",
           defaultValue=".")
protected String sourceSubdir

Optional source dependencies sub-directory holder

Since:

0.0.6

sourceFreezeRevision

@Parameter(property="sourceFreezeRevision",
           defaultValue="false")
protected boolean sourceFreezeRevision

svn:externals shall use precise svn revisions retrieved from scm info at execution time

Since:

0.0.6

sourceTargetDirRemovePrefixes

@Parameter
protected String[] sourceTargetDirRemovePrefixes

List of String prefix to remove when creating dependencies target dirs Example :

<sourceTargetDirRemovePrefixes>
  <sourceRemoveTargetPrefixe>fr/neticoa</sourceRemoveTargetPrefixe>
  <sourceRemoveTargetPrefixe>module</sourceRemoveTargetPrefixe>
</sourceTargetDirRemovePrefixes>

Since:

0.0.6

includeRegexClassifiers

@Parameter(property="includeRegexClassifiers",
           defaultValue="")
protected String includeRegexClassifiers

Comma Separated list of Classifiers to include. Empty String indicates include everything (default).

Since:

0.0.6

excludeRegexClassifiers

@Parameter(property="excludeRegexClassifiers",
           defaultValue="")
protected String excludeRegexClassifiers

Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).

Since:

0.0.6

connectionType

@Parameter(property="connectionType",
           defaultValue="connection")
protected String connectionType

SCM connection information to use

Since:

0.0.6

Constructor Detail

ScmDependenciesMojo

public ScmDependenciesMojo()

Method Detail

getMarkedArtifactFilter

protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter getMarkedArtifactFilter()

origin : derived from org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo $FB duplicate with UnPackDependenciesMojo

Specified by:

getMarkedArtifactFilter in class org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

getDependencySets

protected org.apache.maven.plugin.dependency.utils.DependencyStatusSets getDependencySets(boolean stopOnFailure,
                                                                                          boolean includeParents)
                                                                                   throws org.apache.maven.plugin.MojoExecutionException

Method creates filters and filters the projects dependencies. This method also transforms the dependencies if classifier is set. The dependencies are filtered in least specific to most specific order origin : derived from org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

Overrides:

getDependencySets in class org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo

Parameters:

stopOnFailure -

Returns:

DependencyStatusSets - Bean of TreeSets that contains information on the projects dependencies

Throws:

org.apache.maven.plugin.MojoExecutionException

artifactToString

public String artifactToString(org.apache.maven.artifact.Artifact artifact)

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException

Specified by:

doExecute in class org.apache.maven.plugin.dependency.AbstractDependencyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException