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.

Constructor Summary

Constructors

Constructor and Description
RegistryClient(Authorization authorization, String serverUrl, String imageName)

Method Summary

Modifier and Type	Method and Description
BlobDescriptor	checkBlob(DescriptorDigest blobDigest)
RegistryAuthenticator	getRegistryAuthenticator()
Void	pullBlob(DescriptorDigest blobDigest, OutputStream destinationOutputStream) Downloads the BLOB to a file.
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) Pushes the BLOB, or skips if the BLOB already exists on the registry.
void	pushManifest(BuildableManifestTemplate manifestTemplate, String imageTag) Pushes the image manifest for a specific tag.
RegistryClient	setTimer(Timer parentTimer)
static void	setUserAgentSuffix(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

Constructor Detail

RegistryClient

public RegistryClient(@Nullable
                      Authorization authorization,
                      String serverUrl,
                      String imageName)

Method Detail

setTimer

public RegistryClient setTimer(Timer parentTimer)

setUserAgentSuffix

public static void setUserAgentSuffix(@Nullable
                                      String userAgentSuffix)

Sets a suffix to append to User-Agent headers.

getRegistryAuthenticator

@Nullable
public RegistryAuthenticator getRegistryAuthenticator()
                                                         throws IOException,
                                                                RegistryException

Returns:

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

Throws:

IOException

RegistryException

pullManifest

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

Pulls the image manifest for a specific tag.

Parameters:

imageTag - the tag to pull on

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

Throws:

IOException

RegistryException

pullManifest

public ManifestTemplate pullManifest(String imageTag)
                              throws IOException,
                                     RegistryException

Throws:

IOException

RegistryException

pushManifest

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

Pushes the image manifest for a specific tag.

Throws:

IOException

RegistryException

checkBlob

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

Returns:

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

Throws:

IOException

RegistryException

pullBlob

public Void pullBlob(DescriptorDigest blobDigest,
                     OutputStream destinationOutputStream)
              throws RegistryException,
                     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:

RegistryException

IOException

pushBlob

public boolean pushBlob(DescriptorDigest blobDigest,
                        Blob blob)
                 throws IOException,
                        RegistryException

Pushes the BLOB, or skips if the BLOB already exists on the registry.

Parameters:

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

blob - the BLOB to push

Returns:

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

Throws:

IOException

RegistryException