com.google.cloud.tools.jib.registry

Class RegistryClient

java.lang.Object

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

public class RegistryClient
extends 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
Optional<BlobDescriptor>	checkBlob(DescriptorDigest blobDigest)
static RegistryClient.Factory	factory(EventHandlers eventHandlers, String serverUrl, String imageName) Creates a new RegistryClient.Factory for building a RegistryClient.
static RegistryClient.Factory	factory(EventHandlers eventHandlers, String serverUrl, String imageName, String sourceImageName)
Optional<RegistryAuthenticator>	getRegistryAuthenticator()
Blob	pullBlob(DescriptorDigest blobDigest, Consumer<Long> blobSizeListener, Consumer<Long> writtenByteCountListener) Gets the BLOB referenced by blobDigest.
ManifestTemplate	pullManifest(String imageTag)
<T extends ManifestTemplate> T	pullManifest(String imageTag, Class<T> manifestTemplateClass) Pulls the image manifest for a specific tag.
boolean	pushBlob(DescriptorDigest blobDigest, Blob blob, String sourceRepository, Consumer<Long> writtenByteCountListener) Pushes the BLOB.
DescriptorDigest	pushManifest(BuildableManifestTemplate manifestTemplate, String imageTag) Pushes the image manifest for a specific tag.

Methods inherited from class java.lang.Object

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

Method Detail

factory

public static RegistryClient.Factory factory(EventHandlers eventHandlers,
                                             String serverUrl,
                                             String imageName)

Creates a new RegistryClient.Factory for building a RegistryClient.

Parameters:

eventHandlers - the event handlers used for dispatching log events

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

factory

public static RegistryClient.Factory factory(EventHandlers eventHandlers,
                                             String serverUrl,
                                             String imageName,
                                             String sourceImageName)

getRegistryAuthenticator

public Optional<RegistryAuthenticator> getRegistryAuthenticator()
                                                         throws IOException,
                                                                RegistryException

Returns:

the RegistryAuthenticator to authenticate pulls/pushes with the registry, or Optional.empty() if no token authentication is necessary

Throws:

IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullManifest

public <T extends ManifestTemplate> T pullManifest(String imageTag,
                                                   Class<T> manifestTemplateClass)
                                            throws 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 predefined subclasses; see: ManifestPuller.handleResponse(Response)

Returns:

the manifest template

Throws:

IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullManifest

public ManifestTemplate pullManifest(String imageTag)
                              throws IOException,
                                     RegistryException

Throws:

IOException

RegistryException

pushManifest

public DescriptorDigest pushManifest(BuildableManifestTemplate manifestTemplate,
                                     String imageTag)
                              throws IOException,
                                     RegistryException

Pushes the image manifest for a specific tag.

Parameters:

manifestTemplate - the image manifest

imageTag - the tag to push on

Returns:

the digest of the pushed image

Throws:

IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

checkBlob

public Optional<BlobDescriptor> checkBlob(DescriptorDigest blobDigest)
                                   throws IOException,
                                          RegistryException

Parameters:

blobDigest - the blob digest to check for

Returns:

the BLOB's BlobDescriptor if the BLOB exists on the registry, or Optional.empty() if it doesn't

Throws:

IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails

pullBlob

public Blob pullBlob(DescriptorDigest blobDigest,
                     Consumer<Long> blobSizeListener,
                     Consumer<Long> writtenByteCountListener)

Gets the BLOB referenced by blobDigest. Note that the BLOB is only pulled when it is written out.

Parameters:

blobDigest - the digest of the BLOB to download

blobSizeListener - callback to receive the total size of the BLOb to pull

writtenByteCountListener - listens on byte count written to an output stream during the pull

Returns:

a Blob

pushBlob

public boolean pushBlob(DescriptorDigest blobDigest,
                        Blob blob,
                        @Nullable
                        String sourceRepository,
                        Consumer<Long> writtenByteCountListener)
                 throws 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

writtenByteCountListener - listens on byte count written to the registry during the push

Returns:

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

Throws:

IOException - if communicating with the endpoint fails

RegistryException - if communicating with the endpoint fails