Package io.quarkus.maven

Class QuarkusProjectMojoBase

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.quarkus.maven.QuarkusProjectMojoBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AddExtensionMojo, ListCategoriesMojo, ListExtensionsMojo, ListPlatformsMojo, QuarkusProjectStateMojoBase, RemoveExtensionMojo

public abstract class QuarkusProjectMojoBase
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	bomArtifactId
(package private) String	bomGroupId
(package private) String	bomVersion
protected org.apache.maven.project.MavenProject	project
(package private) boolean	refresh	Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions
protected List<org.eclipse.aether.repository.RemoteRepository>	repos
protected org.eclipse.aether.RepositorySystemSession	repoSession
(package private) org.apache.maven.execution.MavenSession	session
(package private) QuarkusWorkspaceProvider	workspaceProvider

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

ROLE

Constructor Summary

Constructors

Constructor	Description
QuarkusProjectMojoBase()

Method Summary

Modifier and Type	Method	Description
protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver	artifactResolver()
protected Path	baseDir()
protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver	catalogArtifactResolver()
protected abstract void	doExecute(io.quarkus.devtools.project.QuarkusProject quarkusProject, io.quarkus.devtools.messagewriter.MessageWriter log)
void	execute()
protected io.quarkus.registry.ExtensionCatalogResolver	getExtensionCatalogResolver()
protected List<io.quarkus.maven.dependency.ArtifactCoords>	getImportedPlatforms()
protected io.quarkus.devtools.messagewriter.MessageWriter	getMessageWriter()
(package private) static io.quarkus.maven.dependency.ArtifactCoords	getSingleMatchingBom(String bomGroupId, String bomArtifactId, String bomVersion, io.quarkus.registry.catalog.PlatformCatalog platformCatalog)
protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver	initArtifactResolver()
protected void	validateParameters()

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

project

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

session

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

repoSession

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

repos

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

bomGroupId

@Parameter(property="bomGroupId",
           required=false)
String bomGroupId

bomArtifactId

@Parameter(property="bomArtifactId",
           required=false)
String bomArtifactId

bomVersion

@Parameter(property="bomVersion",
           required=false)
String bomVersion

refresh

@Parameter(property="refresh",
           defaultValue="false")
boolean refresh

Whether to refresh the local extension catalog cache before searching for the recommended Quarkus extension versions

workspaceProvider

@Component
QuarkusWorkspaceProvider workspaceProvider

Constructor Details

QuarkusProjectMojoBase

public QuarkusProjectMojoBase()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getMessageWriter

protected io.quarkus.devtools.messagewriter.MessageWriter getMessageWriter()

baseDir

protected Path baseDir()

getExtensionCatalogResolver

protected io.quarkus.registry.ExtensionCatalogResolver getExtensionCatalogResolver()
                                                                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getImportedPlatforms

protected List<io.quarkus.maven.dependency.ArtifactCoords> getImportedPlatforms()
                                                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

catalogArtifactResolver

protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver catalogArtifactResolver()
                                                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

artifactResolver

protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver artifactResolver()
                                                                              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

initArtifactResolver

protected io.quarkus.bootstrap.resolver.maven.MavenArtifactResolver initArtifactResolver()
                                                                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

validateParameters

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

Throws:

org.apache.maven.plugin.MojoExecutionException

doExecute

protected abstract void doExecute(io.quarkus.devtools.project.QuarkusProject quarkusProject,
 io.quarkus.devtools.messagewriter.MessageWriter log)
                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getSingleMatchingBom

static io.quarkus.maven.dependency.ArtifactCoords getSingleMatchingBom(String bomGroupId,
 String bomArtifactId,
 String bomVersion,
 io.quarkus.registry.catalog.PlatformCatalog platformCatalog)
                                                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException