Package land.oras

Class Registry

java.lang.Object
land.oras.OCI<ContainerRef>
land.oras.Registry
@NullMarked public final class Registry extends OCI<ContainerRef>
A registry is the main entry point for interacting with a container registry

  • Method Details

    • canMount

      public boolean canMount(OCI<?> other, ContainerRef sourceRef, ContainerRef targetRef)
      Description copied from class: OCI
      Return whether this OCI instance supports mounting blobs from the given source OCI instance.
      Specified by:
      canMount in class OCI<ContainerRef>
      Parameters:
      other - The source OCI instance to check compatibility with
      sourceRef - The source reference
      targetRef - The target reference
      Returns:
      true if mounting from other is supported

    • mountBlob

      public boolean mountBlob(ContainerRef sourceRef, ContainerRef targetRef)
      Description copied from class: OCI
      Mount a blob from another repository in the same OCI target.
      Specified by:
      mountBlob in class OCI<ContainerRef>
      Parameters:
      sourceRef - The source reference containing the source repository or layout path
      targetRef - The target reference containing the digest to mount
      Returns:
      true if the blob is successfully mounted, false otherwise (not supported by registry)

    • getRegistriesConf

      public RegistriesConf getRegistriesConf()
      Get the registries configuration
      Returns:
      The registries configuration

    • builder

      public static Registry.Builder builder()
      Return a new builder for this registry
      Returns:
      The builder

    • isInsecure

      public boolean isInsecure()
      Return if this registry is insecure
      Returns:
      True if insecure

    • getContainersPolicy

      public ContainersPolicy getContainersPolicy()
      Return the containers policy used for trust verification.
      Returns:
      the containers policy

    • getScheme

      public String getScheme()
      Get the HTTP scheme depending on the insecure flag
      Returns:
      The scheme

    • copy

      public Registry copy(String newRegistry)
      Return a new registry with the given registry URL but with same settings
      Parameters:
      newRegistry - The new target registry URL to use in the new registry
      Returns:
      The new registry

    • withAuthToken

      public Registry withAuthToken(String authToken)
      Return a new registry with a new auth external token and same settings
      Parameters:
      authToken - The new refreshed token
      Returns:
      The new registry

    • getRegistry

      public @Nullable String getRegistry()
      Get the registry URL
      Returns:
      The registry URL

    • getExecutorService

      public ExecutorService getExecutorService()
      Description copied from class: OCI
      Get the executor service for concurrent operations. This is used for concurrent pushing and pulling of layers.
      Specified by:
      getExecutorService in class OCI<ContainerRef>
      Returns:
      The executor service

    • getTags

      public Tags getTags(ContainerRef containerRef)
      Description copied from class: OCI
      Get the tags for a ref
      Specified by:
      getTags in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The tags

    • getTags

      public Tags getTags(ContainerRef containerRef, int n, @Nullable String last)
      Description copied from class: OCI
      Get the tags for a ref
      Specified by:
      getTags in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      n - The number of tags to return. If n is less than or equal to 0, return all tags
      last - The last tag index, to iterate. If null, start from the beginning
      Returns:
      The tags

    • getRepositories

      public Repositories getRepositories()
      Description copied from class: OCI
      Get the tags for a ref
      Specified by:
      getRepositories in class OCI<ContainerRef>
      Returns:
      The repositories

    • getReferrers

      public Referrers getReferrers(ContainerRef containerRef, @Nullable ArtifactType artifactType)
      Description copied from class: OCI
      Get the referrers of a container
      Specified by:
      getReferrers in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      artifactType - The optional artifact type
      Returns:
      The referrers

    • deleteManifest

      public void deleteManifest(ContainerRef containerRef)
      Delete a manifest
      Parameters:
      containerRef - The artifact

    • pushManifest

      public Manifest pushManifest(ContainerRef containerRef, Manifest manifest)
      Description copied from class: OCI
      Push a manifest
      Specified by:
      pushManifest in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      manifest - The manifest
      Returns:
      The location

    • pushIndex

      public Index pushIndex(ContainerRef containerRef, Index index)
      Description copied from class: OCI
      Push an index
      Specified by:
      pushIndex in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      index - The index
      Returns:
      The index

    • deleteBlob

      public void deleteBlob(ContainerRef containerRef)
      Delete a blob
      Parameters:
      containerRef - The container

    • pullArtifact

      public void pullArtifact(ContainerRef containerRef, Path path, OCI.PullOptions options)
      Description copied from class: OCI
      Pull an artifact using the given options
      Specified by:
      pullArtifact in class OCI<ContainerRef>
      Parameters:
      containerRef - The reference of the artifact
      path - The path to save the artifact
      options - The pull options

    • pushArtifact

      public Manifest pushArtifact(ContainerRef containerRef, ArtifactType artifactType, Annotations annotations, @Nullable Config config, OCI.PushOptions options, LocalPath... paths)
      Description copied from class: OCI
      Push an artifact
      Specified by:
      pushArtifact in class OCI<ContainerRef>
      Parameters:
      containerRef - The container
      artifactType - The artifact type. Can be null
      annotations - The annotations
      config - The config
      options - The push options
      paths - The paths
      Returns:
      The manifest

    • doPushBlob

      protected Layer doPushBlob(ContainerRef ref, Path blob, OCI.PushOptions options)
      Description copied from class: OCI
      Push a blob from a file path, respecting the given push options. Subclasses may override to support chunked upload.
      Overrides:
      doPushBlob in class OCI<ContainerRef>
      Parameters:
      ref - The ref
      blob - The blob file
      options - The push options
      Returns:
      The layer

    • pushBlob

      public Layer pushBlob(ContainerRef containerRef, Path blob, Map<String,String> annotations)
      Description copied from class: OCI
      Push a blob from file
      Specified by:
      pushBlob in class OCI<ContainerRef>
      Parameters:
      containerRef - The container
      blob - The blob
      annotations - The annotations
      Returns:
      The layer

    • pushBlob

      public Layer pushBlob(ContainerRef ref, long size, Supplier<InputStream> stream, Map<String,String> annotations)
      Description copied from class: OCI
      Push a blob from input stream with known digest and size
      Specified by:
      pushBlob in class OCI<ContainerRef>
      Parameters:
      ref - The container ref with digest
      size - The size of the blob
      stream - The input stream of the blob
      annotations - The annotations
      Returns:
      The layer

    • pushBlob

      public Layer pushBlob(ContainerRef containerRef, byte[] data)
      Description copied from class: OCI
      Push the blob for the given layer
      Specified by:
      pushBlob in class OCI<ContainerRef>
      Parameters:
      containerRef - The container ref
      data - The data
      Returns:
      The layer

    • pushBlobChunked

      public Layer pushBlobChunked(ContainerRef containerRef, Path blob, long chunkSize)
      Push a blob using chunked upload
      Parameters:
      containerRef - The container reference
      blob - The blob file to upload
      chunkSize - Maximum number of bytes per chunk. Must be > 0.
      Returns:
      The Layer descriptor for the uploaded blob.
      Throws:
      OrasException - if the upload fails at any stage.

    • pushBlobChunked

      public Layer pushBlobChunked(ContainerRef containerRef, InputStream stream, long totalSize, long chunkSize)
      Push a blob using chunked upload
      Parameters:
      containerRef - The container reference
      stream - Input stream
      totalSize - Total size of the stream
      chunkSize - Maximum number of bytes per chunk. Must be > 0.
      Returns:
      The Layer descriptor for the uploaded blob.
      Throws:
      OrasException - if the upload fails at any stage.

    • getBlob

      public byte[] getBlob(ContainerRef containerRef)
      Get the blob for the given digest. Not be suitable for large blobs
      Specified by:
      getBlob in class OCI<ContainerRef>
      Parameters:
      containerRef - The container
      Returns:
      The blob as bytes

    • fetchBlob

      public void fetchBlob(ContainerRef containerRef, Path path)
      Description copied from class: OCI
      Fetch blob and save it to file
      Specified by:
      fetchBlob in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      path - The path to save the blob

    • fetchBlob

      public InputStream fetchBlob(ContainerRef containerRef)
      Description copied from class: OCI
      Fetch blob and return it as input stream
      Specified by:
      fetchBlob in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The input stream

    • fetchBlobDescriptor

      public Descriptor fetchBlobDescriptor(ContainerRef containerRef)
      Description copied from class: OCI
      Fetch blob and return it's descriptor
      Specified by:
      fetchBlobDescriptor in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The descriptor

    • getManifest

      public Manifest getManifest(ContainerRef containerRef)
      Description copied from class: OCI
      Retrieve a manifest
      Specified by:
      getManifest in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The manifest

    • getIndex

      public Index getIndex(ContainerRef containerRef)
      Description copied from class: OCI
      Retrieve an index
      Specified by:
      getIndex in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The index

    • getDescriptor

      public Descriptor getDescriptor(ContainerRef containerRef)
      Description copied from class: OCI
      Retrieve a descriptor
      Specified by:
      getDescriptor in class OCI<ContainerRef>
      Parameters:
      containerRef - The ref
      Returns:
      The descriptor

    • probeDescriptor

      public Descriptor probeDescriptor(ContainerRef ref)
      Description copied from class: OCI
      Probe a descriptor. Typically used to get digest, size and media type without the content
      Specified by:
      probeDescriptor in class OCI<ContainerRef>
      Parameters:
      ref - The ref
      Returns:
      The descriptor

    • getBlobStream

      public InputStream getBlobStream(ContainerRef containerRef)
      Get blob as stream to avoid loading into memory
      Parameters:
      containerRef - The container ref
      Returns:
      The input stream