io.fabric8.maven.docker

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.docker.AbstractDockerMojo

All Implemented Interfaces:

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, StartMojo, StopMojo

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

Base class for this plugin.

Since:

26.03.14

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION
protected String	autoPull
static String	CONTEXT_KEY_LOG_DISPATCHER
static String	CONTEXT_KEY_START_CALLED
static String	DOCKER_HTTPS_PORT
protected ImageConfigResolver	imageConfigResolver
protected boolean	keepContainer
protected Logger	log
protected String	portPropertyFile
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	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
protected void	checkImageWithAutoPull(ServiceHub hub, String image, String registry, boolean autoPullAlwaysAllowed) Check an image, and, if autoPull is set to true, fetch it.
void	contextualize(org.codehaus.plexus.context.Context context)
void	execute() Entry point for this plugin.
protected abstract void	executeInternal(ServiceHub serviceHub) Hook for subclass for doing the real job
protected String	getConfiguredRegistry(ImageConfiguration imageConfig, String specificRegistry) Try to get the registry from various configuration parameters
protected List<ImageConfiguration>	getImages() Get all images to use.
protected LogDispatcher	getLogDispatcher(ServiceHub hub)
protected PomLabel	getPomLabel()
protected boolean	isDockerAccessRequired() Override this if your mojo doesnt require access to a Docker host (like creating and attaching docker tar archives)
protected boolean	matchesConfiguredImages(String imageList, ImageConfiguration imageConfig)
protected AuthConfig	prepareAuthConfig(ImageName image, String configuredRegistry, boolean isPush)

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

DOCKER_HTTPS_PORT

public static final String DOCKER_HTTPS_PORT

See Also:

Constant Field Values

API_VERSION

public static final String API_VERSION

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(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

imageConfigResolver

@Component
protected ImageConfigResolver imageConfigResolver

serviceHubFactory

@Component
protected ServiceHubFactory serviceHubFactory

autoPull

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

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

portPropertyFile

@Parameter
protected String portPropertyFile

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

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,
                                        org.apache.maven.plugin.MojoExecutionException

Hook for subclass for doing the real job

Parameters:

serviceHub - context for accessing backends

Throws:

DockerAccessException

org.apache.maven.plugin.MojoExecutionException

getImages

protected List<ImageConfiguration> getImages()

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

Returns:

list of image configuration to use

matchesConfiguredImages

protected boolean matchesConfiguredImages(String imageList,
                                          ImageConfiguration imageConfig)

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()

prepareAuthConfig

protected AuthConfig prepareAuthConfig(ImageName image,
                                       String configuredRegistry,
                                       boolean isPush)
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getLogDispatcher

protected LogDispatcher getLogDispatcher(ServiceHub hub)

getConfiguredRegistry

protected String getConfiguredRegistry(ImageConfiguration imageConfig,
                                       String specificRegistry)

Try to get the registry from various configuration parameters

Parameters:

imageConfig - image config which might contain the registry

specificRegistry - specific registry

Returns:

the registry found or null if none could be extracted

checkImageWithAutoPull

protected void checkImageWithAutoPull(ServiceHub hub,
                                      String image,
                                      String registry,
                                      boolean autoPullAlwaysAllowed)
                               throws DockerAccessException,
                                      org.apache.maven.plugin.MojoExecutionException

Check an image, and, if autoPull is set to true, fetch it. Otherwise if the image is not existent, throw an error

Parameters:

hub - access object to lookup an image (if autoPull is enabled)

image - image name

registry - optional registry which is used if the image itself doesn't have a registry.

autoPullAlwaysAllowed - whether an unconditional autopull is allowed.

Throws:

DockerAccessException

org.apache.maven.plugin.MojoExecutionException