org.apache.maven.plugin.dependency

Class CopyDependenciesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.dependency.AbstractDependencyMojo

org.apache.maven.plugin.dependency.AbstractDependencyFilterMojo

org.apache.maven.plugin.dependency.AbstractFromDependenciesMojo

org.apache.maven.plugin.dependency.CopyDependenciesMojo

All Implemented Interfaces:

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

@Mojo(name="copy-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=PROCESS_SOURCES,
      threadSafe=true)
public class CopyDependenciesMojo
extends AbstractFromDependenciesMojo

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

Since:

1.0

Version:

$Id: CopyDependenciesMojo.java 1451088 2013-02-28 04:22:41Z brianf $

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.installer.ArtifactInstaller	installer
protected org.apache.maven.artifact.repository.ArtifactRepositoryFactory	repositoryFactory
protected boolean	useBaseVersion Either append the artifact's baseVersion or uniqueVersion to the filename.

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

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

Fields inherited from class org.apache.maven.plugin.dependency.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
CopyDependenciesMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyArtifact(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion) Copies the Artifact after building the destination file name if overridden.
void	copyPoms(File destDir, Set<org.apache.maven.artifact.Artifact> artifacts, boolean removeVersion) Copy the pom files associated with the artifacts.
protected void	doExecute() Main entry into mojo.
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter	getMarkedArtifactFilter() Return an ArtifactsFilter indicating which artifacts must be filtered out.
protected org.apache.maven.artifact.Artifact	getResolvedPomArtifact(org.apache.maven.artifact.Artifact artifact)

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

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

Methods inherited from class org.apache.maven.plugin.dependency.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

installer

@Component
protected org.apache.maven.artifact.installer.ArtifactInstaller installer

repositoryFactory

@Component
protected org.apache.maven.artifact.repository.ArtifactRepositoryFactory repositoryFactory

useBaseVersion

@Parameter(property="mdep.useBaseVersion",
           defaultValue="true")
protected boolean useBaseVersion

Either append the artifact's baseVersion or uniqueVersion to the filename. Will only be used if AbstractFromDependenciesMojo.isStripVersion() is false.

Since:

2.6

Constructor Detail

CopyDependenciesMojo

public CopyDependenciesMojo()

Method Detail

doExecute

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

Main entry into mojo. Gets the list of dependencies and iterates through calling copyArtifact.

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

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

See Also:

#getDependencies, #copyArtifact(Artifact, boolean)

copyArtifact

protected void copyArtifact(org.apache.maven.artifact.Artifact artifact,
                boolean removeVersion,
                boolean prependGroupId,
                boolean useBaseVersion)
                     throws org.apache.maven.plugin.MojoExecutionException

Copies the Artifact after building the destination file name if overridden. This method also checks if the classifier is set and adds it to the destination file name if needed.

Parameters:

artifact - representing the object to be copied.

removeVersion - specifies if the version should be removed from the file name when copying.

prependGroupId - specifies if the groupId should be prepend to the file while copying.

useBaseVersion - specifies if the baseVersion of the artifact should be used instead of the version.

Throws:

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

See Also:

DependencyUtil#copyFile(File, File, Log), DependencyUtil.getFormattedFileName(Artifact, boolean)

copyPoms

public void copyPoms(File destDir,
            Set<org.apache.maven.artifact.Artifact> artifacts,
            boolean removeVersion)
              throws org.apache.maven.plugin.MojoExecutionException

Copy the pom files associated with the artifacts.

Throws:

org.apache.maven.plugin.MojoExecutionException

getResolvedPomArtifact

protected org.apache.maven.artifact.Artifact getResolvedPomArtifact(org.apache.maven.artifact.Artifact artifact)

getMarkedArtifactFilter

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

Description copied from class: AbstractDependencyFilterMojo

Return an ArtifactsFilter indicating which artifacts must be filtered out.

Specified by:

getMarkedArtifactFilter in class AbstractDependencyFilterMojo

Returns:

an ArtifactsFilter indicating which artifacts must be filtered out.