com.github.maven_nar

Class AbstractDependencyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.maven_nar.AbstractNarMojo

com.github.maven_nar.AbstractDependencyMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCompileMojo, NarAssemblyMojo, NarDownloadDependenciesMojo, NarDownloadMojo, NarIntegrationTestMojo, NarTestUnpackMojo, NarUnpackMojo

public abstract class AbstractDependencyMojo
extends AbstractNarMojo

Author:

Mark Donszelmann

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager To look up Archiver/UnArchiver implementations
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver Artifact resolver, needed to download the attached nar files.
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder	dependencyGraphBuilder The dependency tree builder to use.
protected String	excludeArtifactIds Comma separated list of Artifact names to exclude.
protected String	excludeGroupIds Comma separated list of GroupId Names to exclude.
protected String	includeArtifactIds Comma separated list of Artifact names to include.
protected String	includeGroupIds Comma separated list of GroupIds to include.
protected List	remoteArtifactRepositories Remote repositories which will be searched for nar attachments.
protected org.apache.maven.shared.dependency.graph.DependencyNode	rootNode The computed dependency tree root node of the Maven project.

Fields inherited from class com.github.maven_nar.AbstractNarMojo

classesDirectory, classifiers, dryRun, includesType, libraries, libsName, replay, skip, skipRanlib

Fields inherited from interface com.github.maven_nar.NarConstants

LOG_LEVEL_DEBUG, LOG_LEVEL_ERROR, LOG_LEVEL_INFO, LOG_LEVEL_VERBOSE, LOG_LEVEL_WARNING, NAR, NAR_AOL, NAR_EXTENSION, NAR_NO_ARCH, NAR_ROLE_HINT, NAR_TYPE, REPLAY_COMPILE_NAME, REPLAY_LINK_NAME, REPLAY_TEST_COMPILE_NAME, REPLAY_TEST_LINK_NAME

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 String	dependencyTreeOrderStr(boolean pushDepsToLowestOrder, boolean specifyDirectDeps) Serializes the dependency tree of current maven project to a string of comma separated list of groupId:artifactId traversing nodes in Level-Order way (also called BFS algorithm)
void	downloadAttachedNars(List<AttachedNarArtifact> dependencies)
List<AttachedNarArtifact>	getAllAttachedNarArtifacts(List<NarArtifact> narArtifacts, List<? extends Executable> libraries)
protected org.codehaus.plexus.archiver.manager.ArchiverManager	getArchiverManager()
protected abstract org.apache.maven.shared.artifact.filter.collection.ScopeFilter	getArtifactScopeFilter() Returns the artifacts which must be taken in account for the Mojo.
protected List<AttachedNarArtifact>	getAttachedNarArtifacts(List<? extends Executable> libraries) Returns the attached NAR Artifacts (AOL and noarch artifacts) from the NAR dependencies artifacts of the project.
protected String	getBinding(Executable exec, NarArtifact dependency)
protected String[]	getBindings(List<? extends Executable> libraries, NarArtifact dependency)
protected HashSet<String>	getDirectDepsSet(org.eclipse.aether.graph.DependencyNode rootNode) Gets the set strings of the form "<groupId>:<artifactId>" representing the specified nodes direct dependencies (immediate children).
protected org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository() The plugin remote repositories declared in the pom.
List<NarArtifact>	getNarArtifacts() Returns dependencies which are dependent on NAR files (i.e.
NarInfo	getNarInfo(org.apache.maven.artifact.Artifact dependency)
protected NarManager	getNarManager()
protected List	getRemoteRepositories()
protected org.apache.maven.shared.dependency.graph.DependencyNode	getRootNodeDependecyTree() Get root node of the current Maven project Dependency tree generated by maven.shared dependency graph builder.
protected org.eclipse.aether.graph.DependencyNode	getVerboseDependencyTree() Gets the project's full dependency tree prior to dependency mediation.
void	unpackAttachedNars(List<AttachedNarArtifact> dependencies)

Methods inherited from class com.github.maven_nar.AbstractNarMojo

createReplayDirs, execute, getAOL, getArchitecture, getBasedir, getIncludesType, getJavah, getJavaHome, getLayout, getLibraries, getLibsName, getLinker, getMavenProject, getMsvc, getNarInfo, getNARVersionInfo, getOS, getOutput, getOutputDirectory, getReplay, getTargetDirectory, getTestTargetDirectory, getTestUnpackDirectory, getUnpackDirectory, getWindowsMsvcDir, getWindowsMsvcVersion, getWindowsSdkDir, getWindowsSdkVersion, isDryRun, isSkipRanlib, narExecute, setDryRun, setReplay, validate

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

artifactResolver

@Component(role=org.apache.maven.artifact.resolver.ArtifactResolver.class)
protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

Artifact resolver, needed to download the attached nar files.

remoteArtifactRepositories

@Parameter(defaultValue="${project.remoteArtifactRepositories}",
           required=true,
           readonly=true)
protected List remoteArtifactRepositories

Remote repositories which will be searched for nar attachments.

excludeArtifactIds

@Parameter(property="excludeArtifactIds",
           defaultValue="")
protected String excludeArtifactIds

Comma separated list of Artifact names to exclude.

Since:

2.0

includeArtifactIds

@Parameter(property="includeArtifactIds",
           defaultValue="")
protected String includeArtifactIds

Comma separated list of Artifact names to include.

Since:

2.0

excludeGroupIds

@Parameter(property="excludeGroupIds",
           defaultValue="")
protected String excludeGroupIds

Comma separated list of GroupId Names to exclude.

Since:

2.0

includeGroupIds

@Parameter(property="includeGroupIds",
           defaultValue="")
protected String includeGroupIds

Comma separated list of GroupIds to include.

Since:

2.0

rootNode

protected org.apache.maven.shared.dependency.graph.DependencyNode rootNode

The computed dependency tree root node of the Maven project.

dependencyGraphBuilder

@Component(hint="default")
protected org.apache.maven.shared.dependency.graph.DependencyGraphBuilder dependencyGraphBuilder

The dependency tree builder to use.

archiverManager

@Component(role=org.codehaus.plexus.archiver.manager.ArchiverManager.class)
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

To look up Archiver/UnArchiver implementations

Constructor Detail

AbstractDependencyMojo

public AbstractDependencyMojo()

Method Detail

getVerboseDependencyTree

protected org.eclipse.aether.graph.DependencyNode getVerboseDependencyTree()

Gets the project's full dependency tree prior to dependency mediation. This is required if we want to know where to push libraries in the linker line.

Returns:

Root node of the projects verbose dependency tree.

Since:

3.5.2

dependencyTreeOrderStr

protected String dependencyTreeOrderStr(boolean pushDepsToLowestOrder,
                                        boolean specifyDirectDeps)
                                 throws org.apache.maven.plugin.MojoExecutionException

Serializes the dependency tree of current maven project to a string of comma separated list of groupId:artifactId traversing nodes in Level-Order way (also called BFS algorithm)

Parameters:

pushDepsToLowestOrder - when true enables linker re-ordering logic such that libraries that are lower in the dependency hierarchy appear lower in the list, maximizing symbol resolution.

Returns:

Dependency tree string of comma separated list of groupId:artifactId

Throws:

org.apache.maven.plugin.MojoExecutionException

getDirectDepsSet

protected HashSet<String> getDirectDepsSet(org.eclipse.aether.graph.DependencyNode rootNode)

Gets the set strings of the form "<groupId>:<artifactId>" representing the specified nodes direct dependencies (immediate children).

Parameters:

rootNode - root node of the tree to fetch the direct dependencies from.

Returns:

HashSet of the form "<groupId>:<artifactId>" containing all direct dependencies of the parameter specified by rootNode.

Since:

3.5.3

getRootNodeDependecyTree

protected org.apache.maven.shared.dependency.graph.DependencyNode getRootNodeDependecyTree()
                                                                                    throws org.apache.maven.plugin.MojoExecutionException

Get root node of the current Maven project Dependency tree generated by maven.shared dependency graph builder.

Returns:

root node of the project Dependency tree

Throws:

org.apache.maven.plugin.MojoExecutionException

downloadAttachedNars

public final void downloadAttachedNars(List<AttachedNarArtifact> dependencies)
                                throws org.apache.maven.plugin.MojoExecutionException,
                                       org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getAllAttachedNarArtifacts

public final List<AttachedNarArtifact> getAllAttachedNarArtifacts(List<NarArtifact> narArtifacts,
                                                                  List<? extends Executable> libraries)
                                                           throws org.apache.maven.plugin.MojoExecutionException,
                                                                  org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getArchiverManager

protected final org.codehaus.plexus.archiver.manager.ArchiverManager getArchiverManager()

getArtifactScopeFilter

protected abstract org.apache.maven.shared.artifact.filter.collection.ScopeFilter getArtifactScopeFilter()

Returns the artifacts which must be taken in account for the Mojo.

Returns:

Artifacts

getAttachedNarArtifacts

protected List<AttachedNarArtifact> getAttachedNarArtifacts(List<? extends Executable> libraries)
                                                     throws org.apache.maven.plugin.MojoFailureException,
                                                            org.apache.maven.plugin.MojoExecutionException

Returns the attached NAR Artifacts (AOL and noarch artifacts) from the NAR dependencies artifacts of the project. The artifacts which will be processed are those returned by the method getArtifacts() which must be implemented in each class which extends AbstractDependencyMojo.

Returns:

Attached NAR Artifacts

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

See Also:

getArtifacts

getBindings

protected String[] getBindings(List<? extends Executable> libraries,
                               NarArtifact dependency)
                        throws org.apache.maven.plugin.MojoFailureException,
                               org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getBinding

protected String getBinding(Executable exec,
                            NarArtifact dependency)
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getLocalRepository

protected final org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

The plugin remote repositories declared in the pom.

Since:

2.2

getNarArtifacts

public final List<NarArtifact> getNarArtifacts()
                                        throws org.apache.maven.plugin.MojoExecutionException

Returns dependencies which are dependent on NAR files (i.e. contain NarInfo)

Throws:

org.apache.maven.plugin.MojoExecutionException

getNarInfo

public final NarInfo getNarInfo(org.apache.maven.artifact.Artifact dependency)
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getNarManager

protected final NarManager getNarManager()
                                  throws org.apache.maven.plugin.MojoFailureException,
                                         org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

getRemoteRepositories

protected final List getRemoteRepositories()

unpackAttachedNars

public final void unpackAttachedNars(List<AttachedNarArtifact> dependencies)
                              throws org.apache.maven.plugin.MojoExecutionException,
                                     org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException