org.jenkinsci.plugins.docker.commons.credentials

Class DockerServerEndpoint

java.lang.Object

hudson.model.AbstractDescribableImpl<DockerServerEndpoint>

org.jenkinsci.plugins.docker.commons.credentials.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
boolean	equals(Object obj)
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".
int	hashCode()
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.AbstractBuild build) Deprecated. Call newKeyMaterialFactory(Run, VirtualChannel)
KeyMaterialFactory	newKeyMaterialFactory(hudson.FilePath dir, DockerServerCredentials credentials) Create a KeyMaterialFactory for connecting to the docker server/host.
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.remoting.VirtualChannel target) Deprecated. Call newKeyMaterialFactory(Run, VirtualChannel)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Run context, hudson.remoting.VirtualChannel target) Makes the key materials available locally and returns KeyMaterialFactory 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, finalize, getClass, 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.

newKeyMaterialFactory

@Deprecated
public KeyMaterialFactory newKeyMaterialFactory(@Nonnull
                                                             hudson.model.AbstractBuild build)
                                                      throws IOException,
                                                             InterruptedException

Deprecated. Call newKeyMaterialFactory(Run, VirtualChannel)

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

Throws:

IOException

InterruptedException

newKeyMaterialFactory

@Deprecated
public KeyMaterialFactory newKeyMaterialFactory(@Nonnull
                                                             hudson.model.Item context,
                                                             @Nonnull
                                                             hudson.remoting.VirtualChannel target)
                                                      throws IOException,
                                                             InterruptedException

Deprecated. Call newKeyMaterialFactory(Run, VirtualChannel)

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

Throws:

IOException

InterruptedException

newKeyMaterialFactory

public KeyMaterialFactory newKeyMaterialFactory(@Nonnull
                                                hudson.model.Run context,
                                                @Nonnull
                                                hudson.remoting.VirtualChannel target)
                                         throws IOException,
                                                InterruptedException

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

Throws:

IOException

InterruptedException

newKeyMaterialFactory

public KeyMaterialFactory newKeyMaterialFactory(hudson.FilePath dir,
                                                @Nullable
                                                DockerServerCredentials credentials)
                                         throws IOException,
                                                InterruptedException

Create a KeyMaterialFactory for connecting to the docker server/host.

Throws:

IOException

InterruptedException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object