br.com.c8tech.tools.maven.plugin.osgi.container

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

br.com.c8tech.tools.maven.plugin.osgi.container.AbstractDockerMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

MojoBuildDocker, MojoPushDocker, MojoTagDocker

public abstract class AbstractDockerMojo
extends AbstractOsgiContainerPackMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractDockerMojo.Metadata

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	buildDocker Allows the generation of a docker image.
protected long	connectTimeoutMillis
protected String	dockerClassifier Classifier to use when attaching the Docker info JAR.
protected File	dockerConfigFile Path to docker config file, if the default is not acceptable.
protected File	dockerInfoDirectory Directory where various Docker-related metadata fragments will be stored.
protected String	password
protected long	readTimeoutMillis
protected int	retryCount Certain Docker operations can fail due to mysterious Docker daemon conditions.
protected File	testOutputDirectory Directory where test metadata will be written during build.
protected boolean	useMavenSettingsForAuth A maven server id, in order to use maven settings to supply server auth.
protected boolean	useProxy Whether to connect to Docker Daemon using HTTP proxy, if set.
protected String	username

Fields inherited from class br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

DOWNLOAD_STATUS, EQUINOX_CONFIGURATION_NAME, EQUINOX_CONFIGURATION_PATH, FELIX_CONFIGURATION_NAME, FELIX_CONFIGURATION_PATH, PROPERTY_CACHE_DIR, PROPERTY_WORK_DIR

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDockerMojo(org.apache.maven.project.MavenProject pProject)

Method Summary

Modifier and Type	Method and Description
protected File	buildDockerInfoJar(org.apache.maven.plugin.logging.Log log)
protected File	ensureDockerInfoDirectory()
protected File	ensureMetadataFile(AbstractDockerMojo.Metadata metadata)
protected abstract void	execute(com.spotify.docker.client.DockerClient dockerClient)
void	executeMojo()
protected static String	formatImageName(String repository, String tag)
protected String	readMetadata(AbstractDockerMojo.Metadata metadata)
protected void	writeImageInfo(String repository, String tag)
protected void	writeMetadata(AbstractDockerMojo.Metadata metadata, String value)
protected void	writeMetadata(org.apache.maven.plugin.logging.Log log)

Methods inherited from class br.com.c8tech.tools.maven.plugin.osgi.container.AbstractOsgiContainerPackMojo

addMavenArtifactSet, addScope, calculateContainerConfigurationFileOutputPath, createDefaultDirectories, doBeforeSkipMojo, executeExtraInitializationSteps, getBaseContainerConfigurationFileUrl, getBundleValidArtifactFilter, getCacheDirectory, getConfiguratorInitialFile, getContainer, getContainerCacheDirectory, getContainerPomDependenciesGAV, getContainerWorkDirectory, getDefaultSupportedPackagings, getEncoding, getExcludedArtifacts, getLocalRepositoryGAV, getLogbackConfigurationFile, getMavenArtifactSets, getMsgChoiceArtifact, getProjectBuilder, getScopes, isOptionalConsidered, isRunOnlyAtExecutionRoot, isSkip, isSkipConfigurationGen, isTransitiveConsidered, loadProperties, setBaseContainerConfigurationFileUrl, setConfiguratorInitialFile, setContainerPomDependenciesGAV, setEncoding, setLocalRepositoryGAV, setLogbackConfigurationFile, setScopes, setSkipConfigurationGen

Methods inherited from class br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

addExtraSupportedPackaging, cleanWorkDirectory, combineScopes, copyInternalFileToProjectDir, copyInternalFileToProjectDir, doInitialValidation, execute, getBasedir, getBuildDir, getCachedFileNamePattern, getCacheSubDirectory, getClassifier, getDependenciesHelper, getDirectoryHelper, getExtraSupportedPackagings, getFilterFactory, getFinalName, getGoalName, getLocalRepository, getMavenSession, getPluginDescriptor, getProject, getProjectHelper, getRemoteRepositories, getRepositorySystem, getRuntimeInformation, getSupportedPackagings, getWorkDirectory, getWorkSubDirectory, isAggregator, isVerbose, loadProject, loadProject, registerArtifactsIntoAggregatorBuildContext, setBuildDir, setClassifier, setExtraSupportedPackagings, setFinalName, setWorkDirectory

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 Detail

buildDocker

@Parameter(defaultValue="false")
protected boolean buildDocker

Allows the generation of a docker image.

dockerClassifier

@Parameter(defaultValue="docker-info",
           property="dockerfile.classifier")
protected String dockerClassifier

Classifier to use when attaching the Docker info JAR. If empty or absent, the JAR will become the main artifact of the project.

connectTimeoutMillis

@Parameter(defaultValue="300000",
           property="dockerfile.connectTimeoutMillis",
           required=true)
protected long connectTimeoutMillis

dockerConfigFile

@Parameter(property="dockerfile.dockerConfigFile")
protected File dockerConfigFile

Path to docker config file, if the default is not acceptable.

dockerInfoDirectory

@Parameter(defaultValue="${project.build.directory}/docker",
           property="dockerfile.dockerInfoDirectory",
           required=true)
protected File dockerInfoDirectory

Directory where various Docker-related metadata fragments will be stored.

password

@Parameter(property="dockerfile.password")
protected String password

readTimeoutMillis

@Parameter(defaultValue="300000",
           property="dockerfile.readTimeoutMillis",
           required=true)
protected long readTimeoutMillis

retryCount

@Parameter(defaultValue="1",
           property="dockerfile.retryCount")
protected int retryCount

Certain Docker operations can fail due to mysterious Docker daemon conditions. Sometimes it might be worth it to just retry operations until they succeed. This parameter controls how many times operations should be retried before they fail. By default, an extra attempt (so up to two attempts) is made before failing.

testOutputDirectory

@Parameter(defaultValue="${project.build.testOutputDirectory}",
           property="dockerfile.testOutputDirectory",
           required=true)
protected File testOutputDirectory

Directory where test metadata will be written during build.

useMavenSettingsForAuth

@Parameter(defaultValue="false",
           property="dockerfile.useMavenSettingsForAuth")
protected boolean useMavenSettingsForAuth

A maven server id, in order to use maven settings to supply server auth.

useProxy

@Parameter(defaultValue="true",
           property="dockerfile.useProxy")
protected boolean useProxy

Whether to connect to Docker Daemon using HTTP proxy, if set.

username

@Parameter(property="dockerfile.username")
protected String username

Constructor Detail

AbstractDockerMojo

protected AbstractDockerMojo(org.apache.maven.project.MavenProject pProject)

Method Detail

formatImageName

@Nonnull
protected static String formatImageName(@Nonnull
                                                 String repository,
                                                 @Nonnull
                                                 String tag)

buildDockerInfoJar

@Nonnull
protected File buildDockerInfoJar(@Nonnull
                                           org.apache.maven.plugin.logging.Log log)
                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

ensureDockerInfoDirectory

@Nonnull
protected File ensureDockerInfoDirectory()
                                           throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

ensureMetadataFile

@Nonnull
protected File ensureMetadataFile(@Nonnull
                                           AbstractDockerMojo.Metadata metadata)
                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

execute

protected abstract void execute(com.spotify.docker.client.DockerClient dockerClient)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeMojo

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

Overrides:

executeMojo in class br.com.c8tech.tools.maven.osgi.lib.mojo.AbstractCustomPackagingMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

readMetadata

@Nullable
protected String readMetadata(@Nonnull
                                        AbstractDockerMojo.Metadata metadata)
                                 throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

writeImageInfo

protected void writeImageInfo(String repository,
                              String tag)
                       throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

writeMetadata

protected void writeMetadata(org.apache.maven.plugin.logging.Log log)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

writeMetadata

protected void writeMetadata(@Nonnull
                             AbstractDockerMojo.Metadata metadata,
                             @Nonnull
                             String value)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException