io.fabric8.maven.docker

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.docker.AbstractDockerMojo

All Implemented Interfaces:

ConfigHelper.Customizer, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

AbstractBuildSupportMojo, LogsMojo, PushMojo, RemoveMojo, SaveMojo, StartMojo, StopMojo, VolumeCreateMojo, VolumeRemoveMojo

public abstract class AbstractDockerMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable, ConfigHelper.Customizer

Base class for this plugin.

Since:

26.03.14

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
protected String	autoPull
static String	CONTEXT_KEY_BUILD_TIMESTAMP
static String	CONTEXT_KEY_LOG_DISPATCHER
static String	CONTEXT_KEY_START_CALLED
static String	DOCKER_BUILD_TIMESTAMP
protected DockerAccessFactory	dockerAccessFactory
protected org.apache.maven.plugin.MojoExecution	execution
protected ImageConfigResolver	imageConfigResolver
protected String	imagePullPolicy
protected boolean	keepContainer
protected Logger	log
protected org.apache.maven.project.MavenProject	project
protected String	registry
protected boolean	removeVolumes
protected ServiceHubFactory	serviceHubFactory
protected org.apache.maven.execution.MavenSession	session
protected org.apache.maven.settings.Settings	settings
protected boolean	skipExtendedAuth Skip extended authentication
protected boolean	useColor
protected boolean	verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDockerMojo()

Method Summary

Modifier and Type	Method and Description
void	contextualize(org.codehaus.plexus.context.Context context)
List<ImageConfiguration>	customizeConfig(List<ImageConfiguration> imageConfigs)
void	execute() Entry point for this plugin.
protected abstract void	executeInternal(ServiceHub serviceHub) Hook for subclass for doing the real job
protected Date	getBuildTimestamp() Get the current build timestamp.
protected File	getBuildTimestampFile()
protected DockerAccessFactory.DockerAccessContext	getDockerAccessContext()
ImagePullManager	getImagePullManager(String imagePullPolicy, String autoPull)
protected LogDispatcher	getLogDispatcher(ServiceHub hub)
protected String	getLogPrefix() Log prefix to use when doing the logs
protected PomLabel	getPomLabel()
protected Date	getReferenceDate()
protected RegistryService.RegistryConfig	getRegistryConfig(String specificRegistry)
protected List<ImageConfiguration>	getResolvedImages() Get all images to use.
protected List<VolumeConfiguration>	getVolumes() Get all volumes which are defined separately from the images
protected boolean	isDockerAccessRequired() Override this if your mojo doesnt require access to a Docker host (like creating and attaching docker tar archives)

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

CONTEXT_KEY_START_CALLED

public static final String CONTEXT_KEY_START_CALLED

See Also:

Constant Field Values

CONTEXT_KEY_LOG_DISPATCHER

public static final String CONTEXT_KEY_LOG_DISPATCHER

See Also:

Constant Field Values

CONTEXT_KEY_BUILD_TIMESTAMP

public static final String CONTEXT_KEY_BUILD_TIMESTAMP

See Also:

Constant Field Values

DOCKER_BUILD_TIMESTAMP

public static final String DOCKER_BUILD_TIMESTAMP

See Also:

Constant Field Values

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

session

@Parameter(property="session")
protected org.apache.maven.execution.MavenSession session

execution

@Parameter(property="mojoExecution")
protected org.apache.maven.plugin.MojoExecution execution

imageConfigResolver

@Component
protected ImageConfigResolver imageConfigResolver

serviceHubFactory

@Component
protected ServiceHubFactory serviceHubFactory

dockerAccessFactory

@Component
protected DockerAccessFactory dockerAccessFactory

autoPull

@Parameter(property="docker.autoPull")
protected String autoPull

imagePullPolicy

@Parameter(property="docker.imagePullPolicy")
protected String imagePullPolicy

keepContainer

@Parameter(property="docker.keepContainer",
           defaultValue="false")
protected boolean keepContainer

removeVolumes

@Parameter(property="docker.removeVolumes",
           defaultValue="false")
protected boolean removeVolumes

useColor

@Parameter(property="docker.useColor",
           defaultValue="true")
protected boolean useColor

verbose

@Parameter(property="docker.verbose",
           defaultValue="false")
protected boolean verbose

registry

@Parameter(property="docker.registry")
protected String registry

skipExtendedAuth

@Parameter(property="docker.skip.extendedAuth",
           defaultValue="false")
protected boolean skipExtendedAuth

Skip extended authentication

log

protected Logger log

Constructor Detail

AbstractDockerMojo

public AbstractDockerMojo()

Method Detail

execute

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

Entry point for this plugin. It will set up the helper class and then calls executeInternal(ServiceHub) which must be implemented by subclass.

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDockerAccessContext

protected DockerAccessFactory.DockerAccessContext getDockerAccessContext()

getRegistryConfig

protected RegistryService.RegistryConfig getRegistryConfig(String specificRegistry)
                                                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuildTimestamp

protected Date getBuildTimestamp()
                          throws org.apache.maven.plugin.MojoExecutionException

Get the current build timestamp. this has either already been created by a previous call or a new current date is created

Returns:

timestamp to use

Throws:

org.apache.maven.plugin.MojoExecutionException

getReferenceDate

protected Date getReferenceDate()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuildTimestampFile

protected File getBuildTimestampFile()

getLogPrefix

protected String getLogPrefix()

Log prefix to use when doing the logs

Returns:

customizeConfig

public List<ImageConfiguration> customizeConfig(List<ImageConfiguration> imageConfigs)

Specified by:

customizeConfig in interface ConfigHelper.Customizer

isDockerAccessRequired

protected boolean isDockerAccessRequired()

Override this if your mojo doesnt require access to a Docker host (like creating and attaching docker tar archives)

Returns:

true as the default value

executeInternal

protected abstract void executeInternal(ServiceHub serviceHub)
                                 throws DockerAccessException,
                                        ExecException,
                                        org.apache.maven.plugin.MojoExecutionException

Hook for subclass for doing the real job

Parameters:

serviceHub - context for accessing backends

Throws:

DockerAccessException

ExecException

org.apache.maven.plugin.MojoExecutionException

getResolvedImages

protected List<ImageConfiguration> getResolvedImages()

Get all images to use. Can be restricted via -Ddocker.filter to pick a one or more images. The values are taken as comma separated list.

Returns:

list of image configuration to be use. Can be empty but never null.

getVolumes

protected List<VolumeConfiguration> getVolumes()

Get all volumes which are defined separately from the images

Returns:

defined volumes

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

getPomLabel

protected PomLabel getPomLabel()

getLogDispatcher

protected LogDispatcher getLogDispatcher(ServiceHub hub)

getImagePullManager

public ImagePullManager getImagePullManager(String imagePullPolicy,
                                            String autoPull)