net.wouterdanes.docker.maven

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

net.wouterdanes.docker.maven.AbstractDockerMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractPreVerifyDockerMojo, PushImageMojo, TagImageMojo, VerifyMojo

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

Base class for all Mojos with shared functionality

Field Summary

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	attachTag(String imageId, String nameAndTag)
protected void	cleanUpStartedContainers()
protected abstract void	doExecute()
protected void	enqueueForPushing(String imageId, ImageBuildConfiguration imageConfig)
protected void	enqueueForPushing(String imageId, Optional<String> nameAndTag)
protected void	enqueueForPushing(String imageId, Optional<String> nameAndTag, Optional<String> registry)
protected void	enqueueForPushingToRegistry(String imageId, Optional<String> nameAndTag, String registry)
void	execute()
protected Optional<BuiltImageInfo>	getBuiltImageForStartId(String imageId)
protected Collection<BuiltImageInfo>	getBuiltImages()
protected Credentials	getCredentials()
protected DockerProvider	getDockerProvider()
protected List<PushableImage>	getImagesToPush()
protected Optional<StartedContainerInfo>	getInfoForContainerStartId(String startId)
protected List<DockerPluginError>	getPluginErrors()
protected Collection<StartedContainerInfo>	getStartedContainers()
protected void	handleDockerException(String message, DockerException e) Common method for re-throwing a DockerException as a MojoFailureException with a more specific error message.
protected void	registerBuiltImage(String imageId, ImageBuildConfiguration imageConfig)
protected void	registerPluginError(DockerPluginError error)
protected void	registerStartedContainer(String containerId, ContainerInspectionResult container)
void	setProviderName(String providerName)
void	setSkip(boolean skip)

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

Constructor Detail

AbstractDockerMojo

public AbstractDockerMojo()

Method Detail

setProviderName

public void setProviderName(String providerName)

setSkip

public void setSkip(boolean skip)

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doExecute

protected abstract void doExecute()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

registerStartedContainer

protected void registerStartedContainer(String containerId,
                                        ContainerInspectionResult container)

getStartedContainers

protected Collection<StartedContainerInfo> getStartedContainers()

getInfoForContainerStartId

protected Optional<StartedContainerInfo> getInfoForContainerStartId(String startId)

registerBuiltImage

protected void registerBuiltImage(String imageId,
                                  ImageBuildConfiguration imageConfig)
                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getBuiltImages

protected Collection<BuiltImageInfo> getBuiltImages()

cleanUpStartedContainers

protected void cleanUpStartedContainers()

getDockerProvider

protected DockerProvider getDockerProvider()

getCredentials

protected Credentials getCredentials()

getBuiltImageForStartId

protected Optional<BuiltImageInfo> getBuiltImageForStartId(String imageId)

registerPluginError

protected void registerPluginError(DockerPluginError error)

getPluginErrors

protected List<DockerPluginError> getPluginErrors()

enqueueForPushing

protected void enqueueForPushing(String imageId,
                                 ImageBuildConfiguration imageConfig)
                          throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

enqueueForPushing

protected void enqueueForPushing(String imageId,
                                 Optional<String> nameAndTag,
                                 Optional<String> registry)
                          throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

enqueueForPushingToRegistry

protected void enqueueForPushingToRegistry(String imageId,
                                           Optional<String> nameAndTag,
                                           String registry)
                                    throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

enqueueForPushing

protected void enqueueForPushing(String imageId,
                                 Optional<String> nameAndTag)

getImagesToPush

protected List<PushableImage> getImagesToPush()

attachTag

protected void attachTag(String imageId,
                         String nameAndTag)
                  throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

handleDockerException

protected void handleDockerException(String message,
                                     DockerException e)
                              throws org.apache.maven.plugin.MojoFailureException

Common method for re-throwing a DockerException as a MojoFailureException with a more specific error message. Extract into a common, template method in this base class to allow pre "verify" Mojos to handle errors differently.

Parameters:

message - The message for the exception

e - The Docker Exception

Throws:

org.apache.maven.plugin.MojoFailureException - to indicate Plugin failure