SourceMojo (docker-maven-plugin 0.40.0 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - io.fabric8.maven.docker.AbstractDockerMojo
  - - io.fabric8.maven.docker.AbstractBuildSupportMojo
    - - io.fabric8.maven.docker.SourceMojo

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="source",
      defaultPhase=PACKAGE)
public class SourceMojo
extends AbstractBuildSupportMojo
```
Mojo for attaching one more source docker tar file to an artifact. If used in a lifecycle called 'docker-tar' the artifacts are attached without classifier. Otherwise the classifier is "docker" and, depending on the selected BuildImageSelectMode, the alias name of the build configuration.

Since:

25/10/15

Author:

roland

Field Summary
- Fields inherited from class io.fabric8.maven.docker.AbstractDockerMojo
  autoPull, CONTEXT_KEY_BUILD_TIMESTAMP, CONTEXT_KEY_LOG_DISPATCHER, CONTEXT_KEY_START_CALLED, DOCKER_BUILD_TIMESTAMP, dockerAccessFactory, execution, imageConfigResolver, imagePullPolicy, jib, jibImageFormat, keepContainer, log, outputDirectory, packaging, project, 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

SourceMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`executeInternal(ServiceHub hub)`	Hook for subclass for doing the real job
`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 io.fabric8.maven.docker.AbstractBuildSupportMojo
createMojoParameters, getBuildContext

Methods inherited from class io.fabric8.maven.docker.AbstractDockerMojo
contextualize, createProjectPaths, customizeConfig, execute, getBuildTimestamp, getBuildTimestampFile, getContainerNameMatcher, getContainersForPattern, getDockerAccessContext, getGavLabel, getImageNameMatcher, getImagePullManager, getLogDispatcher, getLogPrefix, getReferenceDate, getRegistryConfig, getResolvedImages, getVolumes, invokedTogetherWithDockerStart, 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

- Constructor Detail
  - SourceMojo
```
public SourceMojo()
```
- Method Detail
  - executeInternal
```
protected void executeInternal(ServiceHub hub)
                        throws DockerAccessException,
                               org.apache.maven.plugin.MojoExecutionException
```
    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:
    
    DockerAccessException
    
    org.apache.maven.plugin.MojoExecutionException
  - isDockerAccessRequired
```
protected boolean isDockerAccessRequired()
```
    Description copied from class: AbstractDockerMojo
    
    Override this if your mojo doesnt require access to a Docker host (like creating and attaching docker tar archives)
    
    Overrides:
    
    isDockerAccessRequired in class AbstractDockerMojo
    
    Returns:
    
    true as the default value