com.spotify.docker

Class AbstractDockerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.spotify.docker.AbstractDockerMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildMojo, PushMojo, RemoveImageMojo, TagMojo

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

Field Summary

Fields

Modifier and Type	Field and Description
private String	dockerHost URL of the docker host as specified in pom.xml.
protected org.apache.maven.plugin.MojoExecution	execution
private String	registryUrl
private int	retryPushCount Number of retries for failing pushes, defaults to 5.
private int	retryPushTimeout Retry timeout for failing pushes, defaults to 10 seconds.
private org.sonatype.plexus.components.sec.dispatcher.SecDispatcher	secDispatcher https://issues.apache.org/jira/browse/MNG-4384
private String	serverId
protected org.apache.maven.execution.MavenSession	session
private org.apache.maven.settings.Settings	settings The system settings for Maven.

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 com.spotify.docker.client.messages.AuthConfig	authConfig() Builds the AuthConfig object from server details.
void	execute()
protected abstract void	execute(com.spotify.docker.client.DockerClient dockerClient)
protected com.spotify.docker.client.DefaultDockerClient.Builder	getBuilder()
private String	getEmail(org.apache.maven.settings.Server server) Get the email from the server configuration in ~/.m2/settings.xml.
int	getRetryPushCount()
int	getRetryPushTimeout()
private boolean	incompleteAuthSettings(String username, String password, String email) Checks for incomplete private Docker registry authorization settings.
protected String	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

session

@Component(role=org.apache.maven.execution.MavenSession.class)
protected org.apache.maven.execution.MavenSession session

execution

@Component(role=org.apache.maven.plugin.MojoExecution.class)
protected org.apache.maven.plugin.MojoExecution execution

settings

@Component
private org.apache.maven.settings.Settings settings

The system settings for Maven. This is the instance resulting from merging global and user-level settings files.

secDispatcher

@Component(role=org.sonatype.plexus.components.sec.dispatcher.SecDispatcher.class,
           hint="mng-4384")
private org.sonatype.plexus.components.sec.dispatcher.SecDispatcher secDispatcher

https://issues.apache.org/jira/browse/MNG-4384

dockerHost

@Parameter(property="dockerHost")
private String dockerHost

URL of the docker host as specified in pom.xml.

serverId

@Parameter(property="serverId")
private String serverId

registryUrl

@Parameter(property="registryUrl")
private String registryUrl

retryPushCount

@Parameter(property="retryPushCount",
           defaultValue="5")
private int retryPushCount

Number of retries for failing pushes, defaults to 5.

retryPushTimeout

@Parameter(property="retryPushTimeout",
           defaultValue="10000")
private int retryPushTimeout

Retry timeout for failing pushes, defaults to 10 seconds.

Constructor Detail

AbstractDockerMojo

AbstractDockerMojo()

Method Detail

getRetryPushTimeout

public int getRetryPushTimeout()

getRetryPushCount

public int getRetryPushCount()

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getBuilder

protected com.spotify.docker.client.DefaultDockerClient.Builder getBuilder()
                                                                    throws com.spotify.docker.client.DockerCertificateException

Throws:

com.spotify.docker.client.DockerCertificateException

execute

protected abstract void execute(com.spotify.docker.client.DockerClient dockerClient)
                         throws Exception

Throws:

Exception

rawDockerHost

protected String rawDockerHost()

getEmail

private String getEmail(org.apache.maven.settings.Server server)

Get the email from the server configuration in ~/.m2/settings.xml.

 
   
     my-private-docker-registry
     [...]
     
       foo@bar.com
     
   
 
 

The above settings.xml would return "foo@bar.com".

Parameters:

server - Server

Returns:

email string.

incompleteAuthSettings

private boolean incompleteAuthSettings(String username,
                                       String password,
                                       String email)

Checks for incomplete private Docker registry authorization settings.

Parameters:

username - Auth username.

password - Auth password.

email - Auth email.

Returns:

boolean true if any of the three credentials are present but not all. False otherwise.

authConfig

protected com.spotify.docker.client.messages.AuthConfig authConfig()
                                                            throws org.apache.maven.plugin.MojoExecutionException,
                                                                   org.sonatype.plexus.components.sec.dispatcher.SecDispatcherException

Builds the AuthConfig object from server details.

Returns:

AuthConfig

Throws:

org.apache.maven.plugin.MojoExecutionException

org.sonatype.plexus.components.sec.dispatcher.SecDispatcherException