org.apache.maven.plugins.dependency.fromConfiguration

Class UnpackMojo

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

All Implemented Interfaces:

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

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

Goal that retrieves a list of artifacts from the repository and unpacks them in a defined location.

Since:

1.0

Version:

$Id: UnpackMojo.java 1807877 2017-09-09 10:35:59Z khmarbaise $

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	artifact The artifact to unpack from command line.
private java.lang.String	excludes A comma separated list of file patterns to exclude when unpacking the artifact.
private java.lang.String	includes A comma separated list of file patterns to include when unpacking the artifact.
private java.io.File	markersDirectory Directory to store flag files after unpack

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
UnpackMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doExecute() Main entry into mojo.
java.lang.String	getExcludes()
java.lang.String	getIncludes()
(package private) ArtifactItemFilter	getMarkedArtifactFilter(ArtifactItem item)
java.io.File	getMarkersDirectory()
protected java.util.List<ArtifactItem>	getProcessedArtifactItems(boolean removeVersion)
void	setExcludes(java.lang.String excludes)
void	setIncludes(java.lang.String includes)
void	setMarkersDirectory(java.io.File theMarkersDirectory)
private void	unpackArtifact(ArtifactItem artifactItem) This method gets the Artifact object and calls DependencyUtil.unpackFile.

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, getArchiverManager, getProject, isSilent, isSkip, isUseJvmChmod, newResolveArtifactProjectBuildingRequest, setArchiverManager, setSilent, setSkip, setUseJvmChmod, unpack, unpack, unpack

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

markersDirectory

@Parameter(defaultValue="${project.build.directory}/dependency-maven-plugin-markers")
private java.io.File markersDirectory

Directory to store flag files after unpack

includes

@Parameter(property="mdep.unpack.includes")
private java.lang.String includes

A comma separated list of file patterns to include when unpacking the artifact. i.e. **/*.xml,**/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)

Since:

2.0-alpha-5

excludes

@Parameter(property="mdep.unpack.excludes")
private java.lang.String excludes

A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **\/*.xml,**\/*.properties **/*.xml,**/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)

Since:

2.0-alpha-5

artifact

@Parameter(property="artifact")
private java.lang.String artifact

The artifact to unpack from command line. A string of the form groupId:artifactId:version[:packaging[:classifier]]. Use AbstractFromConfigurationMojo.artifactItems within the POM configuration.

Constructor Detail

UnpackMojo

public UnpackMojo()

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

Specified by:

doExecute in class AbstractDependencyMojo

Throws:

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

org.apache.maven.plugin.MojoFailureException

See Also:

ArtifactItem, AbstractFromConfigurationMojo.getArtifactItems(), unpackArtifact(ArtifactItem)

unpackArtifact

private void unpackArtifact(ArtifactItem artifactItem)
                     throws org.apache.maven.plugin.MojoExecutionException

This method gets the Artifact object and calls DependencyUtil.unpackFile.

Parameters:

artifactItem - containing the information about the Artifact to unpack.

Throws:

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

See Also:

AbstractFromConfigurationMojo.getArtifact(org.apache.maven.plugins.dependency.fromConfiguration.ArtifactItem)

getMarkedArtifactFilter

ArtifactItemFilter getMarkedArtifactFilter(ArtifactItem item)

Specified by:

getMarkedArtifactFilter in class AbstractFromConfigurationMojo

getProcessedArtifactItems

protected java.util.List<ArtifactItem> getProcessedArtifactItems(boolean removeVersion)
                                                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMarkersDirectory

public java.io.File getMarkersDirectory()

Returns:

Returns the markersDirectory.

setMarkersDirectory

public void setMarkersDirectory(java.io.File theMarkersDirectory)

Parameters:

theMarkersDirectory - The markersDirectory to set.

getExcludes

public java.lang.String getExcludes()

Returns:

Returns a comma separated list of excluded items

setExcludes

public void setExcludes(java.lang.String excludes)

Parameters:

excludes - A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties

getIncludes

public java.lang.String getIncludes()

Returns:

Returns a comma separated list of included items

setIncludes

public void setIncludes(java.lang.String includes)

Parameters:

includes - A comma separated list of items to include i.e. **\/*.xml, **\/*.properties