org.apache.maven.plugins.dependency.fromConfiguration

Class CopyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromConfiguration.AbstractFromConfigurationMojo

org.apache.maven.plugins.dependency.fromConfiguration.CopyMojo

All Implemented Interfaces:

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

@Mojo(name="copy",
      defaultPhase=PROCESS_SOURCES,
      requiresProject=false,
      threadSafe=true)
public class CopyMojo
extends AbstractFromConfigurationMojo

Goal that copies a list of artifacts from the repository to defined locations.

Since:

1.0

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ignorePermissions not used in this goal

Fields inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

outputAbsoluteArtifactFilename, reactorProjects, session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CopyMojo()

Method Summary

Modifier and Type	Method and Description
protected void	copyArtifact(ArtifactItem artifactItem) Resolves the artifact from the repository and copies it to the specified location.
protected void	doExecute() Main entry into mojo.
protected ArtifactItemFilter	getMarkedArtifactFilter(ArtifactItem item)
boolean	isStripClassifier()
boolean	isStripVersion()
void	setStripClassifier(boolean stripClassifier)
void	setStripVersion(boolean stripVersion)
void	setUseBaseVersion(boolean useBaseVersion)

Methods inherited from class org.apache.maven.plugins.dependency.fromConfiguration.AbstractFromConfigurationMojo

getArtifact, getArtifactItems, getOutputDirectory, getProcessedArtifactItems, isOverWriteIfNewer, isOverWriteReleases, isOverWriteSnapshots, setArtifact, setArtifactItems, setLocalRepositoryDirectory, setOutputDirectory, setOverWriteIfNewer, setOverWriteReleases, setOverWriteSnapshots, verifyRequirements

Methods inherited from class org.apache.maven.plugins.dependency.AbstractDependencyMojo

copyFile, execute, getProject, isSilent, isSkip, newResolveArtifactProjectBuildingRequest, newResolvePluginProjectBuildingRequest, setSilent, setSkip

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ignorePermissions

@Parameter
protected boolean ignorePermissions

not used in this goal

Constructor Detail

CopyMojo

public CopyMojo()

Method Detail

doExecute

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

Main entry into mojo. This method gets the ArtifactItems and iterates through each one passing it to copyArtifact.

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

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

org.apache.maven.plugin.MojoFailureException - MojoFailureException

See Also:

ArtifactItem, AbstractFromConfigurationMojo.getArtifactItems(), copyArtifact(ArtifactItem)

copyArtifact

protected void copyArtifact(ArtifactItem artifactItem)
                     throws org.apache.maven.plugin.MojoExecutionException

Resolves the artifact from the repository and copies it to the specified location.

Parameters:

artifactItem - containing the information about the Artifact to copy.

Throws:

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

See Also:

AbstractDependencyMojo.copyFile(File, File)

getMarkedArtifactFilter

protected ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item)

isStripVersion

public boolean isStripVersion()

Returns:

Returns the stripVersion.

setStripVersion

public void setStripVersion(boolean stripVersion)

Parameters:

stripVersion - The stripVersion to set.

isStripClassifier

public boolean isStripClassifier()

Returns:

Returns the stripClassifier.

setStripClassifier

public void setStripClassifier(boolean stripClassifier)

Parameters:

stripClassifier - The stripClassifier to set.

setUseBaseVersion

public void setUseBaseVersion(boolean useBaseVersion)

Parameters:

useBaseVersion - The useBaseVersion to set.