org.apache.maven.plugins.dependency

Class AbstractDependencyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AbstractDependencyFilterMojo, AbstractFromConfigurationMojo, ListRepositoriesMojo

public abstract class AbstractDependencyMojo
extends AbstractMojo

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	outputAbsoluteArtifactFilename Output absolute filename for resolved artifacts
protected List<MavenProject>	reactorProjects Contains the full list of projects in the reactor.
protected MavenSession	session The Maven session

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDependencyMojo()

Method Summary

Modifier and Type	Method and Description
protected void	copyFile(File artifact, File destFile) Does the actual copy of the file and logging.
protected abstract void	doExecute()
void	execute()
ArchiverManager	getArchiverManager()
MavenProject	getProject()
protected boolean	isSilent()
boolean	isSkip()
boolean	isUseJvmChmod()
ProjectBuildingRequest	newResolveArtifactProjectBuildingRequest()
protected ProjectBuildingRequest	newResolvePluginProjectBuildingRequest()
void	setArchiverManager(ArchiverManager archiverManager)
void	setSilent(boolean silent)
void	setSkip(boolean skip)
void	setUseJvmChmod(boolean useJvmChmod)
protected void	unpack(Artifact artifact, File location, String encoding, FileMapper[] fileMappers)
protected void	unpack(Artifact artifact, File location, String includes, String excludes, String encoding, FileMapper[] fileMappers) Unpacks the archive file.
protected void	unpack(Artifact artifact, String type, File location, String includes, String excludes, String encoding, FileMapper[] fileMappers)

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

reactorProjects

@Parameter(defaultValue="${reactorProjects}",
           readonly=true)
protected List<MavenProject> reactorProjects

Contains the full list of projects in the reactor.

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected MavenSession session

The Maven session

outputAbsoluteArtifactFilename

@Parameter(property="outputAbsoluteArtifactFilename",
           defaultValue="false")
protected boolean outputAbsoluteArtifactFilename

Output absolute filename for resolved artifacts

Since:

2.0

Constructor Detail

AbstractDependencyMojo

public AbstractDependencyMojo()

Method Detail

execute

public final void execute()
                   throws MojoExecutionException,
                          MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

doExecute

protected abstract void doExecute()
                           throws MojoExecutionException,
                                  MojoFailureException

Throws:

MojoExecutionException - MojoExecutionException

MojoFailureException - MojoFailureException

getArchiverManager

public ArchiverManager getArchiverManager()

Returns:

Returns the archiverManager.

copyFile

protected void copyFile(File artifact,
                        File destFile)
                 throws MojoExecutionException

Does the actual copy of the file and logging.

Parameters:

artifact - represents the file to copy.

destFile - file name of destination file.

Throws:

MojoExecutionException - with a message if an error occurs.

unpack

protected void unpack(Artifact artifact,
                      File location,
                      String encoding,
                      FileMapper[] fileMappers)
               throws MojoExecutionException

Parameters:

artifact - Artifact

location - The location.

encoding - The encoding.

fileMappers - FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.

Throws:

MojoExecutionException - in case of an error.

unpack

protected void unpack(Artifact artifact,
                      File location,
                      String includes,
                      String excludes,
                      String encoding,
                      FileMapper[] fileMappers)
               throws MojoExecutionException

Unpacks the archive file.

Parameters:

artifact - File to be unpacked.

location - Location where to put the unpacked files.

includes - Comma separated list of file patterns to include i.e. **/.xml, **/*.properties

excludes - Comma separated list of file patterns to exclude i.e. **/*.xml, **/*.properties

encoding - Encoding of artifact. Set null for default encoding.

fileMappers - FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.

Throws:

MojoExecutionException - In case of errors.

unpack

protected void unpack(Artifact artifact,
                      String type,
                      File location,
                      String includes,
                      String excludes,
                      String encoding,
                      FileMapper[] fileMappers)
               throws MojoExecutionException

Parameters:

artifact - Artifact

type - The type.

location - The location.

includes - includes list.

excludes - excludes list.

encoding - the encoding.

fileMappers - FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.

Throws:

MojoExecutionException - in case of an error.

newResolveArtifactProjectBuildingRequest

public ProjectBuildingRequest newResolveArtifactProjectBuildingRequest()

Returns:

Returns a new ProjectBuildingRequest populated from the current session and the current project remote repositories, used to resolve artifacts.

newResolvePluginProjectBuildingRequest

protected ProjectBuildingRequest newResolvePluginProjectBuildingRequest()

Returns:

Returns a new ProjectBuildingRequest populated from the current session and the current project remote repositories, used to resolve plugins.

getProject

public MavenProject getProject()

Returns:

Returns the project.

setArchiverManager

public void setArchiverManager(ArchiverManager archiverManager)

Parameters:

archiverManager - The archiverManager to set.

isUseJvmChmod

public boolean isUseJvmChmod()

Returns:

useJvmChmod

setUseJvmChmod

public void setUseJvmChmod(boolean useJvmChmod)

Parameters:

useJvmChmod - useJvmChmod

isSkip

public boolean isSkip()

Returns:

skip

setSkip

public void setSkip(boolean skip)

Parameters:

skip - skip

isSilent

protected final boolean isSilent()

Returns:

silent

setSilent

public void setSilent(boolean silent)

Parameters:

silent - silent