org.jenkinsci.plugins.docker.commons

Class DockerServerEndpoint

java.lang.Object

hudson.model.AbstractDescribableImpl<DockerServerEndpoint>

org.jenkinsci.plugins.docker.commons.DockerServerEndpoint

All Implemented Interfaces:

hudson.model.Describable<DockerServerEndpoint>

public class DockerServerEndpoint
extends hudson.model.AbstractDescribableImpl<DockerServerEndpoint>

Encapsulates the endpoint of Docker daemon and how to interact with it.

As Describable it comes with pre-baked configuration form that you can use in your builders/publishers/etc that interact with Docker daemon.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockerServerEndpoint.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
DockerServerEndpoint(String uri, String credentialsId)

Method Summary

Modifier and Type	Method and Description
String	getCredentialsId() ID of the credentials used to talk to this endpoint.
String	getUri() Gets the endpoint in URI, such as "unix:///var/run/docker.sock".
KeyMaterial	materialize(hudson.model.AbstractBuild build) Makes the key materials available locally for the on-going build and returns KeyMaterial that gives you the parameters needed to access it.
KeyMaterial	materialize(hudson.FilePath dir, DockerServerCredentials credentials) The most raw form of the materialize(...) family of methods in case you need to control every aspect of it.
KeyMaterial	materialize(hudson.model.Item context, hudson.remoting.VirtualChannel target) Makes the key materials available locally and returns KeyMaterial that gives you the parameters needed to access it.
String	toString()

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerServerEndpoint

@DataBoundConstructor
public DockerServerEndpoint(String uri,
                                                  String credentialsId)

Method Detail

getUri

@Nullable
public String getUri()

Gets the endpoint in URI, such as "unix:///var/run/docker.sock".

Null to indicate whatever Docker picks by default.

getCredentialsId

@Nullable
public String getCredentialsId()

ID of the credentials used to talk to this endpoint.

materialize

public KeyMaterial materialize(hudson.model.AbstractBuild build)
                        throws IOException,
                               InterruptedException

Makes the key materials available locally for the on-going build and returns KeyMaterial that gives you the parameters needed to access it.

Throws:

IOException

InterruptedException

materialize

public KeyMaterial materialize(hudson.model.Item context,
                               hudson.remoting.VirtualChannel target)
                        throws IOException,
                               InterruptedException

Makes the key materials available locally and returns KeyMaterial that gives you the parameters needed to access it.

Throws:

IOException

InterruptedException

materialize

public KeyMaterial materialize(hudson.FilePath dir,
                               @Nullable
                               DockerServerCredentials credentials)
                        throws IOException,
                               InterruptedException

The most raw form of the materialize(...) family of methods in case you need to control every aspect of it.

Throws:

IOException

InterruptedException

toString

public String toString()

Overrides:

toString in class Object