org.apache.maven.plugin.cxx

Class UnpackDependenciesMojo

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.dependency.fromDependencies.AbstractFromDependenciesMojo

org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo

org.apache.maven.plugin.cxx.UnpackDependenciesMojo

All Implemented Interfaces:

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

@Mojo(name="unpack-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=PROCESS_SOURCES,
      threadSafe=true)
public class UnpackDependenciesMojo
extends org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo

Goal that unpacks the project dependencies from the repository to a defined location.

Since:

0.0.6

Author:

Brian Fox, Franck Bonin

Field Summary

Fields

Modifier and Type	Field and Description
protected ArchiveContentListerManager	archiveContentListerManager To look up ArchiveContentLister implementations origin : org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo
protected String	excludeRegexClassifiers Comma Separated list of Classifiers to exclude.
protected List	flattenDestDirs Directory where dependencies shall be flattened
protected String	includeRegexClassifiers Comma Separated list of Classifiers to include.

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

failOnMissingClassifierArtifact, outputDirectory, stripClassifier, stripVersion, useRepositoryLayout, useSubDirectoryPerArtifact, useSubDirectoryPerScope, useSubDirectoryPerType

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
UnpackDependenciesMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doExecute() Main entry into mojo.
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()
protected void	listAndFlatCopy(org.apache.maven.artifact.Artifact artifact, File srcRoot, File location, String includes, String excludes) flat copy the archive content.

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

getExcludes, getIncludes, setExcludes, setIncludes

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

getOutputDirectory, isFailOnMissingClassifierArtifact, isStripVersion, isUseRepositoryLayout, isUseSubDirectoryPerArtifact, isUseSubDirectoryPerScope, isUseSubDirectoryPerType, setFailOnMissingClassifierArtifact, setOutputDirectory, setStripVersion, setUseRepositoryLayout, setUseSubDirectoryPerArtifact, setUseSubDirectoryPerScope, setUseSubDirectoryPerType

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

archiveContentListerManager

@Component
protected ArchiveContentListerManager archiveContentListerManager

To look up ArchiveContentLister implementations origin : org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo

flattenDestDirs

@Parameter(property="mdep.unpack.flattenDestDirs")
protected List flattenDestDirs

Directory where dependencies shall be flattened

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

Constructor Detail

UnpackDependenciesMojo

public UnpackDependenciesMojo()

Method Detail

listAndFlatCopy

protected void listAndFlatCopy(org.apache.maven.artifact.Artifact artifact,
                               File srcRoot,
                               File location,
                               String includes,
                               String excludes)
                        throws org.apache.maven.plugin.MojoExecutionException

flat copy the archive content. origin : derived from org.apache.maven.plugin.dependency.AbstractDependencyMojo::unpack()

Parameters:

artifact - File to be unpacked.

srcRoot - Location where the whole archive was unpacked.

location - Location where to put the unpacked files.

includes - Comma separated list of file patterns to include i.e. **/.xml, **/*.properties

excludes - Comma separated list of file patterns to exclude i.e. **/*.xml, **/*.properties

Throws:

org.apache.maven.plugin.MojoExecutionException

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

doExecute

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

Main entry into mojo. This method gets the dependencies and iterates through each one passing it to DependencyUtil.unpackFile(). origin : derived from org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo

Overrides:

doExecute in class org.apache.maven.plugin.dependency.fromDependencies.UnpackDependenciesMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs.

See Also:

getDependencySets(boolean, boolean), AbstractDependencyMojo.unpack(org.apache.maven.artifact.Artifact, java.io.File), listAndFlatCopy(org.apache.maven.artifact.Artifact, java.io.File, java.io.File, java.lang.String, java.lang.String)

getMarkedArtifactFilter

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

Overrides:

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