com.google.cloud.tools.jib.cache

Class Cache

java.lang.Object

com.google.cloud.tools.jib.cache.Cache

@Immutable
public class Cache
extends java.lang.Object

Cache for storing data to be shared between Jib executions.

This class is immutable and safe to use across threads.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<CachedLayer>	retrieve(DescriptorDigest layerDigest) Retrieves the CachedLayer for the layer with digest layerDigest.
java.util.Optional<CachedLayer>	retrieve(com.google.common.collect.ImmutableList<LayerEntry> layerEntries) Retrieves the CachedLayer that was built from the layerEntries.
java.util.Optional<ContainerConfigurationTemplate>	retrieveLocalConfig(DescriptorDigest imageId) Retrieves the ContainerConfigurationTemplate for the image saved from the given image ID.
java.util.Optional<ManifestAndConfig>	retrieveMetadata(ImageReference imageReference) Retrieves the cached manifest and container configuration for an image reference.
java.util.Optional<CachedLayer>	retrieveTarLayer(DescriptorDigest diffId) Retrieves a CachedLayer for a local base image layer with the given diff id.
static Cache	withDirectory(java.nio.file.Path cacheDirectory) Initializes the cache using cacheDirectory for storage.
CachedLayer	writeCompressedLayer(Blob compressedLayerBlob) Saves a cache entry with a compressed layer Blob.
void	writeLocalConfig(DescriptorDigest imageId, ContainerConfigurationTemplate containerConfiguration) Writes a container configuration to (cache directory)/local/config/(image id).
void	writeMetadata(ImageReference imageReference, BuildableManifestTemplate manifestTemplate, ContainerConfigurationTemplate containerConfigurationTemplate) Saves a manifest and container configuration for a V2.2 or OCI image.
void	writeMetadata(ImageReference imageReference, V21ManifestTemplate manifestTemplate) Saves a V2.1 image manifest.
CachedLayer	writeTarLayer(DescriptorDigest diffId, Blob compressedBlob) Caches a layer that was extracted from a local base image, and names the file using the provided diff id.
CachedLayer	writeUncompressedLayer(Blob uncompressedLayerBlob, com.google.common.collect.ImmutableList<LayerEntry> layerEntries) Saves a cache entry with an uncompressed layer Blob and an additional selector digest.

Methods inherited from class java.lang.Object

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

Method Detail

withDirectory

public static Cache withDirectory(java.nio.file.Path cacheDirectory)
                           throws java.io.IOException

Initializes the cache using cacheDirectory for storage.

Parameters:

cacheDirectory - the directory for the cache. Creates the directory if it does not exist.

Returns:

a new Cache

Throws:

java.io.IOException - if an I/O exception occurs

writeMetadata

public void writeMetadata(ImageReference imageReference,
                          BuildableManifestTemplate manifestTemplate,
                          ContainerConfigurationTemplate containerConfigurationTemplate)
                   throws java.io.IOException

Saves a manifest and container configuration for a V2.2 or OCI image.

Parameters:

imageReference - the image reference to save the manifest and container configuration for

manifestTemplate - the V2.2 or OCI manifest

containerConfigurationTemplate - the container configuration

Throws:

java.io.IOException - if an I/O exception occurs

writeMetadata

public void writeMetadata(ImageReference imageReference,
                          V21ManifestTemplate manifestTemplate)
                   throws java.io.IOException

Saves a V2.1 image manifest.

Parameters:

imageReference - the image reference to save the manifest and container configuration for

manifestTemplate - the V2.1 manifest

Throws:

java.io.IOException - if an I/O exception occurs

writeCompressedLayer

public CachedLayer writeCompressedLayer(Blob compressedLayerBlob)
                                 throws java.io.IOException

Saves a cache entry with a compressed layer Blob. Use writeUncompressedLayer(Blob, ImmutableList) to save a cache entry with an uncompressed layer Blob and include a selector.

Parameters:

compressedLayerBlob - the compressed layer Blob

Returns:

the CachedLayer for the written layer

Throws:

java.io.IOException - if an I/O exception occurs

writeUncompressedLayer

public CachedLayer writeUncompressedLayer(Blob uncompressedLayerBlob,
                                          com.google.common.collect.ImmutableList<LayerEntry> layerEntries)
                                   throws java.io.IOException

Saves a cache entry with an uncompressed layer Blob and an additional selector digest. Use writeCompressedLayer(Blob) to save a compressed layer Blob.

Parameters:

uncompressedLayerBlob - the layer Blob

layerEntries - the layer entries that make up the layer

Returns:

the CachedLayer for the written layer

Throws:

java.io.IOException - if an I/O exception occurs

writeTarLayer

public CachedLayer writeTarLayer(DescriptorDigest diffId,
                                 Blob compressedBlob)
                          throws java.io.IOException

Caches a layer that was extracted from a local base image, and names the file using the provided diff id.

Parameters:

diffId - the diff id

compressedBlob - the compressed layer blob

Returns:

the CachedLayer for the written layer

Throws:

java.io.IOException - if an I/O exception occurs

writeLocalConfig

public void writeLocalConfig(DescriptorDigest imageId,
                             ContainerConfigurationTemplate containerConfiguration)
                      throws java.io.IOException

Writes a container configuration to (cache directory)/local/config/(image id). An image ID is a SHA hash of a container configuration JSON. The value is also shown as IMAGE ID in docker images.

Note: the imageID to the containerConfiguration is a one-way relationship; there is no guarantee that containerConfiguration's SHA will be imageID, since the original container configuration is being rewritten here rather than being moved.

Parameters:

imageId - the ID of the image to store the container configuration for

containerConfiguration - the container configuration

Throws:

java.io.IOException - if an I/O exception occurs

retrieveMetadata

public java.util.Optional<ManifestAndConfig> retrieveMetadata(ImageReference imageReference)
                                                       throws java.io.IOException,
                                                              CacheCorruptedException

Retrieves the cached manifest and container configuration for an image reference.

Parameters:

imageReference - the image reference

Returns:

the manifest and container configuration for the image reference, if found

Throws:

java.io.IOException - if an I/O exception occurs

CacheCorruptedException - if the cache is corrupted

retrieve

public java.util.Optional<CachedLayer> retrieve(com.google.common.collect.ImmutableList<LayerEntry> layerEntries)
                                         throws java.io.IOException,
                                                CacheCorruptedException

Retrieves the CachedLayer that was built from the layerEntries.

Parameters:

layerEntries - the layer entries to match against

Returns:

a CachedLayer that was built from layerEntries, if found

Throws:

java.io.IOException - if an I/O exception occurs

CacheCorruptedException - if the cache is corrupted

retrieve

public java.util.Optional<CachedLayer> retrieve(DescriptorDigest layerDigest)
                                         throws java.io.IOException,
                                                CacheCorruptedException

Retrieves the CachedLayer for the layer with digest layerDigest.

Parameters:

layerDigest - the layer digest

Returns:

the CachedLayer referenced by the layer digest, if found

Throws:

CacheCorruptedException - if the cache was found to be corrupted

java.io.IOException - if an I/O exception occurs

retrieveTarLayer

public java.util.Optional<CachedLayer> retrieveTarLayer(DescriptorDigest diffId)
                                                 throws java.io.IOException,
                                                        CacheCorruptedException

Retrieves a CachedLayer for a local base image layer with the given diff id.

Parameters:

diffId - the diff id

Returns:

the CachedLayer with the given diff id

Throws:

CacheCorruptedException - if the cache was found to be corrupted

java.io.IOException - if an I/O exception occurs

retrieveLocalConfig

public java.util.Optional<ContainerConfigurationTemplate> retrieveLocalConfig(DescriptorDigest imageId)
                                                                       throws java.io.IOException

Retrieves the ContainerConfigurationTemplate for the image saved from the given image ID. An image ID is a SHA hash of a container configuration JSON. The value is also shown as IMAGE ID in docker images.

Note: the imageID is only used to find the containerConfiguration, and is not necessarily the actual SHA of containerConfiguration. There is no guarantee that containerConfiguration's SHA will be imageID, since the saved container configuration is not a direct copy of the base image's original configuration.

Parameters:

imageId - the image ID

Returns:

the ContainerConfigurationTemplate referenced by the image ID, if found

Throws:

java.io.IOException - if an I/O exception occurs