Package io.quarkus.maven

Class QuarkusBootstrapMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.quarkus.maven.QuarkusBootstrapMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildMojo, GenerateCodeMojo, RunMojo, TrackConfigChangesMojo

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

Field Summary

Fields

Modifier and Type	Field	Description
protected QuarkusBootstrapProvider	bootstrapProvider

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

ROLE

Constructor Summary

Constructors

Constructor	Description
QuarkusBootstrapMojo()

Method Summary

Modifier and Type	Method	Description
protected String	appArtifactCoords()
protected File	baseDir()
protected abstract boolean	beforeExecute()	This callback allows to evaluate whether this mojo should be executed, skipped or fail.
protected io.quarkus.bootstrap.app.CuratedApplication	bootstrapApplication()
protected io.quarkus.bootstrap.app.CuratedApplication	bootstrapApplication(io.quarkus.runtime.LaunchMode mode)
protected String	bootstrapId()
protected File	buildDir()
protected abstract void	doExecute()	Main mojo execution code
void	execute()
protected String	finalName()
protected List<io.quarkus.maven.dependency.Dependency>	forcedDependencies(io.quarkus.runtime.LaunchMode mode)	Allows implementations to provide extra dependencies that should be enforced on the application.
protected Properties	getBuildSystemProperties(boolean quarkusOnly)
protected String[]	ignoredEntries()
protected Map<String,String>	manifestEntries()
protected List<ManifestSection>	manifestSections()
protected org.apache.maven.project.MavenProject	mavenProject()
org.apache.maven.execution.MavenSession	mavenSession()
protected io.quarkus.maven.dependency.ArtifactKey	projectId()
protected Map<String,String>	properties()
protected List<org.eclipse.aether.repository.RemoteRepository>	remoteRepositories()
protected org.eclipse.aether.impl.RemoteRepositoryManager	remoteRepositoryManager()	Deprecated, for removal: This API element is subject to removal in a future version.
protected org.eclipse.aether.RepositorySystem	repositorySystem()	Deprecated, for removal: This API element is subject to removal in a future version.
protected org.eclipse.aether.RepositorySystemSession	repositorySystemSession()
void	setLog(org.apache.maven.plugin.logging.Log log)
protected boolean	setPackageTypeSystemPropertyIfNativeProfileEnabled()	Essentially what this does is to enable the native package type even if a different package type is set in application properties.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bootstrapProvider

@Component
protected QuarkusBootstrapProvider bootstrapProvider

Constructor Detail

QuarkusBootstrapMojo

public QuarkusBootstrapMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

Specified by:

setLog in interface org.apache.maven.plugin.Mojo

Overrides:

setLog in class org.apache.maven.plugin.AbstractMojo

beforeExecute

protected abstract boolean beforeExecute()
                                  throws org.apache.maven.plugin.MojoExecutionException,
                                         org.apache.maven.plugin.MojoFailureException

This callback allows to evaluate whether this mojo should be executed, skipped or fail.

Returns:

false if the execution of the mojo should be skipped, true if the mojo should be executed

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of a failure

org.apache.maven.plugin.MojoFailureException - in case of a failure

doExecute

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

Main mojo execution code

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of a failure

org.apache.maven.plugin.MojoFailureException - in case of a failure

appArtifactCoords

protected String appArtifactCoords()

forcedDependencies

protected List<io.quarkus.maven.dependency.Dependency> forcedDependencies(io.quarkus.runtime.LaunchMode mode)

Allows implementations to provide extra dependencies that should be enforced on the application. Originally requested by Camel K.

Parameters:

mode - launch mode the application is being bootstrapped in

Returns:

list of extra dependencies that should be enforced on the application

repositorySystem

@Deprecated(forRemoval=true)
protected org.eclipse.aether.RepositorySystem repositorySystem()

Deprecated, for removal: This API element is subject to removal in a future version.

remoteRepositoryManager

@Deprecated(forRemoval=true)
protected org.eclipse.aether.impl.RemoteRepositoryManager remoteRepositoryManager()

Deprecated, for removal: This API element is subject to removal in a future version.

repositorySystemSession

protected org.eclipse.aether.RepositorySystemSession repositorySystemSession()

remoteRepositories

protected List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories()

mavenProject

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

mavenSession

public org.apache.maven.execution.MavenSession mavenSession()

buildDir

protected File buildDir()

baseDir

protected File baseDir()

finalName

protected String finalName()

manifestEntries

protected Map<String,String> manifestEntries()

manifestSections

protected List<ManifestSection> manifestSections()

ignoredEntries

protected String[] ignoredEntries()

properties

protected Map<String,String> properties()

bootstrapId

protected String bootstrapId()

projectId

protected io.quarkus.maven.dependency.ArtifactKey projectId()

bootstrapApplication

protected io.quarkus.bootstrap.app.CuratedApplication bootstrapApplication()
                                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

bootstrapApplication

protected io.quarkus.bootstrap.app.CuratedApplication bootstrapApplication(io.quarkus.runtime.LaunchMode mode)
                                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuildSystemProperties

protected Properties getBuildSystemProperties(boolean quarkusOnly)
                                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setPackageTypeSystemPropertyIfNativeProfileEnabled

protected boolean setPackageTypeSystemPropertyIfNativeProfileEnabled()

Essentially what this does is to enable the native package type even if a different package type is set in application properties. This is done to preserve what users expect to happen when they execute "mvn package -Dnative" even if quarkus.package.type has been set in application.properties

Returns:

true if the package type system property was set, otherwise - false