Package io.fabric8.maven.docker

Class StopMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.fabric8.maven.docker.AbstractDockerMojo

io.fabric8.maven.docker.StopMojo

All Implemented Interfaces:

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

@Mojo(name="stop",
      defaultPhase=POST_INTEGRATION_TEST)
public class StopMojo
extends AbstractDockerMojo

Mojo for stopping containers. If called together with docker:start (i.e. when configured for integration testing in a lifefcycle phase), then only the container started by this goal will be stopped and removed by default (this can be tuned with the system property docker.keepContainer). If this goal is called standalone, then all containers are stopped, for which images has been configured in the pom.xml

Since:

26.03.14

Author:

roland

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoCreateCustomNetworks	Whether to create the customs networks (user-defined bridge networks) before starting automatically
protected boolean	skip

Fields inherited from class io.fabric8.maven.docker.AbstractDockerMojo

archive, autoPull, buildArgs, CONTEXT_KEY_BUILD_TIMESTAMP, CONTEXT_KEY_LOG_DISPATCHER, CONTEXT_KEY_START_CALLED, DOCKER_BUILD_TIMESTAMP, dockerAccessFactory, execution, imageConfigResolver, imagePullPolicy, jib, jibImageFormat, keepContainer, log, mavenFileFilter, mavenFilterReader, outputDirectory, packaging, project, reactorProjects, registry, removeVolumes, serviceHubFactory, session, settings, skipExtendedAuth, skipPom, sourceDirectory, useColor, verbose

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

ROLE

Constructor Summary

Constructors

Constructor	Description
StopMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Entry point for this plugin.
protected void	executeInternal(ServiceHub hub)	Hook for subclass for doing the real job

Methods inherited from class io.fabric8.maven.docker.AbstractDockerMojo

contextualize, createMojoParameters, createProjectPaths, customizeConfig, getBuildTimestamp, getBuildTimestampFile, getContainerNameMatcher, getContainersForPattern, getDockerAccessContext, getGavLabel, getImageNameMatcher, getImagePullManager, getLogDispatcher, getLogPrefix, getReferenceDate, getRegistryConfig, getResolvedImages, getVolumes, invokedTogetherWithDockerStart, isDockerAccessRequired, pullImage, shouldSkipPom

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

autoCreateCustomNetworks

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

Whether to create the customs networks (user-defined bridge networks) before starting automatically

skip

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

Constructor Detail

StopMojo

public StopMojo()

Method Detail

execute

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

Description copied from class: AbstractDockerMojo

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

Specified by:

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

Overrides:

execute in class AbstractDockerMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeInternal

protected void executeInternal(ServiceHub hub)
                        throws org.apache.maven.plugin.MojoExecutionException,
                               IOException,
                               ExecException

Description copied from class: AbstractDockerMojo

Hook for subclass for doing the real job

Specified by:

executeInternal in class AbstractDockerMojo

Parameters:

hub - context for accessing backends

Throws:

org.apache.maven.plugin.MojoExecutionException

IOException

ExecException