io.openliberty.tools.maven

Class AbstractLibertySupport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.pluginsupport.MojoSupport

io.openliberty.tools.maven.AbstractLibertySupport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

BasicSupport

public abstract class AbstractLibertySupport
extends org.codehaus.mojo.pluginsupport.MojoSupport

Liberty Abstract Mojo Support

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.mojo.pluginsupport.ant.AntHelper	ant
protected org.apache.maven.artifact.repository.ArtifactRepository	artifactRepository
protected org.apache.maven.project.ProjectBuilder	mavenProjectBuilder
protected org.apache.maven.project.MavenProject	project Maven Project
protected List<org.apache.maven.project.MavenProject>	reactorProjects
protected org.eclipse.aether.RepositorySystemSession	repoSession
protected List<org.eclipse.aether.repository.RemoteRepository>	repositories
protected org.eclipse.aether.RepositorySystem	repositorySystem
protected org.apache.maven.execution.MavenSession	session
protected org.apache.maven.settings.Settings	settings The build settings.

Fields inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

container, log

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractLibertySupport()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.artifact.Artifact	createArtifact(org.codehaus.mojo.pluginsupport.util.ArtifactItem item) Create a new artifact.
protected org.codehaus.mojo.pluginsupport.util.ArtifactItem	createArtifactItem(String groupId, String artifactId, String type, String version)
protected boolean	dependencyTrailContainsArtifact(String gaCoords, String version, List<String> depTrail)
protected void	findTransitiveDependencies(org.apache.maven.artifact.Artifact resolvedArtifact, Set<org.apache.maven.artifact.Artifact> resolvedArtifacts, Set<org.apache.maven.artifact.Artifact> resolvedDependencies)
protected org.apache.maven.artifact.Artifact	getArtifact(org.codehaus.mojo.pluginsupport.util.ArtifactItem item) Resolves the Artifact from the remote repository if necessary.
protected org.apache.maven.artifact.Artifact	getArtifact(String groupId, String artifactId, String type, String version) Equivalent to getArtifact(ArtifactItem) with an ArtifactItem defined by the given the coordinates.
protected org.apache.maven.artifact.repository.ArtifactRepository	getArtifactRepository()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.project.MavenProject	getReactorMavenProject(org.apache.maven.artifact.Artifact artifact)
protected Set<org.apache.maven.artifact.Artifact>	getResolvedDependencyWithTransitiveDependencies(String groupId, String artifactId, String version, String type) Find resolved dependencies with matching groupId:artifactId:version.
protected void	init()
protected boolean	isReactorMavenProject(org.apache.maven.artifact.Artifact artifact)

Methods inherited from class org.codehaus.mojo.pluginsupport.MojoSupport

contextualize, doExecute, execute, getArtifactFactory, getArtifactResolver, getProjectArtifacts, getProjectArtifacts, getProjectArtifacts, resolveArtifact, resolveArtifact

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

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

Maven Project

artifactRepository

@Parameter(defaultValue="${localRepository}",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository artifactRepository

settings

@Parameter(defaultValue="${settings}",
           required=true,
           readonly=true)
protected org.apache.maven.settings.Settings settings

The build settings.

ant

@Component(role=org.codehaus.mojo.pluginsupport.ant.AntHelper.class)
protected org.codehaus.mojo.pluginsupport.ant.AntHelper ant

repositorySystem

@Component
protected org.eclipse.aether.RepositorySystem repositorySystem

repoSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true,
           required=true)
protected org.eclipse.aether.RepositorySystemSession repoSession

repositories

@Parameter(defaultValue="${project.remoteProjectRepositories}",
           readonly=true,
           required=true)
protected List<org.eclipse.aether.repository.RemoteRepository> repositories

mavenProjectBuilder

@Component
protected org.apache.maven.project.ProjectBuilder mavenProjectBuilder

session

@Parameter(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

reactorProjects

@Parameter(property="reactorProjects",
           required=true,
           readonly=true)
protected List<org.apache.maven.project.MavenProject> reactorProjects

Constructor Detail

AbstractLibertySupport

public AbstractLibertySupport()

Method Detail

getProject

protected org.apache.maven.project.MavenProject getProject()

Overrides:

getProject in class org.codehaus.mojo.pluginsupport.MojoSupport

getArtifactRepository

protected org.apache.maven.artifact.repository.ArtifactRepository getArtifactRepository()

Overrides:

getArtifactRepository in class org.codehaus.mojo.pluginsupport.MojoSupport

init

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

Overrides:

init in class org.codehaus.mojo.pluginsupport.MojoSupport

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isReactorMavenProject

protected boolean isReactorMavenProject(org.apache.maven.artifact.Artifact artifact)

getReactorMavenProject

protected org.apache.maven.project.MavenProject getReactorMavenProject(org.apache.maven.artifact.Artifact artifact)

getArtifact

protected org.apache.maven.artifact.Artifact getArtifact(org.codehaus.mojo.pluginsupport.util.ArtifactItem item)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Resolves the Artifact from the remote repository if necessary. If no version is specified, it will be retrieved from the dependency list or from the DependencyManagement section of the pom.

Overrides:

getArtifact in class org.codehaus.mojo.pluginsupport.MojoSupport

Parameters:

item - The item to create an artifact for; must not be null

Returns:

The artifact for the given item

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to create artifact

getArtifact

protected org.apache.maven.artifact.Artifact getArtifact(String groupId,
                                                         String artifactId,
                                                         String type,
                                                         String version)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Equivalent to getArtifact(ArtifactItem) with an ArtifactItem defined by the given the coordinates.

Parameters:

groupId - The group ID

artifactId - The artifact ID

type - The type (e.g. jar)

version - The version, or null to retrieve it from the dependency list or from the DependencyManagement section of the pom.

Returns:

Artifact The artifact for the given item

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to create artifact

createArtifactItem

protected org.codehaus.mojo.pluginsupport.util.ArtifactItem createArtifactItem(String groupId,
                                                                               String artifactId,
                                                                               String type,
                                                                               String version)

getResolvedDependencyWithTransitiveDependencies

protected Set<org.apache.maven.artifact.Artifact> getResolvedDependencyWithTransitiveDependencies(String groupId,
                                                                                                  String artifactId,
                                                                                                  String version,
                                                                                                  String type)
                                                                                           throws org.apache.maven.plugin.MojoExecutionException

Find resolved dependencies with matching groupId:artifactId:version. Also collect transitive dependencies for those resolved dependencies. The groupId is required. The artifactId and version are optional. The artifactId can also end with a '*' to indicate a wildcard match.

Parameters:

groupId - String specifying the groupId of the Maven artifact to copy.

artifactId - String specifying the artifactId of the Maven artifact to copy.

version - String specifying the version of the Maven artifact to copy.

type - String specifying the type of the Maven artifact to copy.

Returns:

Set A collection of Artifact objects for the resolved dependencies and transitive dependencies

Throws:

org.apache.maven.plugin.MojoExecutionException

findTransitiveDependencies

protected void findTransitiveDependencies(org.apache.maven.artifact.Artifact resolvedArtifact,
                                          Set<org.apache.maven.artifact.Artifact> resolvedArtifacts,
                                          Set<org.apache.maven.artifact.Artifact> resolvedDependencies)

dependencyTrailContainsArtifact

protected boolean dependencyTrailContainsArtifact(String gaCoords,
                                                  String version,
                                                  List<String> depTrail)

createArtifact

protected org.apache.maven.artifact.Artifact createArtifact(org.codehaus.mojo.pluginsupport.util.ArtifactItem item)
                                                     throws org.apache.maven.plugin.MojoExecutionException

Create a new artifact.

Overrides:

createArtifact in class org.codehaus.mojo.pluginsupport.MojoSupport

Parameters:

item - The item to create an artifact for

Returns:

A resolved artifact for the given item.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to create artifact