Package com.google.cloud.tools.jib.maven

Class JibPluginConfiguration

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.google.cloud.tools.jib.maven.JibPluginConfiguration

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildDockerMojo, BuildImageMojo, BuildTarMojo, InitMojo, SyncMapMojo

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

Defines the configuration parameters for Jib. Jib Mojos should extend this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JibPluginConfiguration.ContainerParameters	Configuration for container parameter.
static class	JibPluginConfiguration.CredHelperParameters	Configuration for [from|to].credHelper parameter.
static class	JibPluginConfiguration.DockerClientParameters	Configuration for the dockerClient parameter.
static class	JibPluginConfiguration.ExtensionParameters
static class	JibPluginConfiguration.ExtraDirectoriesParameters	Configuration for the extraDirectories parameter.
static class	JibPluginConfiguration.ExtraDirectoryParameters	A bean that configures the source and destination of an extra directory.
static class	JibPluginConfiguration.FromAuthConfiguration	Used to configure from.auth parameters.
static class	JibPluginConfiguration.FromConfiguration	Configuration for from parameter.
static class	JibPluginConfiguration.OutputPathsParameters
static class	JibPluginConfiguration.PermissionConfiguration	Used to configure extraDirectories.permissions parameter.
static class	JibPluginConfiguration.PlatformParameters	Configuration for platform parameter.
static class	JibPluginConfiguration.ToAuthConfiguration	Used to configure to.auth parameters.
static class	JibPluginConfiguration.ToConfiguration	Configuration for to parameter, where image is required.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.maven.plugin.descriptor.PluginDescriptor	descriptor
protected org.apache.maven.settings.crypto.SettingsDecrypter	settingsDecrypter

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

ROLE

Constructor Summary

Constructors

Constructor	Description
JibPluginConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	checkJibVersion()
java.lang.String	getContainerizingMode()
boolean	getExpandClasspathDependencies()	Returns whether to expand classpath dependencies.
protected java.util.Set<com.google.cloud.tools.jib.maven.extension.JibMavenPluginExtension<?>>	getInjectedPluginExtensions()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.execution.MavenSession	getSession()
protected java.lang.String	getTargetImage()	Gets the target image reference.

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

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

execute

Field Detail

descriptor

@Nullable
@Parameter(defaultValue="${plugin}",
           readonly=true)
protected org.apache.maven.plugin.descriptor.PluginDescriptor descriptor

settingsDecrypter

@Component
protected org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter

Constructor Detail

JibPluginConfiguration

public JibPluginConfiguration()

Method Detail

getInjectedPluginExtensions

protected java.util.Set<com.google.cloud.tools.jib.maven.extension.JibMavenPluginExtension<?>> getInjectedPluginExtensions()

getSession

protected org.apache.maven.execution.MavenSession getSession()

getProject

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

checkJibVersion

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getTargetImage

@Nullable
protected java.lang.String getTargetImage()

Gets the target image reference.

Returns:

the configured target image reference

getExpandClasspathDependencies

public boolean getExpandClasspathDependencies()

Returns whether to expand classpath dependencies.

Returns:

true to expand classpath dependencies. false otherwise.

getContainerizingMode

public java.lang.String getContainerizingMode()