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:

ContextEnabled, Mojo

@Mojo(name="copy-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=PROCESS_SOURCES)
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 1367274 2012-07-30 20:32:05Z hboutemy $

Author:

Brian Fox

Field Summary

protected ArtifactInstaller	installer
protected ArtifactRepositoryFactory	repositoryFactory

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, outputAbsoluteArtifactFilename, project, reactorProjects, remoteRepos, resolver, silent

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

ROLE

Constructor Summary

CopyDependenciesMojo()

Method Summary

protected void	copyArtifact(Artifact artifact, boolean removeVersion, boolean prependGroupId) Copies the Artifact after building the destination file name if overridden.
void	copyPoms(File destDir, Set<Artifact> artifacts, boolean removeVersion) Copy the pom files associated with the artifacts.
void	execute() Main entry into mojo.
protected ArtifactsFilter	getMarkedArtifactFilter()
protected Artifact	getResolvedPomArtifact(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, getArchiverManager, getArtifactCollector, getArtifactMetadataSource, getFactory, getLocal, getLog, getProject, getRemoteRepos, getResolver, setArchiverManager, setArtifactCollector, setArtifactMetadataSource, setFactory, setLocal, setRemoteRepos, setResolver, 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 ArtifactInstaller installer

repositoryFactory

@Component
protected ArtifactRepositoryFactory repositoryFactory

Constructor Detail

CopyDependenciesMojo

public CopyDependenciesMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException

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

Throws:

MojoExecutionException - with a message if an error occurs.

See Also:

#getDependencies, #copyArtifact(Artifact, boolean)

copyArtifact

protected void copyArtifact(Artifact artifact,
                            boolean removeVersion,
                            boolean prependGroupId)
                     throws 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.

Throws:

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<Artifact> artifacts,
                     boolean removeVersion)
              throws MojoExecutionException

Copy the pom files associated with the artifacts.

Throws:

MojoExecutionException

getResolvedPomArtifact

protected Artifact getResolvedPomArtifact(Artifact artifact)

getMarkedArtifactFilter

protected ArtifactsFilter getMarkedArtifactFilter()

Specified by:

getMarkedArtifactFilter in class AbstractDependencyFilterMojo