org.jenkinsci.plugins.docker.commons.credentials

Class DockerRegistryEndpoint

java.lang.Object

hudson.model.AbstractDescribableImpl<DockerRegistryEndpoint>

org.jenkinsci.plugins.docker.commons.credentials.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

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) Deprecated. Call getToken(Run)
String	getUrl() For stapler.
int	hashCode()
String	imageName(String userAndRepo) Decorates the repository ID namespace/name (ie.
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.AbstractBuild build) Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.FilePath workspace, hudson.Launcher launcher, hudson.EnvVars env, hudson.model.TaskListener listener, String dockerExecutable) Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, String dockerExecutable) Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.remoting.VirtualChannel target) Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Item context, hudson.remoting.VirtualChannel target, hudson.Launcher launcher, hudson.model.TaskListener listener) Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)
KeyMaterialFactory	newKeyMaterialFactory(hudson.model.Run context, hudson.FilePath workspace, hudson.Launcher launcher, hudson.EnvVars env, hudson.model.TaskListener listener, String dockerExecutable) 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

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

Deprecated. Call getToken(Run)

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. Implements the logic CredentialsProvider.findCredentialById(String, Class, Run, DomainRequirement...) but for an Item.

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

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

Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)

Throws:

IOException

InterruptedException

newKeyMaterialFactory

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

Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)

Throws:

IOException

InterruptedException

newKeyMaterialFactory

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

Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)

Throws:

IOException

InterruptedException

newKeyMaterialFactory

@Deprecated
public KeyMaterialFactory newKeyMaterialFactory(@CheckForNull
                                                             hudson.model.Item context,
                                                             @Nonnull
                                                             hudson.FilePath workspace,
                                                             @Nonnull
                                                             hudson.Launcher launcher,
                                                             @Nonnull
                                                             hudson.model.TaskListener listener,
                                                             @Nonnull
                                                             String dockerExecutable)
                                                      throws IOException,
                                                             InterruptedException

Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)

Throws:

IOException

InterruptedException

newKeyMaterialFactory

@Deprecated
public KeyMaterialFactory newKeyMaterialFactory(@CheckForNull
                                                             hudson.model.Item context,
                                                             @Nonnull
                                                             hudson.FilePath workspace,
                                                             @Nonnull
                                                             hudson.Launcher launcher,
                                                             @Nonnull
                                                             hudson.EnvVars env,
                                                             @Nonnull
                                                             hudson.model.TaskListener listener,
                                                             @Nonnull
                                                             String dockerExecutable)
                                                      throws IOException,
                                                             InterruptedException

Deprecated. Call newKeyMaterialFactory(Run, FilePath, Launcher, EnvVars, TaskListener, String)

Throws:

IOException

InterruptedException

newKeyMaterialFactory

public KeyMaterialFactory newKeyMaterialFactory(@CheckForNull
                                                hudson.model.Run context,
                                                @Nonnull
                                                hudson.FilePath workspace,
                                                @Nonnull
                                                hudson.Launcher launcher,
                                                @Nonnull
                                                hudson.EnvVars env,
                                                @Nonnull
                                                hudson.model.TaskListener listener,
                                                @Nonnull
                                                String dockerExecutable)
                                         throws IOException,
                                                InterruptedException

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

Parameters:

context - The build trying to access DockerHub

workspace - a workspace being used for operations (WorkspaceList.tempDir(hudson.FilePath) will be applied)

dockerExecutable - as in DockerTool.getExecutable(java.lang.String, hudson.model.Node, hudson.model.TaskListener, hudson.EnvVars), with a 1.8+ client

Throws:

IOException

InterruptedException

imageName

public String imageName(@Nonnull
                        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