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 url, String credentialsId)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static DockerRegistryEndpoint	fromImageName(String s, String credentialsId) Parse the registry endpoint out of a registry:port/namespace/name:tag string as created by imageName(String).
String	getCredentialsId() ID of the credentials used to talk to this endpoint.
URL	getEffectiveUrl() Gets the endpoint URL, such as "https://index.docker.io/v1/"
DockerRegistryToken	getToken(hudson.model.Item context) Plugins that want to refer to a IdCredentials should do so via ID string, and use this method to resolve it and convert to DockerRegistryToken.
String	getUrl() For stapler.
int	hashCode()
String	imageName(String userAndRepo) Decorates the repository ID namespace/name (ie.
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.AbstractBuild build) Makes the credentials available locally for the on-going build and returns KeyMaterialFactory that gives you the parameters needed to access it.
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.remoting.VirtualChannel target) Makes the credentials 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

DockerRegistryEndpoint

@DataBoundConstructor
public DockerRegistryEndpoint(String url,
                                           String credentialsId)

Method Detail

fromImageName

public static DockerRegistryEndpoint fromImageName(String s,
                                   @CheckForNull
                                   String credentialsId)

Parse the registry endpoint out of a registry:port/namespace/name:tag string as created by imageName(String). Credentials are set to the id passed. The url is built from registry:port into https://registry:port, the same way docker push does.

Parameters:

s -

credentialsId - passed to the constructor, can be null

Returns:

The DockerRegistryEndpoint corresponding to the registry:port part of the string

Throws:

IllegalArgumentException - if string can't be parsed

getEffectiveUrl

@Nonnull
public URL getEffectiveUrl()
                    throws IOException

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

Throws:

IOException

getUrl

@Nullable
public String getUrl()

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 IdCredentials should do so via ID string, and use this method to resolve it and convert to DockerRegistryToken.

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.

newKeyMaterialFactory

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

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

Throws:

IOException

InterruptedException

newKeyMaterialFactory

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

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

Throws:

IOException

InterruptedException

imageName

public String imageName(String userAndRepo)
                 throws IOException

Decorates the repository ID namespace/name (ie. "jenkinsci/workflow-demo") with registry prefix (docker.acme.com:80/jenkinsci/workflow-demo).

Parameters:

userAndRepo - the namespace/name part to append to the registry

Returns:

the full registry:port/namespace/name string

Throws:

IOException

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