BuildMojo (docker-maven-plugin 0.4.12 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - com.spotify.docker.AbstractDockerMojo
  - - com.spotify.docker.BuildMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="build")
public class BuildMojo
extends AbstractDockerMojo
```
Used to build docker images.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`baseImage` The base image to use.
`private Map<String,String>`	`buildArgs`
`protected String`	`buildDirectory` All resources will be copied to this directory before building the image.
`private String`	`cmd` The cmd command for the image.
`private String`	`defaultProfile`
`private String`	`dockerDirectory` Directory containing the Dockerfile.
`private String`	`entryPoint` The entry point of the image.
`private Map<String,String>`	`env`
`private List<String>`	`exposes`
`private Set<String>`	`exposesSet`
`private org.apache.maven.plugin.PluginParameterExpressionEvaluator`	`expressionEvaluator`
`private boolean`	`forceTags` Flag to use force option while tagging.
`private String`	`imageName` Built image will be given this name.
`private List<String>`	`imageTags` Additional tags to tag the image with.
`private String[]`	`labels` The labels for the image
`private String`	`maintainer` The maintainer of the image.
`private org.apache.maven.project.MavenProject`	`mavenProject`
`private boolean`	`noCache` Set to true to pass the `--no-cache` flag to the Docker daemon when building an image.
`private static com.fasterxml.jackson.databind.ObjectMapper`	`OBJECT_MAPPER` Json Object Mapper to encode arguments map
`private String`	`profile`
`private boolean`	`pullOnBuild` Flag to attempt to pull base images even if older images exists locally.
`private boolean`	`pushImage` Flag to push image after it is built.
`private boolean`	`pushImageTag` Flag to push image using their tags after it is built.
`private List<org.apache.maven.model.Resource>`	`resources` Resources to include in the build.
`private List<String>`	`runList`
`private List<String>`	`runs` The run commands for the image.
`private boolean`	`skipDockerBuild` Flag to skip docker build, making build goal a no-op.
`private boolean`	`squashRunCommands` Flag to squash all run commands into one layer.
`protected String`	`tagInfoFile` Path to JSON file to write when tagging images.
`private static char`	`UNIX_SEPARATOR` The Unix separator character.
`private boolean`	`useGitCommitId` If specified as true, a tag will be generated consisting of the first 7 characters of the most recent git commit ID, resulting in something like `image:df8e8e6`.
`private String`	`user` The user for the image.
`private String[]`	`volumes` The volumes for the image
`private static char`	`WINDOWS_SEPARATOR` The Windows separator character.
`private String`	`workdir` The workdir for the image.

Fields inherited from class com.spotify.docker.AbstractDockerMojo
execution, session

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

Constructor Summary

Constructors
Constructor and Description

BuildMojo()

BuildMojo(String defaultProfile)

Constructors
Constructor and Description
`BuildMojo()`
`BuildMojo(String defaultProfile)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`buildImage(com.spotify.docker.client.DockerClient docker, String buildDir, com.spotify.docker.client.DockerClient.BuildParam... buildParams)`
`private com.spotify.docker.client.DockerClient.BuildParam[]`	`buildParams()`
`private List<String>`	`copyResources(String destination)`
`private void`	`createDockerFile(String directory, List<String> filesToAdd)`
`private File`	`createImageArtifact(org.apache.maven.artifact.Artifact mainArtifact, DockerBuildInformation buildInfo)`
`protected void`	`execute(com.spotify.docker.client.DockerClient docker)`
`private String`	`expand(String raw)`
`private String`	`get(String override, com.typesafe.config.Config config, String path)`
`private String`	`getDestination()`
`boolean`	`getForceTags()`
`String`	`getImageName()`
`boolean`	`getPushImage()`
`boolean`	`getPushImageTag()`
`boolean`	`isSkipDockerBuild()`
`private void`	`loadProfile()`
`private String`	`normalizeDest(String filePath)`
`static String`	`separatorsToUnix(String path)` Converts all separators to the Unix separator of forward slash.
`private void`	`tagImage(com.spotify.docker.client.DockerClient docker, boolean forceTags)`
`private void`	`validateParameters()`

Methods inherited from class com.spotify.docker.AbstractDockerMojo
authConfig, buildDockerClient, dockerCertificates, execute, getBuilder, getRetryPushCount, getRetryPushTimeout, isSkipDocker, isSkipDockerPush, rawDockerHost

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
- UNIX_SEPARATOR
```
private static final char UNIX_SEPARATOR
```
  The Unix separator character.
  
  See Also:
  
  Constant Field Values
- WINDOWS_SEPARATOR
```
private static final char WINDOWS_SEPARATOR
```
  The Windows separator character.
  
  See Also:
  
  Constant Field Values
- OBJECT_MAPPER
```
private static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER
```
  Json Object Mapper to encode arguments map
- dockerDirectory
```
@Parameter(property="dockerDirectory")
private String dockerDirectory
```
  Directory containing the Dockerfile. If the value is not set, the plugin will generate a Dockerfile using the required baseImage value, plus the optional entryPoint, cmd and maintainer values. If this value is set the plugin will use the Dockerfile in the specified folder.
- skipDockerBuild
```
@Parameter(property="skipDockerBuild",
           defaultValue="false")
private boolean skipDockerBuild
```
  Flag to skip docker build, making build goal a no-op. This can be useful when docker:build is bound to package goal, and you want to build a jar but not a container. Defaults to false.
- pullOnBuild
```
@Parameter(property="pullOnBuild",
           defaultValue="false")
private boolean pullOnBuild
```
  Flag to attempt to pull base images even if older images exists locally. Sends the equivalent of `--pull=true` to Docker daemon when building the image.
- noCache
```
@Parameter(property="noCache",
           defaultValue="false")
private boolean noCache
```
  Set to true to pass the `--no-cache` flag to the Docker daemon when building an image.
- pushImage
```
@Parameter(property="pushImage",
           defaultValue="false")
private boolean pushImage
```
  Flag to push image after it is built. Defaults to false.
- pushImageTag
```
@Parameter(property="pushImageTag",
           defaultValue="false")
private boolean pushImageTag
```
  Flag to push image using their tags after it is built. Defaults to false.
- forceTags
```
@Parameter(property="forceTags",
           defaultValue="false")
private boolean forceTags
```
  Flag to use force option while tagging. Defaults to false.
- maintainer
```
@Parameter(property="dockerMaintainer")
private String maintainer
```
  The maintainer of the image. Ignored if dockerDirectory is set.
- baseImage
```
@Parameter(property="dockerBaseImage")
private String baseImage
```
  The base image to use. Ignored if dockerDirectory is set.
- entryPoint
```
@Parameter(property="dockerEntryPoint")
private String entryPoint
```
  The entry point of the image. Ignored if dockerDirectory is set.
- volumes
```
@Parameter(property="dockerVolumes")
private String[] volumes
```
  The volumes for the image
- labels
```
@Parameter(property="dockerLabels")
private String[] labels
```
  The labels for the image
- cmd
```
@Parameter(property="dockerCmd")
private String cmd
```
  The cmd command for the image. Ignored if dockerDirectory is set.
- workdir
```
@Parameter(property="workdir")
private String workdir
```
  The workdir for the image. Ignored if dockerDirectory is set
- user
```
@Parameter(property="user")
private String user
```
  The user for the image. Ignored if dockerDirectory is set
- runs
```
@Parameter(property="dockerRuns")
private List<String> runs
```
  The run commands for the image.
- runList
```
private List<String> runList
```
- squashRunCommands
```
@Parameter(property="squashRunCommands",
           defaultValue="false")
private boolean squashRunCommands
```
  Flag to squash all run commands into one layer. Defaults to false.
- buildDirectory
```
@Parameter(property="project.build.directory")
protected String buildDirectory
```
  All resources will be copied to this directory before building the image.
- profile
```
@Parameter(property="dockerBuildProfile")
private String profile
```
- tagInfoFile
```
@Parameter(property="tagInfoFile",
           defaultValue="${project.build.testOutputDirectory}/image_info.json")
protected String tagInfoFile
```
  Path to JSON file to write when tagging images. Default is ${project.build.testOutputDirectory}/image_info.json
- useGitCommitId
```
@Parameter(property="useGitCommitId",
           defaultValue="false")
private boolean useGitCommitId
```
  If specified as true, a tag will be generated consisting of the first 7 characters of the most recent git commit ID, resulting in something like image:df8e8e6. If there are any changes not yet committed, the string '.DIRTY' will be appended to the end. Note, if a tag is explicitly specified in the newName parameter, this flag will be ignored.
- resources
```
@Parameter(property="dockerResources")
private List<org.apache.maven.model.Resource> resources
```
  Resources to include in the build. Specify resources by using the standard resource elements as defined in the resources section in the pom reference. If dockerDirectory is not set, the targetPath value is the location in the container where the resource should be copied to. The value is relative to '/' in the container, and defaults to '.'. If dockerDirectory is set, targetPath is relative to the dockerDirectory, and defaults to '.'. In that case, the Dockerfile can copy the resources into the container using the ADD instruction.
- imageName
```
@Parameter(property="dockerImageName")
private String imageName
```
  Built image will be given this name.
- imageTags
```
@Parameter(property="dockerImageTags")
private List<String> imageTags
```
  Additional tags to tag the image with.
- defaultProfile
```
@Parameter(property="dockerDefaultBuildProfile")
private String defaultProfile
```
- env
```
@Parameter(property="dockerEnv")
private Map<String,String> env
```
- exposes
```
@Parameter(property="dockerExposes")
private List<String> exposes
```
- exposesSet
```
private Set<String> exposesSet
```
- mavenProject
```
@Parameter(defaultValue="${project}")
private org.apache.maven.project.MavenProject mavenProject
```
- buildArgs
```
@Parameter(property="dockerBuildArgs")
private Map<String,String> buildArgs
```
- expressionEvaluator
```
private org.apache.maven.plugin.PluginParameterExpressionEvaluator expressionEvaluator
```

Constructor Detail

BuildMojo
```
public BuildMojo()
```

BuildMojo

public BuildMojo(String defaultProfile)

Method Detail

getImageName
```
public String getImageName()
```

getPushImage
```
public boolean getPushImage()
```

getPushImageTag
```
public boolean getPushImageTag()
```

getForceTags
```
public boolean getForceTags()
```

isSkipDockerBuild
```
public boolean isSkipDockerBuild()
```

execute

protected void execute(com.spotify.docker.client.DockerClient docker)
                throws org.apache.maven.plugin.MojoExecutionException,
                       org.eclipse.jgit.api.errors.GitAPIException,
                       IOException,
                       com.spotify.docker.client.exceptions.DockerException,
                       InterruptedException

Specified by:: execute in class AbstractDockerMojo
Throws:: org.apache.maven.plugin.MojoExecutionException; org.eclipse.jgit.api.errors.GitAPIException; IOException; com.spotify.docker.client.exceptions.DockerException; InterruptedException

getDestination
```
private String getDestination()
```

createImageArtifact

private File createImageArtifact(org.apache.maven.artifact.Artifact mainArtifact,
                                 DockerBuildInformation buildInfo)
                          throws IOException

Throws:: IOException

loadProfile

private void loadProfile()
                  throws org.apache.maven.plugin.MojoExecutionException

Throws:: org.apache.maven.plugin.MojoExecutionException

get

private String get(String override,
                   com.typesafe.config.Config config,
                   String path)
            throws org.apache.maven.plugin.MojoExecutionException

Throws:: org.apache.maven.plugin.MojoExecutionException

expand

private String expand(String raw)
               throws org.apache.maven.plugin.MojoExecutionException

Throws:: org.apache.maven.plugin.MojoExecutionException

validateParameters

private void validateParameters()
                         throws org.apache.maven.plugin.MojoExecutionException

Throws:: org.apache.maven.plugin.MojoExecutionException

buildImage

private void buildImage(com.spotify.docker.client.DockerClient docker,
                        String buildDir,
                        com.spotify.docker.client.DockerClient.BuildParam... buildParams)
                 throws org.apache.maven.plugin.MojoExecutionException,
                        com.spotify.docker.client.exceptions.DockerException,
                        IOException,
                        InterruptedException

Throws:: org.apache.maven.plugin.MojoExecutionException; com.spotify.docker.client.exceptions.DockerException; IOException; InterruptedException

tagImage

private void tagImage(com.spotify.docker.client.DockerClient docker,
                      boolean forceTags)
               throws com.spotify.docker.client.exceptions.DockerException,
                      InterruptedException,
                      org.apache.maven.plugin.MojoExecutionException

Throws:: com.spotify.docker.client.exceptions.DockerException; InterruptedException; org.apache.maven.plugin.MojoExecutionException

createDockerFile

private void createDockerFile(String directory,
                              List<String> filesToAdd)
                       throws IOException

Throws:: IOException

normalizeDest

private String normalizeDest(String filePath)

copyResources

private List<String> copyResources(String destination)
                            throws IOException

Throws:: IOException

separatorsToUnix
```
public static String separatorsToUnix(String path)
```
Converts all separators to the Unix separator of forward slash.

Parameters:

path - the path to be changed, null ignored

Returns:

the updated path

buildParams

private com.spotify.docker.client.DockerClient.BuildParam[] buildParams()
                                                                 throws UnsupportedEncodingException,
                                                                        com.fasterxml.jackson.core.JsonProcessingException

Throws:: UnsupportedEncodingException; com.fasterxml.jackson.core.JsonProcessingException

Class BuildMojo

Field Summary

Fields inherited from class com.spotify.docker.AbstractDockerMojo

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

Constructor Summary

Method Summary

Methods inherited from class com.spotify.docker.AbstractDockerMojo

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

UNIX_SEPARATOR

WINDOWS_SEPARATOR

OBJECT_MAPPER

dockerDirectory

skipDockerBuild

pullOnBuild

noCache

pushImage

pushImageTag

forceTags

maintainer

baseImage

entryPoint

volumes

labels

cmd

workdir

user

runs

runList

squashRunCommands

buildDirectory

profile

tagInfoFile

useGitCommitId

resources

imageName

imageTags

defaultProfile

env

exposes

exposesSet

mavenProject

buildArgs

expressionEvaluator

Constructor Detail

BuildMojo

BuildMojo

Method Detail

getImageName

getPushImage

getPushImageTag

getForceTags

isSkipDockerBuild

execute

getDestination

createImageArtifact

loadProfile

get

expand

validateParameters

buildImage

tagImage

createDockerFile

normalizeDest

copyResources

separatorsToUnix

buildParams