com.google.cloud.tools.jib.registry

Class RegistryClient

java.lang.Object

com.google.cloud.tools.jib.registry.RegistryClient

public class RegistryClient
extends java.lang.Object

Interfaces with a registry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryClient.Factory Factory for creating RegistryClients.

Method Summary

Modifier and Type	Method and Description
BlobDescriptor	checkBlob(DescriptorDigest blobDigest)
static RegistryClient.Factory	factory(JibLogger buildLogger, java.lang.String serverUrl, java.lang.String imageName) Creates a new RegistryClient.Factory for building a RegistryClient.
RegistryAuthenticator	getRegistryAuthenticator()
java.lang.Void	pullBlob(DescriptorDigest blobDigest, java.io.OutputStream destinationOutputStream) Downloads the BLOB to a file.
ManifestTemplate	pullManifest(java.lang.String imageTag)
<T extends ManifestTemplate> T	pullManifest(java.lang.String imageTag, java.lang.Class<T> manifestTemplateClass) Pulls the image manifest for a specific tag.
boolean	pushBlob(DescriptorDigest blobDigest, Blob blob, java.lang.String sourceRepository) Pushes the BLOB.
void	pushManifest(BuildableManifestTemplate manifestTemplate, java.lang.String imageTag) Pushes the image manifest for a specific tag.
RegistryClient	setTimer(Timer parentTimer)
static void	setUserAgentSuffix(java.lang.String userAgentSuffix) Sets a suffix to append to User-Agent headers.

Methods inherited from class java.lang.Object

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

Method Detail

setTimer

public RegistryClient setTimer(Timer parentTimer)

factory

public static RegistryClient.Factory factory(JibLogger buildLogger,
                                             java.lang.String serverUrl,
                                             java.lang.String imageName)

Creates a new RegistryClient.Factory for building a RegistryClient.

Parameters:

buildLogger - the build logger used for printing messages

serverUrl - the server URL for the registry (for example, gcr.io)

imageName - the image/repository name (also known as, namespace)

Returns:

the new RegistryClient.Factory

setUserAgentSuffix

public static void setUserAgentSuffix(@Nullable
                                      java.lang.String userAgentSuffix)

Sets a suffix to append to User-Agent headers.

Parameters:

userAgentSuffix - the suffix to append

getRegistryAuthenticator

@Nullable
public RegistryAuthenticator getRegistryAuthenticator()
                                                         throws java.io.IOException,
                                                                RegistryException

Returns:

the RegistryAuthenticator to authenticate pulls/pushes with the registry, or null if no token authentication is necessary

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullManifest

public <T extends ManifestTemplate> T pullManifest(java.lang.String imageTag,
                                                   java.lang.Class<T> manifestTemplateClass)
                                            throws java.io.IOException,
                                                   RegistryException

Pulls the image manifest for a specific tag.

Type Parameters:

T - child type of ManifestTemplate

Parameters:

imageTag - the tag to pull on

manifestTemplateClass - the specific version of manifest template to pull, or ManifestTemplate to pull either V22ManifestTemplate or V21ManifestTemplate

Returns:

the manifest template

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullManifest

public ManifestTemplate pullManifest(java.lang.String imageTag)
                              throws java.io.IOException,
                                     RegistryException

Throws:

java.io.IOException

RegistryException

pushManifest

public void pushManifest(BuildableManifestTemplate manifestTemplate,
                         java.lang.String imageTag)
                  throws java.io.IOException,
                         RegistryException

Pushes the image manifest for a specific tag.

Parameters:

manifestTemplate - the image manifest

imageTag - the tag to push on

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

checkBlob

@Nullable
public BlobDescriptor checkBlob(DescriptorDigest blobDigest)
                                   throws java.io.IOException,
                                          RegistryException

Parameters:

blobDigest - the blob digest to check for

Returns:

the BLOB's BlobDescriptor if the BLOB exists on the registry, or null if it doesn't

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullBlob

public java.lang.Void pullBlob(DescriptorDigest blobDigest,
                               java.io.OutputStream destinationOutputStream)
                        throws RegistryException,
                               java.io.IOException

Downloads the BLOB to a file.

Parameters:

blobDigest - the digest of the BLOB to download

destinationOutputStream - the OutputStream to write the BLOB to

Returns:

a Blob backed by the file at destPath. The file at destPath must exist for Blob to be valid.

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pushBlob

public boolean pushBlob(DescriptorDigest blobDigest,
                        Blob blob,
                        @Nullable
                        java.lang.String sourceRepository)
                 throws java.io.IOException,
                        RegistryException

Pushes the BLOB. If the sourceRepository is provided then the remote registry may skip if the BLOB already exists on the registry.

Parameters:

blobDigest - the digest of the BLOB, used for existence-check

blob - the BLOB to push

sourceRepository - if pushing to the same registry then the source image, or null otherwise; used to optimize the BLOB push

Returns:

true if the BLOB already exists on the registry and pushing was skipped; false if the BLOB was pushed

Throws:

java.io.IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails