Image Class — spring-boot Architecture

Source Code

buildpack/spring-boot-buildpack-platform/src/main/java/org/springframework/boot/buildpack/platform/docker/type/Image.java lines 41–195

public class Image extends MappedObject {

	private final List<String> digests;

	private final ImageConfig config;

	private final List<LayerId> layers;

	private final @Nullable String os;

	private final @Nullable String architecture;

	private final @Nullable String variant;

	private final @Nullable String created;

	private final @Nullable Descriptor descriptor;

	Image(JsonNode node) {
		super(node, MethodHandles.lookup());
		this.digests = childrenAt("/RepoDigests", JsonNode::asString);
		this.config = new ImageConfig(getNode().at("/Config"));
		this.layers = extractLayers(valueAt("/RootFS/Layers", String[].class));
		this.os = valueAt("/Os", String.class);
		this.architecture = valueAt("/Architecture", String.class);
		this.variant = valueAt("/Variant", String.class);
		this.created = valueAt("/Created", String.class);
		JsonNode descriptorNode = getNode().path("Descriptor");
		this.descriptor = (descriptorNode.isMissingNode() || descriptorNode.isNull()) ? null
				: new Descriptor(descriptorNode);
	}

	private List<LayerId> extractLayers(String @Nullable [] layers) {
		if (layers == null) {
			return Collections.emptyList();
		}
		return Arrays.stream(layers).map(LayerId::of).toList();
	}

	/**
	 * Return the digests of the image.
	 * @return the image digests
	 */
	public List<String> getDigests() {
		return this.digests;
	}

	/**
	 * Return image config information.
	 * @return the image config
	 */
	public ImageConfig getConfig() {
		return this.config;
	}

	/**
	 * Return the layer IDs contained in the image.
	 * @return the layer IDs.
	 */
	public List<LayerId> getLayers() {
		return this.layers;
	}

	/**
	 * Return the OS of the image.
	 * @return the image OS
	 */
	public String getOs() {
		return (StringUtils.hasText(this.os)) ? this.os : "linux";
	}

	/**
	 * Return the architecture of the image.
	 * @return the image architecture
	 */
	public @Nullable String getArchitecture() {
		return this.architecture;
	}

	/**
	 * Return the variant of the image.
	 * @return the image variant
	 */
	public @Nullable String getVariant() {
		return this.variant;
	}

	/**
	 * Return the created date of the image.
	 * @return the image created date
	 */
	public @Nullable String getCreated() {
		return this.created;
	}

	/**
	 * Return the descriptor for this image as reported by Docker Engine inspect.
	 * @return the image descriptor or {@code null}
	 */
	public @Nullable Descriptor getDescriptor() {
		return this.descriptor;
	}

	/**
	 * Return the primary digest of the image or {@code null}. Checks the
	 * {@code Descriptor.digest} first, falling back to {@code RepoDigest}.
	 * @return the primary digest or {@code null}
	 * @since 3.4.12
	 */
	public @Nullable String getPrimaryDigest() {
		if (this.descriptor != null && StringUtils.hasText(this.descriptor.getDigest())) {
			return this.descriptor.getDigest();
		}
		if (!CollectionUtils.isEmpty(this.digests)) {
			try {
				String digest = this.digests.get(0);
				return (digest != null) ? ImageReference.of(digest).getDigest() : null;
			}
			catch (RuntimeException ex) {
			}
		}
		return null;
	}

	/**
	 * Create a new {@link Image} instance from the specified JSON content.
	 * @param content the JSON content
	 * @return a new {@link Image} instance
	 * @throws IOException on IO error
	 */
	public static Image of(InputStream content) throws IOException {
		return of(content, Image::new);
	}

	/**
	 * Descriptor details as reported in the {@code Docker inspect} response.
	 *
	 * @since 3.4.12
	 */
	public final class Descriptor extends MappedObject {

		private final String digest;

		Descriptor(JsonNode node) {
			super(node, MethodHandles.lookup());
			this.digest = Objects.requireNonNull(valueAt("/digest", String.class));
		}

		public String getDigest() {
			return this.digest;
		}

	}

}