com.cloudbees.jenkins.plugins.docker_build_env

Class Docker

java.lang.Object

com.cloudbees.jenkins.plugins.docker_build_env.Docker

All Implemented Interfaces:

Closeable, AutoCloseable

public class Docker
extends Object
implements Closeable

Author:

Nicolas De Loof

Constructor Summary

Constructors

Constructor and Description
Docker(org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint dockerHost, String dockerInstallation, String credentialsId, hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.TaskListener listener, boolean verbose, boolean privileged)

Method Summary

Modifier and Type	Method and Description
String	buildImage(hudson.FilePath workspace, String dockerfile, boolean forcePull)
void	close()
void	executeIn(String container, String userId, hudson.Launcher.ProcStarter starter, hudson.EnvVars environment)
hudson.EnvVars	getEnv(String container, hudson.Launcher launcher)
boolean	hasImage(String image)
void	kill(String container)
boolean	pullImage(String image)
String	runDetached(String image, String workdir, Map<String,String> volumes, Map<Integer,Integer> ports, Map<String,String> links, hudson.EnvVars environment, Set sensitiveBuildVariables, String net, String memory, String cpu, String... command)
void	setupCredentials(hudson.model.AbstractBuild build)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Docker

public Docker(org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint dockerHost,
              String dockerInstallation,
              String credentialsId,
              hudson.model.AbstractBuild build,
              hudson.Launcher launcher,
              hudson.model.TaskListener listener,
              boolean verbose,
              boolean privileged)
       throws IOException,
              InterruptedException

Throws:

IOException

InterruptedException

Method Detail

setupCredentials

public void setupCredentials(hudson.model.AbstractBuild build)
                      throws IOException,
                             InterruptedException

Throws:

IOException

InterruptedException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

hasImage

public boolean hasImage(String image)
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException

pullImage

public boolean pullImage(String image)
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

buildImage

public String buildImage(hudson.FilePath workspace,
                         String dockerfile,
                         boolean forcePull)
                  throws IOException,
                         InterruptedException

Throws:

IOException

InterruptedException

kill

public void kill(String container)
          throws IOException,
                 InterruptedException

Throws:

IOException

InterruptedException

runDetached

public String runDetached(String image,
                          String workdir,
                          Map<String,String> volumes,
                          Map<Integer,Integer> ports,
                          Map<String,String> links,
                          hudson.EnvVars environment,
                          Set sensitiveBuildVariables,
                          String net,
                          String memory,
                          String cpu,
                          String... command)
                   throws IOException,
                          InterruptedException

Throws:

IOException

InterruptedException

getEnv

public hudson.EnvVars getEnv(String container,
                             hudson.Launcher launcher)
                      throws IOException,
                             InterruptedException

Throws:

IOException

InterruptedException

executeIn

public void executeIn(String container,
                      String userId,
                      hudson.Launcher.ProcStarter starter,
                      hudson.EnvVars environment)
               throws IOException,
                      InterruptedException

Throws:

IOException

InterruptedException