Class BuildImageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.springframework.boot.maven.AbstractDependencyFilterMojo

org.springframework.boot.maven.AbstractPackagerMojo

org.springframework.boot.maven.BuildImageMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildImageForkMojo, BuildImageNoForkMojo

public abstract class BuildImageMojo
extends AbstractPackagerMojo

Package an application into an OCI image using a buildpack.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick, Jeroen Meijer

Nested Class Summary

Nested classes/interfaces inherited from class AbstractPackagerMojo

AbstractPackagerMojo.LayoutType

Nested classes/interfaces inherited from class AbstractDependencyFilterMojo

AbstractDependencyFilterMojo.ExcludeTestScopeArtifactFilter, AbstractDependencyFilterMojo.RuntimeArtifactFilter

Field Summary

Fields inherited from class AbstractPackagerMojo

includeOptional, includeSystemScope, includeTools, project, projectHelper, session

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuildImageMojo(org.apache.maven.project.MavenProjectHelper projectHelper)

Method Summary

Modifier and Type	Method	Description
void	execute()
protected @Nullable AbstractPackagerMojo.LayoutType	getLayout()	Return the type of archive that should be used when building the image.
protected @Nullable org.springframework.boot.loader.tools.LayoutFactory	getLayoutFactory()	Return the layout factory that will be used to determine the AbstractPackagerMojo.LayoutType if no explicit layout is set.

Methods inherited from class AbstractPackagerMojo

getConfiguredPackager, getLibraries, getSourceArtifact, getTargetFile

Methods inherited from class AbstractDependencyFilterMojo

filterDependencies, getDependencyURLs, setExcludeGroupIds, setExcludes, setIncludes, toURL

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Constructor Details

BuildImageMojo

protected BuildImageMojo(org.apache.maven.project.MavenProjectHelper projectHelper)

Method Details

getLayout

protected @Nullable AbstractPackagerMojo.LayoutType getLayout()

Return the type of archive that should be used when building the image.

Overrides:

getLayout in class AbstractPackagerMojo

Returns:

the value of the layout parameter, or null if the parameter is not provided

getLayoutFactory

protected @Nullable org.springframework.boot.loader.tools.LayoutFactory getLayoutFactory()

Return the layout factory that will be used to determine the AbstractPackagerMojo.LayoutType if no explicit layout is set.

Overrides:

getLayoutFactory in class AbstractPackagerMojo

Returns:

the value of the layoutFactory parameter, or null if the parameter is not provided

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException