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

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 1081021 2011-03-13 00:17:39Z hboutemy $

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

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

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) Copies the Artifact after building the destination file name if overridden.
void	copyPoms(java.io.File destDir, java.util.Set<org.apache.maven.artifact.Artifact> artifacts, boolean removeVersion) Copy the pom files associated with the artifacts.
void	execute() Main entry into mojo.
protected org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter	getMarkedArtifactFilter()
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, 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

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

repositoryFactory

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

Constructor Detail

CopyDependenciesMojo

public CopyDependenciesMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

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

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)
                     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.

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(java.io.File destDir,
            java.util.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()

Specified by:

getMarkedArtifactFilter in class AbstractDependencyFilterMojo