Package io.quarkus.maven

Class AbstractImageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.quarkus.maven.QuarkusBootstrapMojo

io.quarkus.maven.BuildMojo

io.quarkus.maven.AbstractImageMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ImageBuildMojo, ImagePushMojo

public class AbstractImageMojo
extends BuildMojo

Base class for Image related mojos.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	builderName
(package private) boolean	dryRun

Fields inherited from class io.quarkus.maven.BuildMojo

analyticsProvider, attachRunnerAsMainArtifact, attachSboms, buildDirectory, generatedSourcesDirectory, pluginRepos, projectHelper, skip, skipOriginalJarRename, systemProperties

Fields inherited from class io.quarkus.maven.QuarkusBootstrapMojo

BOOTSTRAP_ID_PARAM, bootstrapId, bootstrapProvider, CLOSE_BOOTSTRAPPED_APP_PARAM, closeBootstrappedApp, MODE_PARAM, mojoExecution, NATIVE_PROFILE_NAME, RELOAD_POMS_PARAM, reloadPoms

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

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractImageMojo()

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeExecute()	This callback allows to evaluate whether this mojo should be executed, skipped or fail.
protected void	doExecute()	Main mojo execution code
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.
ImageBuilder	getBuilder()

Methods inherited from class io.quarkus.maven.BuildMojo

setLog

Methods inherited from class io.quarkus.maven.QuarkusBootstrapMojo

appArtifactCoords, baseDir, bootstrapApplication, bootstrapApplication, bootstrapApplication, bootstrapId, buildDir, closeApplication, execute, finalName, getBuildSystemProperties, getWorkspaceId, ignoredEntries, isNativeProfileEnabled, manifestEntries, manifestSections, mavenProject, mavenSession, projectId, properties, remoteRepositories, remoteRepositoryManager, repositorySystem, repositorySystemSession, setNativeEnabledIfNativeProfileEnabled

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 Details

builderName

@Parameter(property="quarkus.container-image.builder")
String builderName

dryRun

@Parameter(property="quarkus.container-image.dry-run")
boolean dryRun

Constructor Details

AbstractImageMojo

public AbstractImageMojo()

Method Details

getBuilder

public ImageBuilder getBuilder()

beforeExecute

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

Description copied from class: QuarkusBootstrapMojo

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

Overrides:

beforeExecute in class BuildMojo

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

doExecute

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

Description copied from class: QuarkusBootstrapMojo

Main mojo execution code

Overrides:

doExecute in class BuildMojo

Throws:

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

forcedDependencies

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

Description copied from class: QuarkusBootstrapMojo

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

Overrides:

forcedDependencies in class QuarkusBootstrapMojo

Parameters:

mode - launch mode the application is being bootstrapped in

Returns:

list of extra dependencies that should be enforced on the application