Package de.iip_ecosphere.platform.tools.maven.dependencies

Class CopyPluginDependenciesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.dependency.AbstractDependencyMojo

org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo

org.apache.maven.plugins.dependency.fromDependencies.CopyDependenciesMojo

de.iip_ecosphere.platform.tools.maven.dependencies.CopyDependenciesMojo

de.iip_ecosphere.platform.tools.maven.dependencies.CopyPluginDependenciesMojo

All Implemented Interfaces:

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

@Mojo(name="copy-plugin-dependencies",
      requiresDependencyResolution=TEST,
      defaultPhase=PACKAGE,
      threadSafe=true)
public class CopyPluginDependenciesMojo
extends CopyDependenciesMojo

Reused copy-dependencies Mojo to enable plugin dependencies copy. build-plugin-classpath must be executed before.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	addTestArtifact
private boolean	asTest
private boolean	clean
private boolean	createIndex
private boolean	incrementalIndex
protected File	outputDirectory
private File	targetDirectory

Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.CopyDependenciesMojo

addParentPoms, copyPom, copySignatures, useBaseVersion

Fields inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo

failOnMissingClassifierArtifact, stripClassifier, stripType, stripVersion, useRepositoryLayout, useSubDirectoryPerArtifact, useSubDirectoryPerScope, useSubDirectoryPerType

Fields inherited from class org.apache.maven.plugins.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.plugins.dependency.AbstractDependencyMojo

session

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

ROLE

Constructor Summary

Constructors

Constructor

Description

CopyPluginDependenciesMojo(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project, org.apache.maven.plugins.dependency.utils.ResolverUtil resolverUtil, org.apache.maven.shared.transfer.repository.RepositoryManager repositoryManager, org.apache.maven.project.ProjectBuilder projectBuilder, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.apache.maven.plugins.dependency.utils.CopyUtil copyUtil, org.apache.maven.shared.transfer.artifact.install.ArtifactInstaller installer, org.eclipse.aether.RepositorySystem repoSystem)

Creates a mojo instance.

Method Summary

Modifier and Type	Method	Description
private void	cleanDir(File dir)	Cleans the given output directory.
private void	cleanOutputDirectory()	Cleans the output directory.
protected void	doExecute()
private void	emitOutputDirectorySize(List<File> additional)	Emits size statistics for the output directory.
private List<Path>	getCpEntries(File cpFile)	Returns the classpath entries from the classpath file (must be built before).
private File	getHashFile()	Returns the hashes file object.
private Properties	readHashes()	Reads the hashes file.
private void	writeHashes(Properties hashes)	Writes the hashes file (resource-hash mapping).

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.CopyDependenciesMojo

copyArtifact, copyArtifact, copyPoms, copyPoms, getMarkedArtifactFilter, getResolvedPomArtifact, isCopyPom, setCopyPom

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo

getOutputDirectory, isFailOnMissingClassifierArtifact, isStripType, isStripVersion, isUseRepositoryLayout, isUseSubDirectoryPerArtifact, isUseSubDirectoryPerScope, isUseSubDirectoryPerType, setFailOnMissingClassifierArtifact, setOutputDirectory, setStripType, setStripVersion, setUseRepositoryLayout, setUseSubDirectoryPerArtifact, setUseSubDirectoryPerScope, setUseSubDirectoryPerType

Methods inherited from class org.apache.maven.plugins.dependency.fromDependencies.AbstractDependencyFilterMojo

filterMarkedDependencies, getDependencySets, getDependencySets, getMarkersDirectory, getResolvedDependencies, getResolverUtil, isPrependGroupId, setMarkersDirectory, setPrependGroupId

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

execute, existsInResolvedModel, getProject, isSilent, isSkip, 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 Details

outputDirectory

@Parameter(property="outputDirectory",
           defaultValue="")
protected File outputDirectory

addTestArtifact

@Parameter(property="mdep.addTestArtifact",
           defaultValue="false")
private boolean addTestArtifact

targetDirectory

@Parameter(defaultValue="${project.build.directory}",
           readonly=true)
private File targetDirectory

asTest

@Parameter(required=false)
private boolean asTest

clean

@Parameter(property="mdep.clean",
           required=false,
           defaultValue="false")
private boolean clean

createIndex

@Parameter(property="mdep.createIndex",
           defaultValue="true")
private boolean createIndex

incrementalIndex

@Parameter(property="mdep.incrementalIndex",
           defaultValue="true")
private boolean incrementalIndex

Constructor Details

CopyPluginDependenciesMojo

@Inject
public CopyPluginDependenciesMojo(org.apache.maven.execution.MavenSession session,
 org.sonatype.plexus.build.incremental.BuildContext buildContext,
 org.apache.maven.project.MavenProject project,
 org.apache.maven.plugins.dependency.utils.ResolverUtil resolverUtil,
 org.apache.maven.shared.transfer.repository.RepositoryManager repositoryManager,
 org.apache.maven.project.ProjectBuilder projectBuilder,
 org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager,
 org.apache.maven.plugins.dependency.utils.CopyUtil copyUtil,
 org.apache.maven.shared.transfer.artifact.install.ArtifactInstaller installer,
 org.eclipse.aether.RepositorySystem repoSystem)

Creates a mojo instance.

Parameters:

session - the maven session

buildContext - the build context

project - the maven project

resolverUtil - the resolver util instance

repositoryManager - the repository manager

projectBuilder - the project builder

artifactHandlerManager - the artifact handler manager

copyUtil - the copy util instance

installer - the installer

repoSystem - the repository system instance

Method Details

getHashFile

private File getHashFile()

Returns the hashes file object.

Returns:

the hashes file object

readHashes

private Properties readHashes()

Reads the hashes file.

Returns:

the hashes file contents (resource-hash mapping), may be empty or null

See Also:

• getHashFile()

writeHashes

private void writeHashes(Properties hashes)

Writes the hashes file (resource-hash mapping).

Parameters:

hashes - the hashes file, may be empty or null

See Also:

• getHashFile()

doExecute

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

Overrides:

doExecute in class CopyDependenciesMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

cleanOutputDirectory

private void cleanOutputDirectory()

Cleans the output directory.

cleanDir

private void cleanDir(File dir)

Cleans the given output directory.

Parameters:

dir - the directory to clean

emitOutputDirectorySize

private void emitOutputDirectorySize(List<File> additional)

Emits size statistics for the output directory.

getCpEntries

private List<Path> getCpEntries(File cpFile)

Returns the classpath entries from the classpath file (must be built before).

Parameters:

cpFile -

Returns: