org.jenkinsci.plugins.docker.commons

Class DockerRegistryEndpoint

java.lang.Object

hudson.model.AbstractDescribableImpl<DockerRegistryEndpoint>

org.jenkinsci.plugins.docker.commons.DockerRegistryEndpoint

All Implemented Interfaces:

hudson.model.Describable<DockerRegistryEndpoint>

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

Encapsulates the endpoint of DockerHub 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	DockerRegistryEndpoint.DescriptorImpl

Constructor Summary

Constructors

Constructor and Description
DockerRegistryEndpoint(String urlString, String credentialsId)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCredentialsId() ID of the credentials used to talk to this endpoint.
DockerRegistryToken	getToken(hudson.model.Item context) Plugins that want to refer to a DockerRegistryCredentials should do so via ID string, and use this method to resolve it to DockerRegistryCredentials.
URL	getUrl() Gets the endpoint URL, such as "http://index.docker.io/v1/"
String	getUrlString() For stapler.
String	imageName(String userAndRepo) Decorates the repository ID like "jenkinsci/workflow-demo" with repository prefix.
KeyMaterial	materialize(hudson.model.AbstractBuild build) Makes the credentials available locally for the on-going build and returns KeyMaterial that gives you the parameters needed to access it.
KeyMaterial	materialize(hudson.model.Item context, hudson.remoting.VirtualChannel target) Makes the credentials available locally and returns KeyMaterial that gives you the parameters needed to access it.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerRegistryEndpoint

@DataBoundConstructor
public DockerRegistryEndpoint(String urlString,
                                           String credentialsId)

Method Detail

getUrl

public URL getUrl()
           throws IOException

Gets the endpoint URL, such as "http://index.docker.io/v1/"

Null to indicate whatever Docker picks by default.

Throws:

IOException

getUrlString

@Nullable
public String getUrlString()

For stapler.

getCredentialsId

@Nullable
public String getCredentialsId()

ID of the credentials used to talk to this endpoint.

getToken

@CheckForNull
public DockerRegistryToken getToken(hudson.model.Item context)

Plugins that want to refer to a DockerRegistryCredentials should do so via ID string, and use this method to resolve it to DockerRegistryCredentials.

Parameters:

context - If you are a build step trying to access DockerHub in the context of a build/job, specify that job. Otherwise null. If you are scoped to something else, you might have to interact with CredentialsProvider directly.

materialize

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

Makes the credentials 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 credentials available locally and returns KeyMaterial that gives you the parameters needed to access it.

Throws:

IOException

InterruptedException

imageName

public String imageName(String userAndRepo)
                 throws IOException

Decorates the repository ID like "jenkinsci/workflow-demo" with repository prefix.

Throws:

IOException