Index

A B C D E F G H I J L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractUsernamePasswordProvider - Class in land.oras.auth

A provider for username and password authentication

AbstractUsernamePasswordProvider(String, String) - Constructor for class land.oras.auth.AbstractUsernamePasswordProvider

Create a new username and password provider

ACCEPT_HEADER - Static variable in class land.oras.utils.Const

Accept header

access_token() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns the value of the access_token record component.

ANNOTATION_CREATED - Static variable in class land.oras.utils.Const

Annotation for the crated date

ANNOTATION_ORAS_CONTENT_DIGEST - Static variable in class land.oras.utils.Const

Annotation of the uncompressed dir content

ANNOTATION_ORAS_UNPACK - Static variable in class land.oras.utils.Const

Annotation to unpack the content

ANNOTATION_REF - Static variable in class land.oras.utils.Const

Annotation for the ref name

ANNOTATION_TITLE - Static variable in class land.oras.utils.Const

Annotation for the title

annotations - Variable in class land.oras.Descriptor

Annotations for the layer

Annotations - Record Class in land.oras

Record for annotations

Annotations(Map<String, String>, Map<String, String>, Map<String, Map<String, String>>) - Constructor for record class land.oras.Annotations

Creates an instance of a Annotations record class.

APPLICATION_OCTET_STREAM_HEADER_VALUE - Static variable in class land.oras.utils.Const

Application octet stream header value

ArchiveUtils - Class in land.oras.utils

Archive utilities

ARTIFACT_MANIFEST_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The artifact manifest media type

artifactType - Variable in class land.oras.Descriptor

ArtifactType - Class in land.oras

Class for artifact type

attachArtifact(T, ArtifactType, Annotations, LocalPath...) - Method in class land.oras.OCI

Attach file to an existing manifest

attachArtifact(T, ArtifactType, LocalPath...) - Method in class land.oras.OCI

Attach an artifact

AUTHORIZATION_HEADER - Static variable in class land.oras.utils.Const

Authorization header

AuthProvider - Interface in land.oras.auth

Interface for auth provider Must return the authentication header to pass to HTTP requests

AuthStore - Class in land.oras.auth

Implements a credentials store using a configuration file to keep the credentials in plain-text.

AuthStore.Credential - Record Class in land.oras.auth

Nested Credential class to represent username and password pairs.

AuthStoreAuthenticationProvider - Class in land.oras.auth

AuthStoreAuthenticationProvider is an implementation of the AuthProvider interface.

AuthStoreAuthenticationProvider() - Constructor for class land.oras.auth.AuthStoreAuthenticationProvider

Default constructor

AuthStoreAuthenticationProvider(AuthStore) - Constructor for class land.oras.auth.AuthStoreAuthenticationProvider

Constructor.

B

BearerTokenProvider - Class in land.oras.auth

A provider for bearer token authentication

BearerTokenProvider(AuthProvider) - Constructor for class land.oras.auth.BearerTokenProvider

Create a new bearer token provider

BearerTokenProvider.TokenResponse - Record Class in land.oras.auth

The token response

BLAKE3 - Enum constant in enum class land.oras.utils.SupportedAlgorithm

BLAKE3

BLOB_DIR_ZSTD_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The blob directory media type for zstd compression

build() - Method in class land.oras.OCILayout.Builder

Build the registry

build() - Method in class land.oras.Registry.Builder

Build the registry

build() - Method in class land.oras.utils.OrasHttpClient

Create a new HTTP client

build() - Method in class land.oras.utils.OrasHttpClient.Builder

Build the client

builder() - Static method in class land.oras.OCILayout.Builder

Return a new builder

builder() - Static method in class land.oras.Registry.Builder

Return a new builder

builder() - Static method in class land.oras.utils.OrasHttpClient.Builder

Build the client

C

code() - Method in record class land.oras.exception.Error

Returns the value of the code record component.

compress(LocalPath, String) - Static method in class land.oras.utils.ArchiveUtils

Compress a tar file to a tar.gz or tar.zstd file depending on the requested media type

Config - Class in land.oras

Class for config

configAnnotations() - Method in record class land.oras.Annotations

Returns the value of the configAnnotations record component.

Const - Class in land.oras.utils

Constants used in the SDK.

ContainerRef - Class in land.oras

A referer of a container on a Registry.

CONTENT_LENGTH_HEADER - Static variable in class land.oras.utils.Const

Content length header

CONTENT_RANGE_HEADER - Static variable in class land.oras.utils.Const

Content Range header

CONTENT_TYPE_HEADER - Static variable in class land.oras.utils.Const

Content type header

copy(Registry, ContainerRef) - Method in class land.oras.OCILayout

Copy the direct container ref from registry into oci-layout

copy(Registry, ContainerRef, boolean) - Method in class land.oras.OCILayout

Copy the container ref from registry into oci-layout

copy(Registry, ContainerRef, ContainerRef) - Method in class land.oras.Registry

Copy an artifact from one container to another

createTempTar() - Static method in class land.oras.utils.ArchiveUtils

Create a temporary archive when uploading directory layers

Credential(String, String) - Constructor for record class land.oras.auth.AuthStore.Credential

Constructs a new Credential object with the specified username and password.

currentTimestamp() - Static method in class land.oras.utils.Const

Get the current timestamp for the created annotation

D

DEFAULT_ARTIFACT_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default artifact media type if not specified

DEFAULT_BLOB_DIR_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default blob directory media type

DEFAULT_BLOB_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default blob media type if file type cannot be determined

DEFAULT_DESCRIPTOR_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default descriptor media type

DEFAULT_EMPTY_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default empty media type

DEFAULT_INDEX_MEDIA_TYPE - Static variable in class land.oras.utils.Const

Default index media type

DEFAULT_JSON_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default JSON media type

DEFAULT_MANIFEST_MEDIA_TYPE - Static variable in class land.oras.utils.Const

The default manifest media type

DEFAULT_REGISTRY - Static variable in class land.oras.utils.Const

Default registry

DEFAULT_TAG - Static variable in class land.oras.utils.Const

Default tag

defaults() - Method in class land.oras.Registry.Builder

Return a new builder with default authentication using existing host auth

defaults(String, String) - Method in class land.oras.Registry.Builder

Return a new builder with username and password authentication

defaults(Path) - Method in class land.oras.OCILayout.Builder

Return a new builder with default path

delete(URI, Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a DELETE request

deleteBlob(ContainerRef) - Method in class land.oras.Registry

Delete a blob

deleteManifest(ContainerRef) - Method in class land.oras.Registry

Delete a manifest

Descriptor - Class in land.oras

Main class for descriptor

Descriptor(String, Long, String, Map<String, String>, String, String) - Constructor for class land.oras.Descriptor

details() - Method in record class land.oras.exception.Error

Returns the value of the details record component.

digest - Variable in class land.oras.Descriptor

digest(byte[]) - Method in enum class land.oras.utils.SupportedAlgorithm

Digest a byte array

digest(InputStream) - Method in enum class land.oras.utils.SupportedAlgorithm

Digest an input stream

digest(Path) - Method in enum class land.oras.utils.SupportedAlgorithm

Digest a file

DOCKER_CONTENT_DIGEST_HEADER - Static variable in class land.oras.utils.Const

The Docker content digest header

DOCKER_INDEX_MEDIA_TYPE - Static variable in class land.oras.utils.Const

Docker index media type (manifest list or fat manifest)

DOCKER_MANIFEST_MEDIA_TYPE - Static variable in class land.oras.utils.Const

Docker distribution manifest type

download(URI, Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Download to to input stream

download(URI, Map<String, String>, Path) - Method in class land.oras.utils.OrasHttpClient

Download to a file

E

empty() - Static method in record class land.oras.Annotations

Empty annotations

empty() - Static method in class land.oras.Config

An empty config

empty() - Static method in class land.oras.Layer

An empty config

empty() - Static method in class land.oras.Manifest

Return a copy of an empty manifest

equals(Object) - Method in record class land.oras.Annotations

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class land.oras.auth.AuthStore.Credential

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class land.oras.exception.Error

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class land.oras.Tags

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Indicates whether some other object is "equal to" this one.

ERR_BAD_CREDENTIAL_FORMAT - Static variable in class land.oras.auth.AuthStore

Error message indicating that the format of the provided credential is invalid.

Error - Record Class in land.oras.exception

An error object for OCI API

Error(String, String, String) - Constructor for record class land.oras.exception.Error

Creates an instance of a Error record class.

expire_in() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns the value of the expire_in record component.

F

fetchBlob(ContainerRef) - Method in class land.oras.Registry

fetchBlob(ContainerRef, Path) - Method in class land.oras.Registry

fetchBlob(LayoutRef) - Method in class land.oras.OCILayout

fetchBlob(LayoutRef, Path) - Method in class land.oras.OCILayout

fetchBlob(T) - Method in class land.oras.OCI

Fetch blob and return it as input stream

fetchBlob(T, Path) - Method in class land.oras.OCI

Fetch blob and save it to file

fetchBlobDescriptor(ContainerRef) - Method in class land.oras.Registry

fetchBlobDescriptor(LayoutRef) - Method in class land.oras.OCILayout

fetchBlobDescriptor(T) - Method in class land.oras.OCI

Fetch blob and return it's descriptor

filesAnnotations() - Method in record class land.oras.Annotations

Returns the value of the filesAnnotations record component.

forRegistry(String) - Static method in class land.oras.ContainerRef

Return a container reference for a registry

from(String) - Static method in class land.oras.ArtifactType

Create an artifact type

fromBlob(String, Layer) - Static method in class land.oras.Config

A config with referrence on a blob (too large for data)

fromData(ContainerRef, byte[]) - Static method in class land.oras.Layer

Create a layer from data

fromDigest(String) - Static method in enum class land.oras.utils.SupportedAlgorithm

Get the algorithm from a digest

fromDigest(String, long) - Static method in class land.oras.Layer

Create a layer from a digest

fromFile(Path) - Static method in class land.oras.Layer

Create a layer from a file using default digest

fromFile(Path, SupportedAlgorithm) - Static method in class land.oras.Layer

Create a layer from a file using a specific algorithm

fromJson(Reader, Type) - Static method in class land.oras.utils.JsonUtils

Deserializes the contents of a JSON input to an object of the specified type.

fromJson(String) - Static method in record class land.oras.Annotations

Convert the annotations from a JSON string

fromJson(String) - Static method in class land.oras.Config

Create a config from a JSON string

fromJson(String) - Static method in class land.oras.Index

Create an index from a JSON string

fromJson(String) - Static method in class land.oras.Layer

Create a layer from a JSON string

fromJson(String) - Static method in class land.oras.Manifest

Create a manifest from a JSON string

fromJson(String) - Static method in class land.oras.ManifestDescriptor

Create a manifest descriptor from a JSON string

fromJson(String) - Static method in class land.oras.OCILayout

Create the OCI layout file from a JSON string

fromJson(String) - Static method in class land.oras.Referrers

Create a manifest from a JSON string

fromJson(String) - Static method in class land.oras.Subject

Create a subject from a JSON string

fromJson(String, Class<T>) - Static method in class land.oras.utils.JsonUtils

Convert a JSON string to an object

fromJson(Path, Class<T>) - Static method in class land.oras.utils.JsonUtils

Convert a JSON string to an object.

fromJson(Path, Type) - Static method in class land.oras.utils.JsonUtils

Converts the contents of a JSON file to an object of the specified type.

fromLayoutIndex(Path) - Static method in class land.oras.OCILayout

Return the OCI layout from the index.json file

fromManifests(List<ManifestDescriptor>) - Static method in class land.oras.Index

Create an index from a list of manifests

fromPath(Path) - Static method in class land.oras.Index

Create an index from a path

fromPath(Path) - Static method in class land.oras.Manifest

Create a manifest from a path

fromUrl(String) - Static method in class land.oras.ContainerRef

Return a container reference from URL

G

get(URI, Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a GET request

get(ContainerRef) - Method in class land.oras.auth.AuthStore

Retrieves credentials for the given containerRef.

getAlgorithm() - Method in class land.oras.ContainerRef

getAlgorithm() - Method in class land.oras.LayoutRef

getAlgorithm() - Method in class land.oras.Ref

Get the algorithm

getAlgorithmName() - Method in enum class land.oras.utils.SupportedAlgorithm

Get the algorithm

getAnnotations() - Method in class land.oras.Config

Get the annotations

getAnnotations() - Method in class land.oras.Descriptor

Get the annotations

getAnnotations() - Method in class land.oras.Index

Get the annotations

getAnnotations() - Method in class land.oras.ManifestDescriptor

Get the annotations

getApiRegistry() - Method in class land.oras.ContainerRef

Get the API registry

getArtifactType() - Method in class land.oras.Descriptor

Get the artifact type

getArtifactType() - Method in class land.oras.Manifest

getArtifactType() - Method in class land.oras.ManifestDescriptor

Get the artifact type

getAuthHeader(ContainerRef) - Method in class land.oras.auth.AbstractUsernamePasswordProvider

getAuthHeader(ContainerRef) - Method in interface land.oras.auth.AuthProvider

Get the authentication header for this provider

getAuthHeader(ContainerRef) - Method in class land.oras.auth.AuthStoreAuthenticationProvider

getAuthHeader(ContainerRef) - Method in class land.oras.auth.BearerTokenProvider

getAuthHeader(ContainerRef) - Method in class land.oras.auth.NoAuthProvider

getBlob(ContainerRef) - Method in class land.oras.Registry

Get the blob for the given digest.

getBlob(LayoutRef) - Method in class land.oras.OCILayout

getBlob(T) - Method in class land.oras.OCI

Get the blob for the given digest.

getBlobPath() - Method in class land.oras.Layer

Get the blob path

getBlobsPath() - Method in class land.oras.ContainerRef

Return the blobs URL

getBlobStream(ContainerRef) - Method in class land.oras.Registry

Get blob as stream to avoid loading into memory

getBlobsUploadDigestPath() - Method in class land.oras.ContainerRef

Return the blobs upload URL with the digest for single POST upload

getBlobsUploadPath() - Method in class land.oras.ContainerRef

Return the blobs upload URL

getConfig() - Method in class land.oras.Manifest

Get the config

getData() - Method in class land.oras.Config

Get the data as a string

getData() - Method in class land.oras.Layer

Get the data

getDataBytes() - Method in class land.oras.Config

Get the data as bytes

getDataBytes() - Method in class land.oras.Layer

Get the data as bytes

getDefault() - Static method in enum class land.oras.utils.SupportedAlgorithm

Get the default algorithm

getDescriptor() - Method in class land.oras.Index

Get the descriptor

getDescriptor() - Method in class land.oras.Manifest

Get the descriptor

getDescriptor(ContainerRef) - Method in class land.oras.Registry

getDescriptor(LayoutRef) - Method in class land.oras.OCILayout

getDescriptor(T) - Method in class land.oras.OCI

Retrieve a descriptor

getDigest() - Method in class land.oras.ContainerRef

Get the digest

getDigest() - Method in class land.oras.Descriptor

Get the digest

getDigest() - Method in class land.oras.Manifest

getDigest() - Method in class land.oras.ManifestDescriptor

Get the digest

getDigest() - Method in class land.oras.Subject

Get the digest

getDigest(String) - Static method in enum class land.oras.utils.SupportedAlgorithm

Return the digest without the prefix

getError() - Method in exception land.oras.exception.OrasException

Get the error

getFileAnnotations(String) - Method in record class land.oras.Annotations

Get the manifest annotations for a file

getFolder() - Method in class land.oras.LayoutRef

Get the folder

getImageLayoutVersion() - Method in class land.oras.OCILayout

Return the image layout version

getIndex(ContainerRef) - Method in class land.oras.Registry

getIndex(LayoutRef) - Method in class land.oras.OCILayout

getIndex(T) - Method in class land.oras.OCI

Retrieve an index

getJson() - Method in class land.oras.Descriptor

Return the original JSON

getLayers() - Method in class land.oras.Manifest

Get the layers

getManifest(ContainerRef) - Method in class land.oras.Registry

getManifest(LayoutRef) - Method in class land.oras.OCILayout

getManifest(T) - Method in class land.oras.OCI

Retrieve a manifest

getManifests() - Method in class land.oras.Index

Get the list of manifests

getManifests() - Method in class land.oras.Referrers

Get the list of manifests

getManifestsPath() - Method in class land.oras.ContainerRef

Return the manifests URL

getMediaType() - Method in class land.oras.ArtifactType

Get the media type

getMediaType() - Method in class land.oras.Descriptor

Get the media type

getMediaType() - Method in class land.oras.LocalPath

Get the media type or default depending on directory or standard file

getMediaType() - Method in class land.oras.ManifestDescriptor

Get the media type

getMediaType() - Method in class land.oras.Referrers

Get the media type

getMediaType() - Method in class land.oras.Subject

Get the media type

getMediaType() - Method in enum class land.oras.utils.SupportedCompression

Get the media type

getNamespace() - Method in class land.oras.ContainerRef

Get the namespace

getPassword() - Method in class land.oras.auth.AbstractUsernamePasswordProvider

Get the password

getPath() - Method in class land.oras.LocalPath

Get the path

getPlatform() - Method in class land.oras.ManifestDescriptor

Get the platform

getPrefix() - Method in enum class land.oras.utils.SupportedAlgorithm

Get the prefix

getReferrers(ContainerRef, ArtifactType) - Method in class land.oras.Registry

Get the referrers of a container

getReferrersPath(ArtifactType) - Method in class land.oras.ContainerRef

Return the referrers URL for this container referrer

getRegistry() - Method in class land.oras.ContainerRef

Create a new container reference

getRepository() - Method in class land.oras.ContainerRef

Get the repository

getRepository() - Method in class land.oras.LayoutRef

getRepository() - Method in class land.oras.Ref

Get the repository where to find the ref

getSchemaVersion() - Method in class land.oras.Index

Get the schema version

getSchemaVersion() - Method in class land.oras.Manifest

Get the schema version

getScheme() - Method in class land.oras.Registry

Get the HTTP scheme depending on the insecure flag

getSize() - Method in class land.oras.Descriptor

Get the size

getSize() - Method in class land.oras.ManifestDescriptor

Get the size

getSize() - Method in class land.oras.Subject

Get the size

getStatusCode() - Method in exception land.oras.exception.OrasException

Get the status code

getSubject() - Method in class land.oras.Index

Get the subject

getSubject() - Method in class land.oras.Manifest

Get the subject

getTag() - Method in class land.oras.Ref

Get the tag

getTags(ContainerRef) - Method in class land.oras.Registry

Get the tags of a container

getTagsPath() - Method in class land.oras.ContainerRef

Return the tag URL

getToken() - Method in class land.oras.auth.BearerTokenProvider

Get the token

getUsername() - Method in class land.oras.auth.AbstractUsernamePasswordProvider

Get the username

GZIP - Enum constant in enum class land.oras.utils.SupportedCompression

GZIP

H

hashCode() - Method in record class land.oras.Annotations

Returns a hash code value for this object.

hashCode() - Method in record class land.oras.auth.AuthStore.Credential

Returns a hash code value for this object.

hashCode() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns a hash code value for this object.

hashCode() - Method in record class land.oras.exception.Error

Returns a hash code value for this object.

hashCode() - Method in record class land.oras.Tags

Returns a hash code value for this object.

hashCode() - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Returns a hash code value for this object.

head(URI, Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a HEAD request

headers() - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Returns the value of the headers record component.

I

Index - Class in land.oras

Index from an OCI layout

insecure() - Method in class land.oras.Registry.Builder

Return a new builder with insecure communication and not authentification

issued_at() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns the value of the issued_at record component.

isSupported(String) - Static method in enum class land.oras.utils.SupportedAlgorithm

Check if the digest is supported

isValidDigest() - Method in class land.oras.LayoutRef

Return if the current layout tag is a valid digest.

J

json - Variable in class land.oras.Descriptor

Original json

JsonUtils - Class in land.oras.utils

Utility class for JSON operations.

L

land.oras - package land.oras

land.oras.auth - package land.oras.auth

land.oras.exception - package land.oras.exception

land.oras.utils - package land.oras.utils

Layer - Class in land.oras

Class for layer

LayoutRef - Class in land.oras

A referer of a container on a OCILayout.

LocalPath - Class in land.oras

Local path

LOCATION_HEADER - Static variable in class land.oras.utils.Const

Location header

LOG - Static variable in class land.oras.OCI

The logger

M

Manifest - Class in land.oras

Class for manifest

MANIFEST_ACCEPT_TYPE - Static variable in class land.oras.utils.Const

The default accept type for the manifest

manifestAnnotations() - Method in record class land.oras.Annotations

Returns the value of the manifestAnnotations record component.

ManifestDescriptor - Class in land.oras

Manifest descriptor

matchPattern(String) - Static method in enum class land.oras.utils.SupportedAlgorithm

Check if the algorithm match pattern

mediaType - Variable in class land.oras.Descriptor

The media type of the layer

message() - Method in record class land.oras.exception.Error

Returns the value of the message record component.

N

name() - Method in record class land.oras.Tags

Returns the value of the name record component.

newStore() - Static method in class land.oras.auth.AuthStore

Creates a new FileStore from default location

newStore(List<Path>) - Static method in class land.oras.auth.AuthStore

Creates a new FileStore based on the given configuration file path.

NO_COMPRESSION - Enum constant in enum class land.oras.utils.SupportedCompression

No compression

NoAuthProvider - Class in land.oras.auth

A provider without any authentication

NoAuthProvider() - Constructor for class land.oras.auth.NoAuthProvider

Constructor

O

OCI<T extends Ref<@NonNull T>> - Class in land.oras

Abstract class for OCI operation on remote registry or layout Commons methods for OCI operations

OCI() - Constructor for class land.oras.OCI

Default constructor

OCI_CHUNK_MIN_LENGTH_HEADER - Static variable in class land.oras.utils.Const

OCI Chunk Minimum Length header

OCI_LAYOUT_BLOBS - Static variable in class land.oras.utils.Const

Blobs folder in OCI layout

OCI_LAYOUT_FILE - Static variable in class land.oras.utils.Const

Layout folder in OCI layout

OCI_LAYOUT_INDEX - Static variable in class land.oras.utils.Const

Index file in OCI layout

OCI_SUBJECT_HEADER - Static variable in class land.oras.utils.Const

OCI subject header

OCILayout - Class in land.oras

Index from an OCI layout

OCILayout.Builder - Class in land.oras

Builder for the registry

of(String) - Static method in class land.oras.LocalPath

New path with path:mediaType (for example /path/to/file.json:application/json)

of(String, Long) - Static method in class land.oras.Descriptor

Create a new descriptor

of(String, Long, String) - Static method in class land.oras.Descriptor

Create a new descriptor

of(String, Long, String, Map<String, String>, String) - Static method in class land.oras.Descriptor

Create a new descriptor

of(String, String, long) - Static method in class land.oras.ManifestDescriptor

Create a manifest descriptor

of(String, String, long) - Static method in class land.oras.Subject

Create a subject

of(Path) - Static method in class land.oras.LocalPath

New local path with no media type

of(Path, String) - Static method in class land.oras.LocalPath

New path with no media type

of(Descriptor) - Static method in class land.oras.ManifestDescriptor

Create a manifest descriptor

ofConfig(Map<String, String>) - Static method in record class land.oras.Annotations

Create a new annotations record with only config annotations

ofManifest(Map<String, String>) - Static method in record class land.oras.Annotations

Create a new annotations record with only manifest annotations

OrasException - Exception in land.oras.exception

Exception for ORAS

OrasException(String) - Constructor for exception land.oras.exception.OrasException

Constructor

OrasException(String, Throwable) - Constructor for exception land.oras.exception.OrasException

Constructor

OrasException(OrasHttpClient.ResponseWrapper<String>) - Constructor for exception land.oras.exception.OrasException

New exception with a message and a response

OrasHttpClient - Class in land.oras.utils

HTTP client for ORAS

OrasHttpClient.Builder - Class in land.oras.utils

Builder for the HTTP client

OrasHttpClient.ResponseWrapper<T> - Record Class in land.oras.utils

Response wrapper

P

parse(String) - Static method in class land.oras.ContainerRef

Parse the container name into registry, repository and tag.

parse(String) - Static method in class land.oras.LayoutRef

Parse the layout ref with folder and tag.

password() - Method in record class land.oras.auth.AuthStore.Credential

Returns the value of the password record component.

patch(URI, byte[], Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a Patch request

post(URI, byte[], Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a POST request.

pullArtifact(ContainerRef, Path, boolean) - Method in class land.oras.Registry

pullArtifact(LayoutRef, Path, boolean) - Method in class land.oras.OCILayout

pullArtifact(T, Path, boolean) - Method in class land.oras.OCI

Pull an artifact

pushArtifact(ContainerRef, ArtifactType, Annotations, Config, LocalPath...) - Method in class land.oras.Registry

pushArtifact(LayoutRef, ArtifactType, Annotations, Config, LocalPath...) - Method in class land.oras.OCILayout

pushArtifact(T, ArtifactType, Annotations, Config, LocalPath...) - Method in class land.oras.OCI

Push an artifact

pushArtifact(T, ArtifactType, Annotations, LocalPath...) - Method in class land.oras.OCI

Upload an ORAS artifact

pushArtifact(T, ArtifactType, LocalPath...) - Method in class land.oras.OCI

Push an artifact

pushArtifact(T, LocalPath...) - Method in class land.oras.OCI

Push an artifact

pushBlob(ContainerRef, byte[]) - Method in class land.oras.Registry

pushBlob(ContainerRef, Path, Map<String, String>) - Method in class land.oras.Registry

pushBlob(LayoutRef, byte[]) - Method in class land.oras.OCILayout

pushBlob(LayoutRef, Path, Map<String, String>) - Method in class land.oras.OCILayout

pushBlob(T, byte[]) - Method in class land.oras.OCI

Push the blob for the given layer

pushBlob(T, InputStream) - Method in class land.oras.OCI

Push a blob from file

pushBlob(T, Path) - Method in class land.oras.OCI

Push a blob from file

pushBlob(T, Path, Map<String, String>) - Method in class land.oras.OCI

Push a blob from file

pushConfig(T, Config) - Method in class land.oras.OCI

Push config

pushIndex(ContainerRef, Index) - Method in class land.oras.Registry

Push a manifest

pushLayers(T, boolean, LocalPath...) - Method in class land.oras.OCI

pushManifest(ContainerRef, Manifest) - Method in class land.oras.Registry

pushManifest(LayoutRef, Manifest) - Method in class land.oras.OCILayout

pushManifest(T, Manifest) - Method in class land.oras.OCI

Push a manifest

put(URI, byte[], Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Perform a PUT request

R

RANGE_HEADER - Static variable in class land.oras.utils.Const

Range header

readFile(Path) - Static method in class land.oras.utils.JsonUtils

Read a file and return the content as a string

Ref<T extends Ref<T>> - Class in land.oras

A referer of a container on a OCI.

Ref(String) - Constructor for class land.oras.Ref

Default constructor

Referrers - Class in land.oras

List of referrers

refreshToken(ContainerRef, OrasHttpClient, OrasHttpClient.ResponseWrapper<String>) - Method in class land.oras.auth.BearerTokenProvider

Retrieve

Registry - Class in land.oras

A registry is the main entry point for interacting with a container registry

Registry.Builder - Class in land.oras

Builder for the registry

response() - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Returns the value of the response record component.

ResponseWrapper(T, int, Map<String, String>) - Constructor for record class land.oras.utils.OrasHttpClient.ResponseWrapper

Creates an instance of a ResponseWrapper record class.

S

SHA256 - Enum constant in enum class land.oras.utils.SupportedAlgorithm

SHA-256

SHA512 - Enum constant in enum class land.oras.utils.SupportedAlgorithm

SHA-512

size - Variable in class land.oras.Descriptor

statusCode() - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Returns the value of the statusCode record component.

Subject - Class in land.oras

Class for subject

SupportedAlgorithm - Enum Class in land.oras.utils

Supported algorithms for digest.

SupportedCompression - Enum Class in land.oras.utils

Supported compression method for archive See @link https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests See @link https://github.com/opencontainers/image-spec/blob/main/descriptor.md#registered-algorithms

T

tag - Variable in class land.oras.Ref

The tag of the container.

tags() - Method in record class land.oras.Tags

Returns the value of the tags record component.

Tags - Record Class in land.oras

The tags response object

Tags(String, List<String>) - Constructor for record class land.oras.Tags

Creates an instance of a Tags record class.

tar(LocalPath) - Static method in class land.oras.utils.ArchiveUtils

Create a tar.gz file from a directory

toDescriptor() - Method in class land.oras.ManifestDescriptor

Return this manifest descriptor as a descriptor

toJson() - Method in record class land.oras.Annotations

Convert the annotations to a JSON string

toJson() - Method in class land.oras.Descriptor

Return the JSON representation of this descriptor

toJson() - Method in class land.oras.ManifestDescriptor

Return the JSON representation of the manifest

toJson() - Method in class land.oras.OCILayout

Return the JSON representation of the referrers

toJson() - Method in class land.oras.Referrers

Return the JSON representation of the referrers

toJson() - Method in class land.oras.Subject

Return the JSON representation of the manifest

toJson(Object) - Static method in class land.oras.utils.JsonUtils

Convert an object to a JSON string

token() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns the value of the token record component.

TokenResponse(String, String, Integer, ZonedDateTime) - Constructor for record class land.oras.auth.BearerTokenProvider.TokenResponse

Creates an instance of a TokenResponse record class.

toString() - Method in record class land.oras.Annotations

Returns a string representation of this record class.

toString() - Method in class land.oras.ArtifactType

toString() - Method in record class land.oras.auth.AuthStore.Credential

Returns a string representation of this record class.

toString() - Method in record class land.oras.auth.BearerTokenProvider.TokenResponse

Returns a string representation of this record class.

toString() - Method in record class land.oras.exception.Error

Returns a string representation of this record class.

toString() - Method in class land.oras.LocalPath

toString() - Method in record class land.oras.Tags

Returns a string representation of this record class.

toString() - Method in record class land.oras.utils.OrasHttpClient.ResponseWrapper

Returns a string representation of this record class.

toSubject() - Method in class land.oras.Descriptor

Return this manifest descriptor as a subject

toSubject() - Method in class land.oras.ManifestDescriptor

Return this manifest descriptor as a subject

U

uncompress(InputStream, String) - Static method in class land.oras.utils.ArchiveUtils

Extract a compressed file from a tar.gz or tar.zstd file depending on the requested media type

unknown() - Static method in class land.oras.ArtifactType

Create an unknown artifact type

untar(InputStream, Path) - Static method in class land.oras.utils.ArchiveUtils

Extract a tar file to a target directory

updateAuthentication(AuthProvider) - Method in class land.oras.utils.OrasHttpClient

Update the authentication method for this client Typically used to change from basic to bearer token authentication or no auth to basic auth

upload(String, URI, Map<String, String>, Path) - Method in class land.oras.utils.OrasHttpClient

Upload a file

uploadStream(String, URI, InputStream, long, Map<String, String>) - Method in class land.oras.utils.OrasHttpClient

Upload a stream

USER_AGENT_HEADER - Static variable in class land.oras.utils.Const

User agent header

USER_AGENT_VALUE - Static variable in class land.oras.utils.Const

User agent value

username() - Method in record class land.oras.auth.AuthStore.Credential

Returns the value of the username record component.

UsernamePasswordProvider - Class in land.oras.auth

A provider for username and password authentication

UsernamePasswordProvider(String, String) - Constructor for class land.oras.auth.UsernamePasswordProvider

Create a new username and password provider

V

valueOf(String) - Static method in enum class land.oras.utils.SupportedAlgorithm

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class land.oras.utils.SupportedCompression

Returns the enum constant of this class with the specified name.

values() - Static method in enum class land.oras.utils.SupportedAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class land.oras.utils.SupportedCompression

Returns an array containing the constants of this enum class, in the order they are declared.

W

withAnnotations(Map<String, String>) - Method in class land.oras.ManifestDescriptor

Create a manifest descriptor with the given annotations

withAnnotations(Map<String, String>) - Method in class land.oras.Layer

Create a new layer with annotations

withAnnotations(Map<String, String>) - Method in class land.oras.Manifest

Return a new manifest with the given annotations

withAnnotations(Annotations) - Method in class land.oras.Config

Create a new config with annotations

withArtifactType(String) - Method in class land.oras.ManifestDescriptor

Create a manifest descriptor with the given artifact type

withArtifactType(ArtifactType) - Method in class land.oras.Manifest

Return a new manifest with the given artifact type

withAuthentication(AuthProvider) - Method in class land.oras.utils.OrasHttpClient.Builder

Set the authentication

withAuthProvider(AuthProvider) - Method in class land.oras.Registry.Builder

Set the auth provider

withConfig(Config) - Method in class land.oras.Manifest

Return a new manifest with the given config

withDescriptor(ManifestDescriptor) - Method in class land.oras.Index

Return a new index with the given descriptor

withDescriptor(ManifestDescriptor) - Method in class land.oras.Manifest

Return a new manifest with the given descriptor

withDigest(String) - Method in class land.oras.ContainerRef

withDigest(String) - Method in class land.oras.LayoutRef

withDigest(String) - Method in class land.oras.Ref

Return the ref with the digest

withInsecure(boolean) - Method in class land.oras.Registry.Builder

Set the insecure flag

withJson(String) - Method in class land.oras.Descriptor

Return same instance but with original JSON

withJson(String) - Method in class land.oras.Index

Return same instance but with original JSON

withJson(String) - Method in class land.oras.Manifest

Return same instance but with original JSON

withLayers(List<Layer>) - Method in class land.oras.Manifest

Return a new manifest with the given layers

withMediaType(String) - Method in class land.oras.Config

Create a new config with media type

withMediaType(String) - Method in class land.oras.Layer

Create a new layer with media type

withNewManifests(ManifestDescriptor) - Method in class land.oras.Index

Return a new index with new manifest added to index

withSkipTlsVerify(boolean) - Method in class land.oras.Registry.Builder

Set the skip TLS verify flag

withSkipTlsVerify(boolean) - Method in class land.oras.utils.OrasHttpClient.Builder

Skip the TLS verification

withSubject(Subject) - Method in class land.oras.Index

Return a new index with the given subject

withSubject(Subject) - Method in class land.oras.Manifest

Return a new manifest with the given config

withTag(String) - Method in class land.oras.LayoutRef

Return a new layout ref with the tag.

withTimeout(Integer) - Method in class land.oras.utils.OrasHttpClient.Builder

Set the timeout

WWW_AUTHENTICATE_HEADER - Static variable in class land.oras.utils.Const

WWW-Authenticate header

Z

ZSTD - Enum constant in enum class land.oras.utils.SupportedCompression

ZSTD

A B C D E F G H I J L M N O P R S T U V W Z
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form