Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.dependency.fromDependencies
Class CopyDependenciesMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.dependency.AbstractDependencyMojo
          extended by org.apache.maven.plugin.dependency.fromDependencies.AbstractDependencyFilterMojo
              extended by org.apache.maven.plugin.dependency.fromDependencies.AbstractFromDependenciesMojo
                  extended by org.apache.maven.plugin.dependency.fromDependencies.CopyDependenciesMojo
All Implemented Interfaces:
ContextEnabled, 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.html 862013 2013-05-14 22:24:45Z hboutemy $
Author:
Brian Fox

Field Summary
protected  boolean addParentPoms
          Add parent poms to the list of copied dependencies (both current project pom parents and dependencies parents).
protected  boolean copyPom
          Also copy the pom of each artifact.
protected  boolean ignorePermissions
          not used in this goal
protected  ArtifactInstaller installer
           
protected  ArtifactRepositoryFactory repositoryFactory
           
protected  boolean useBaseVersion
          Either append the artifact's baseVersion or uniqueVersion to the filename.
protected  boolean useJvmChmod
          not used in this goal
 
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, 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, boolean useBaseVersion)
          Copies the Artifact after building the destination file name if overridden.
protected  void copyArtifact(Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion, boolean removeClassifier)
          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 copyPoms(File destDir, Set<Artifact> artifacts, boolean removeVersion, boolean removeClassifier)
          Copy the pom files associated with the artifacts.
protected  void doExecute()
          Main entry into mojo.
protected  ArtifactsFilter getMarkedArtifactFilter()
          Return an ArtifactsFilter indicating which artifacts must be filtered out.
protected  Artifact getResolvedPomArtifact(Artifact artifact)
           
 boolean isCopyPom()
           
 void setCopyPom(boolean copyPom)
           
 
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, 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

copyPom

@Parameter(property="mdep.copyPom",
           defaultValue="false")
protected boolean copyPom
Also copy the pom of each artifact.

Since:
2.0

installer

@Component
protected ArtifactInstaller installer

repositoryFactory

@Component
protected 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

addParentPoms

@Parameter(defaultValue="false")
protected boolean addParentPoms
Add parent poms to the list of copied dependencies (both current project pom parents and dependencies parents).

Since:
2.8

useJvmChmod

@Parameter
protected boolean useJvmChmod
not used in this goal

ignorePermissions

@Parameter
protected boolean ignorePermissions
not used in this goal

Constructor Detail

CopyDependenciesMojo

public CopyDependenciesMojo()
Method Detail

doExecute

protected void doExecute()
                  throws MojoExecutionException
Main entry into mojo. Gets the list of dependencies and iterates through calling copyArtifact.

Specified by:
doExecute in class AbstractDependencyMojo
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,
                            boolean useBaseVersion)
                     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.
useBaseVersion - specifies if the baseVersion of the artifact should be used instead of the version.
Throws:
MojoExecutionException - with a message if an error occurs.
See Also:
DependencyUtil#copyFile(File, File, Log), DependencyUtil.getFormattedFileName(Artifact, boolean)

copyArtifact

protected void copyArtifact(Artifact artifact,
                            boolean removeVersion,
                            boolean prependGroupId,
                            boolean useBaseVersion,
                            boolean removeClassifier)
                     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.
useBaseVersion - specifies if the baseVersion of the artifact should be used instead of the version.
removeClassifier - specifies if the classifier should be removed from the file name when 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

copyPoms

public void copyPoms(File destDir,
                     Set<Artifact> artifacts,
                     boolean removeVersion,
                     boolean removeClassifier)
              throws MojoExecutionException
Copy the pom files associated with the artifacts.

Throws:
MojoExecutionException

getResolvedPomArtifact

protected Artifact getResolvedPomArtifact(Artifact artifact)

getMarkedArtifactFilter

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

isCopyPom

public boolean isCopyPom()
Returns:
true, if the pom of each artifact must be copied

setCopyPom

public void setCopyPom(boolean copyPom)
Parameters:
copyPom - - true if the pom of each artifact must be copied
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002-2013 The Apache Software Foundation. All Rights Reserved.