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.HttpClient.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_DESCRIPTION - Static variable in class land.oras.utils.Const
Annotation for the description
ANNOTATION_IMAGE_BASE_NAME - Static variable in class land.oras.utils.Const
Annotation for the base image name
ANNOTATION_IMAGE_URL - Static variable in class land.oras.utils.Const
Annotation for the image URL
ANNOTATION_IMAGE_VERSION - Static variable in class land.oras.utils.Const
Annotation for the image version
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_REVISION - Static variable in class land.oras.utils.Const
Annotation for the revision
ANNOTATION_SOURCE - Static variable in class land.oras.utils.Const
Annotation for the source
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
architecture() - Method in record class land.oras.Platform
Return the os of the platform, or "unknown" if the os is null
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
The artifact type
ArtifactType - Class in land.oras
Class for artifact type
asCredential() - Method in record class land.oras.auth.AuthStore.CredentialHelperResponse
Convert to Credential
asInsecure() - Method in class land.oras.Registry
Return a new registry as insecure but with same settings
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
AuthScheme - Enum Class in land.oras.auth
Enum for authentication schemes
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.
AuthStore.CredentialHelperResponse - Record Class in land.oras.auth
Credential helper response
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

BASIC - Enum constant in enum class land.oras.auth.AuthScheme
Basic authentication
BEARER - Enum constant in enum class land.oras.auth.AuthScheme
Bearer authentication
BearerTokenProvider - Class in land.oras.auth
A provider for bearer token authentication
BearerTokenProvider() - Constructor for class land.oras.auth.BearerTokenProvider
Create a new bearer token provider
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.auth.HttpClient
Create a new HTTP client
build() - Method in class land.oras.auth.HttpClient.Builder
Build the client
build() - Method in class land.oras.OCILayout.Builder
Build the registry
build() - Method in class land.oras.Registry.Builder
Build the registry
builder() - Static method in class land.oras.auth.HttpClient.Builder
Build the client
builder() - Static method in class land.oras.OCILayout
Return a new builder for this oci layout
builder() - Static method in class land.oras.OCILayout.Builder
Return a new builder
builder() - Static method in class land.oras.Registry
Return a new builder for this registry
builder() - Static method in class land.oras.Registry.Builder
Return a new builder

C

code() - Method in record class land.oras.exception.Error
Returns the value of the code record component.
collectLayers(T, String, boolean) - Method in class land.oras.OCI
Collect layers from the ref
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(String) - Method in class land.oras.Registry
Return a new registry with the given registry URL but with same settings
copy(OCI<SourceRefType>, SourceRefType, OCI<TargetRefType>, TargetRefType, boolean) - Static method in class land.oras.CopyUtils
Copy a container from source to target.
CopyUtils - Class in land.oras
Copy utility class.
createTempDir() - Static method in class land.oras.utils.ArchiveUtils
Create a temporary directory
createTempTar() - Static method in class land.oras.utils.ArchiveUtils
Create a temporary archive when uploading directory layers
createTempZip() - Static method in class land.oras.utils.ArchiveUtils
Create a temporary zip file when uploading directory layers with zip media type
Credential(String, String) - Constructor for record class land.oras.auth.AuthStore.Credential
Constructs a new Credential object with the specified username and password.
CredentialHelperResponse(String, String, String) - Constructor for record class land.oras.auth.AuthStore.CredentialHelperResponse
Creates an instance of a CredentialHelperResponse record class.
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 when no unqualified-search-registries is set in the config
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) - Method in class land.oras.Registry.Builder
Return a new builder with default authentication using existing host auth and registry url
defaults(String, String) - Method in class land.oras.Registry.Builder
Set username and password authentication
defaults(String, String, String) - Method in class land.oras.Registry.Builder
Set 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>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Perform a DELETE request
DELETE - Enum constant in enum class land.oras.auth.Scope
Scope for deleting images.
deleteBlob(ContainerRef) - Method in class land.oras.Registry
Delete a blob
deleteManifest(ContainerRef) - Method in class land.oras.Registry
Delete a manifest
Describable - Interface in land.oras
Interface for describable objects
Descriptor - Class in land.oras
Main class for descriptor
Descriptor(String, Long, String, Map<String, String>, String, String, String) - Constructor for class land.oras.Descriptor
Constructor
details() - Method in record class land.oras.exception.Error
Returns the value of the details record component.
digest - Variable in class land.oras.Descriptor
The digest of the layer
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>, Path, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Download to a file
download(URI, Map<String, String>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Download to to input stream

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
empty() - Static method in record class land.oras.Platform
Create a new platform with empty os and architecture
empty(Registry, ContainerRef) - Static method in class land.oras.auth.Scopes
Create a new Scopes object with no scopes
enforceShortNameMode() - Method in class land.oras.auth.RegistriesConf
Enforce the short name mode by checking the configuration.
equals(Object) - Method in record class land.oras.Annotations
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class land.oras.ArtifactType
 
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.AuthStore.CredentialHelperResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class land.oras.auth.HttpClient.ResponseWrapper
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class land.oras.auth.HttpClient.TokenResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class land.oras.Config
 
equals(Object) - Method in class land.oras.ContainerRef
 
equals(Object) - Method in class land.oras.Descriptor
 
equals(Object) - Method in record class land.oras.exception.Error
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class land.oras.Index
 
equals(Object) - Method in class land.oras.Layer
 
equals(Object) - Method in class land.oras.LayoutRef
 
equals(Object) - Method in class land.oras.Manifest
 
equals(Object) - Method in class land.oras.ManifestDescriptor
 
equals(Object) - Method in record class land.oras.Platform
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class land.oras.Referrers
 
equals(Object) - Method in record class land.oras.Repositories
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class land.oras.Subject
 
equals(Object) - Method in record class land.oras.Tags
Indicates whether some other object is "equal to" this one.
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.
expires_in() - Method in record class land.oras.auth.HttpClient.TokenResponse
Returns the value of the expires_in record component.

F

features() - Method in record class land.oras.Platform
Returns the value of the features record component.
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.
filter(Platform) - Method in class land.oras.Index
Filter the manifests by platform
filter(Platform, BiPredicate<Platform, Platform>) - Method in class land.oras.Index
Filter the manifests by platform with a custom comparator
findUnique(Platform) - Method in class land.oras.Index
Find a unique manifest by platform.
forLayout(OCILayout) - Method in class land.oras.LayoutRef
Return a new layout reference for a path
forPath(Path) - Method in class land.oras.LayoutRef
Return a new layout reference for a path
forRegistry(String) - Method in class land.oras.ContainerRef
Return a copy of reference for a registry other registry
forRegistry(Registry) - Method in class land.oras.ContainerRef
Return a copy of reference for a registry other registry
forTarget(String) - Method in class land.oras.ContainerRef
 
forTarget(String) - Method in class land.oras.LayoutRef
 
forTarget(String) - Method in class land.oras.Ref
Return a container ref for the target repository
forTarget(OCI<ContainerRef>) - Method in class land.oras.ContainerRef
 
forTarget(OCI<LayoutRef>) - Method in class land.oras.LayoutRef
 
forTarget(OCI<T>) - Method in class land.oras.Ref
Return a container ref for the target repository
from(String) - Static method in class land.oras.ArtifactType
Create an artifact type
from(List<ManifestDescriptor>) - Static method in class land.oras.Referrers
Create a referrers object from a list of descriptors
from(Registry) - Method in class land.oras.Registry.Builder
Return a new builder with the same configuration as the given registry
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(InputStream, Class<T>) - Static method in class land.oras.utils.JsonUtils
Convert a JSON string to an object
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
fromMediaType(String) - Static method in enum class land.oras.utils.SupportedCompression
Get the algorithm from a digest
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
fromToml(String, Class<T>) - Static method in class land.oras.utils.TomlUtils
Convert a TOML string to an object
fromToml(Path, Class<T>) - Static method in class land.oras.utils.TomlUtils
Read a TOML file and convert its contents to an object.

G

get(URI, Map<String, String>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
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
getAliases() - Method in class land.oras.auth.RegistriesConf
Return the aliases
getAliasKey(ContainerRef) - Method in class land.oras.auth.RegistriesConf
Return the key of the alias
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
getAnnotationsForJson() - Method in class land.oras.Descriptor
We never serialize empty annotations
getApiRegistry() - Method in class land.oras.ContainerRef
Get the API registry
getApiRegistry(Registry) - 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.Index
 
getArtifactType() - Method in class land.oras.Manifest
 
getArtifactType() - Method in class land.oras.ManifestDescriptor
Get the artifact type
getArtifactTypeAsString() - Method in class land.oras.Index
Get the artifact type as string for JSON serialization
getArtifactTypeAsString() - Method in class land.oras.Manifest
Get the artifact type as string for JSON serialization
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
 
getAuthScheme() - Method in class land.oras.auth.AbstractUsernamePasswordProvider
 
getAuthScheme() - Method in interface land.oras.auth.AuthProvider
Get the authentication scheme for this provider
getAuthScheme() - Method in class land.oras.auth.AuthStoreAuthenticationProvider
 
getAuthScheme() - Method in class land.oras.auth.BearerTokenProvider
 
getAuthScheme() - 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(Registry) - 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(Registry) - Method in class land.oras.ContainerRef
Return the blobs upload URL with the digest for single POST upload
getBlobsUploadPath(Registry) - Method in class land.oras.ContainerRef
Return the blobs upload URL for POST upload to get the upload location
getConfig() - Method in class land.oras.Manifest
Get the config
getContainerRef() - Method in class land.oras.auth.Scopes
Get the container reference
getCredentialHelperBinary(ContainerRef) - Method in class land.oras.auth.AuthStore
Get the credential helper binary for the given containerRef.
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 interface land.oras.Describable
Get the manifest descriptor for this describable
getDescriptor() - Method in class land.oras.Index
 
getDescriptor() - Method in class land.oras.Manifest
 
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
getEffectiveRegistry(Registry) - Method in class land.oras.ContainerRef
Get the effective registry based on given target This methods will perform HEAD request to determine the first unqualified search registry that contains the container reference if the reference is unqualified, otherwise return the registry of the reference.
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
getFileExtension() - Method in enum class land.oras.utils.SupportedCompression
Get the file extension
getFolder() - Method in class land.oras.LayoutRef
Get the folder
getFullRepository() - Method in class land.oras.ContainerRef
Get the full repository name including the namespace if any
getFullRepository(Registry) - Method in class land.oras.ContainerRef
Get the full repository name including the namespace if any
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
getManifestsPath(Registry) - 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
getNamespace(Registry) - Method in class land.oras.ContainerRef
Get the effective namespace based on given registry traget
getPassword() - Method in class land.oras.auth.AbstractUsernamePasswordProvider
Get the password
getPath() - Method in class land.oras.LocalPath
Get the path
getPath() - Method in class land.oras.OCILayout
Return the path to the OCI layout
getPlatform() - Method in class land.oras.ManifestDescriptor
Return the platform as a Platform object
getPlatformOrNull() - Method in class land.oras.ManifestDescriptor
Return the platform or null if the platform is not set Only use for serialization purposes, as the platform field is nullable in the JSON representation of the manifest descriptor
getPrefix() - Method in enum class land.oras.utils.SupportedAlgorithm
Get the prefix
getReferrers(ContainerRef, ArtifactType) - Method in class land.oras.Registry
 
getReferrers(LayoutRef, ArtifactType) - Method in class land.oras.OCILayout
 
getReferrers(T, ArtifactType) - Method in class land.oras.OCI
Get the referrers of a container
getReferrersPath(ArtifactType) - Method in class land.oras.ContainerRef
Return the referrers URL for this container referrer
getReferrersPath(Registry, ArtifactType) - Method in class land.oras.ContainerRef
Return the referrers URL for this container referrer
getRegistriesConf() - Method in class land.oras.Registry
Get the registries configuration
getRegistry() - Method in class land.oras.auth.Scopes
Get the registry
getRegistry() - Method in class land.oras.ContainerRef
Create a new container reference
getRegistry() - Method in class land.oras.Descriptor
Return the resolved registry.
getRegistry() - Method in class land.oras.Registry
Get the registry URL
getRepositories() - Method in class land.oras.OCI
Get the tags for a ref
getRepositories() - Method in class land.oras.OCILayout
 
getRepositories() - Method in class land.oras.Registry
 
getRepositoriesPath() - Method in class land.oras.ContainerRef
Return the catalog repositories URL
getRepositoriesPath(Registry) - Method in class land.oras.ContainerRef
Return the catalog repositories URL
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
getScopes() - Method in class land.oras.auth.Scopes
Get the scopes
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
getSize() - Method in enum class land.oras.utils.SupportedAlgorithm
Get the size of the digest
getStatusCode() - Method in exception land.oras.exception.OrasException
Get the status code
getSubject() - Method in interface land.oras.Describable
Get the subject
getSubject() - Method in class land.oras.Index
 
getSubject() - Method in class land.oras.Manifest
 
getTag() - Method in class land.oras.Ref
Get the tag
getTags(ContainerRef) - Method in class land.oras.Registry
 
getTags(LayoutRef) - Method in class land.oras.OCILayout
 
getTags(T) - Method in class land.oras.OCI
Get the tags for a ref
getTagsPath() - Method in class land.oras.ContainerRef
Return the tag URL
getTagsPath(Registry) - Method in class land.oras.ContainerRef
Return the tag URL
getTarget(OCI<ContainerRef>) - Method in class land.oras.ContainerRef
 
getTarget(OCI<LayoutRef>) - Method in class land.oras.LayoutRef
 
getTarget(OCI<T>) - Method in class land.oras.Ref
Get the target repository for the ref
getToken() - Method in class land.oras.auth.BearerTokenProvider
Get the token
getTopLevelDigest() - Method in class land.oras.Manifest
Get the top-level digest (for JSON serialization)
getUnqualifiedRegistries() - Method in class land.oras.auth.RegistriesConf
Get the list of unqualified registries.
getUsername() - Method in class land.oras.auth.AbstractUsernamePasswordProvider
Get the username
GZIP - Enum constant in enum class land.oras.utils.SupportedCompression
GZIP

H

hasAlias(String) - Method in class land.oras.auth.RegistriesConf
Check if the given alias exists in the configuration.
hasFileAnnotations(String) - Method in record class land.oras.Annotations
Check if there are annotations for a file
hashCode() - Method in record class land.oras.Annotations
Returns a hash code value for this object.
hashCode() - Method in class land.oras.ArtifactType
 
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.AuthStore.CredentialHelperResponse
Returns a hash code value for this object.
hashCode() - Method in record class land.oras.auth.HttpClient.ResponseWrapper
Returns a hash code value for this object.
hashCode() - Method in record class land.oras.auth.HttpClient.TokenResponse
Returns a hash code value for this object.
hashCode() - Method in class land.oras.Config
 
hashCode() - Method in class land.oras.ContainerRef
 
hashCode() - Method in class land.oras.Descriptor
 
hashCode() - Method in record class land.oras.exception.Error
Returns a hash code value for this object.
hashCode() - Method in class land.oras.Index
 
hashCode() - Method in class land.oras.Layer
 
hashCode() - Method in class land.oras.LayoutRef
 
hashCode() - Method in class land.oras.Manifest
 
hashCode() - Method in class land.oras.ManifestDescriptor
 
hashCode() - Method in record class land.oras.Platform
Returns a hash code value for this object.
hashCode() - Method in class land.oras.Referrers
 
hashCode() - Method in record class land.oras.Repositories
Returns a hash code value for this object.
hashCode() - Method in class land.oras.Subject
 
hashCode() - Method in record class land.oras.Tags
Returns a hash code value for this object.
head(URI, Map<String, String>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Perform a HEAD request
headers() - Method in record class land.oras.auth.HttpClient.ResponseWrapper
Returns the value of the headers record component.
HttpClient - Class in land.oras.auth
HTTP client for ORAS
HttpClient.Builder - Class in land.oras.auth
Builder for the HTTP client
HttpClient.ResponseWrapper<T> - Record Class in land.oras.auth
Response wrapper
HttpClient.TokenResponse - Record Class in land.oras.auth
The token response

I

Index - Class in land.oras
Index from an OCI layout
insecure() - Method in class land.oras.Registry.Builder
Set insecure communication and no authentification
insecure(String) - Method in class land.oras.Registry.Builder
Set insecure communication and no authentification
insecure(String, String, String) - Method in class land.oras.Registry.Builder
Return a new insecure builder with username and password authentication
isAutoUnpack() - Method in enum class land.oras.utils.SupportedCompression
Whether the media type is auto unpacked (it's an image layer, not whatever media type the user specified)
isBlocked(ContainerRef) - Method in class land.oras.auth.RegistriesConf
Check if the given registry is marked as blocked in the configuration.
isBlocked(Registry) - Method in class land.oras.ContainerRef
Check if access to this container reference is blocked by the registry configuration
isIndexMediaType(String) - Method in class land.oras.OCI
Return if a media type is an index media type
isInsecure() - Method in class land.oras.Registry
Return if this registry is insecure
isInsecure(ContainerRef) - Method in class land.oras.auth.RegistriesConf
Check if the given registry is marked as insecure in the configuration.
isInsecure(Registry) - Method in class land.oras.ContainerRef
Check if access to this container reference is insecure by the registry configuration
isManifestMediaType(String) - Method in class land.oras.OCI
Return if a media type is a manifest media type
issued_at() - Method in record class land.oras.auth.HttpClient.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
isUnqualified() - Method in class land.oras.ContainerRef
Whether the container reference is unqualified without registry
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
JSON_PROPERTY_ANNOTATIONS - Static variable in class land.oras.utils.Const
JSON property for annotations
JSON_PROPERTY_ARTIFACT_TYPE - Static variable in class land.oras.utils.Const
JSON property for artifact type
JSON_PROPERTY_CONFIG - Static variable in class land.oras.utils.Const
JSON property for config
JSON_PROPERTY_DATA - Static variable in class land.oras.utils.Const
JSON property for data (base64 encoded)
JSON_PROPERTY_DIGEST - Static variable in class land.oras.utils.Const
JSON property for digest
JSON_PROPERTY_LAYERS - Static variable in class land.oras.utils.Const
JSON property for layers
JSON_PROPERTY_MANIFESTS - Static variable in class land.oras.utils.Const
JSON property for manifests
JSON_PROPERTY_MEDIA_TYPE - Static variable in class land.oras.utils.Const
JSON property for media type
JSON_PROPERTY_PLATFORM - Static variable in class land.oras.utils.Const
JSON property for platform
JSON_PROPERTY_SCHEMA_VERSION - Static variable in class land.oras.utils.Const
JSON property for schema version
JSON_PROPERTY_SIZE - Static variable in class land.oras.utils.Const
JSON property for size
JSON_PROPERTY_SUBJECT - Static variable in class land.oras.utils.Const
JSON property for subject
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.
LEGACY_MANIFEST_MEDIA_TYPE - Static variable in class land.oras.utils.Const
Legacy manifest media type for Docker distribution manifest v1, which is a JWS (JSON Web Signature) format and is not widely used anymore, but some registries may still support it for backward compatibility Ensure to raise a proper error message when we encounter this media type, as it is not supported by the SDK
linux386() - Static method in record class land.oras.Platform
Create a new platform linux/amd64
linuxAmd64() - Static method in record class land.oras.Platform
Create a new platform linux/amd64
linuxArm64V8() - Static method in record class land.oras.Platform
Create a new platform linux arm64/v8
linuxArmV6() - Static method in record class land.oras.Platform
Create a new platform linux arm/v6
linuxArmV7() - Static method in record class land.oras.Platform
Create a new platform linux arm/v7
linuxPpc64le() - Static method in record class land.oras.Platform
Create a new platform ppc64le
linuxRiscv64() - Static method in record class land.oras.Platform
Create a new platform riscv64
linuxS390x() - Static method in record class land.oras.Platform
Create a new platform s390x
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.ContainerRef
The logger for this class.
LOG - Static variable in class land.oras.CopyUtils
The logger
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
matches(Platform, Platform) - Static method in record class land.oras.Platform
Check if 2 platform are matching, which means the os and architecture are the same (including variant)
matches(Platform, Platform, boolean) - Static method in record class land.oras.Platform
Check if 2 platform are matching, which means the os and architecture are the same (including variant)
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.
newConf() - Static method in class land.oras.auth.RegistriesConf
Create a new RegistriesConf instance by loading configuration from standard paths.
newConf(List<Path>) - Static method in class land.oras.auth.RegistriesConf
Create a new RegistriesConf instance by loading configuration from the specified paths.
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
NONE - Enum constant in enum class land.oras.auth.AuthScheme
No authentication

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) - Static method in record class land.oras.Platform
Create a new platform with the given os and architecture
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(String, String, String) - Static method in record class land.oras.Platform
Create a new platform with the given os, architecture and variant
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
of(Descriptor, String) - Static method in class land.oras.ManifestDescriptor
Create a manifest descriptor with the given digest
of(Manifest) - Static method in class land.oras.ManifestDescriptor
Utility method.
of(Manifest, Platform, Annotations, SupportedAlgorithm) - Static method in class land.oras.ManifestDescriptor
Utility method.
of(OCILayout) - Static method in class land.oras.LayoutRef
Return a new layout reference for a path and digest or tag
of(OCILayout, String) - Static method in class land.oras.LayoutRef
Return a new layout reference for a path and digest or tag
of(Registry, ContainerRef, Scope...) - Static method in class land.oras.auth.Scopes
Create a new Scopes object
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(int, String) - Constructor for exception land.oras.exception.OrasException
Constructor
OrasException(String) - Constructor for exception land.oras.exception.OrasException
Constructor
OrasException(String, Throwable) - Constructor for exception land.oras.exception.OrasException
Constructor
OrasException(HttpClient.ResponseWrapper<String>) - Constructor for exception land.oras.exception.OrasException
New exception with a message and a response
OrasModel - Annotation Interface in land.oras
Annotation to mark ORAS models
os() - Method in record class land.oras.Platform
Return the os of the platform, or "unknown" if the os is null
osFeatures() - Method in record class land.oras.Platform
Returns the value of the osFeatures record component.
osVersion() - Method in record class land.oras.Platform
Returns the value of the osVersion record component.

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>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Perform a Patch request
Platform - Record Class in land.oras
Record for platform information
Platform(String, String, String, String, List<String>, List<String>) - Constructor for record class land.oras.Platform
Creates an instance of a Platform record class.
PLATFORM_ARCHITECTURE - Static variable in class land.oras.utils.Const
The platform architecture key
PLATFORM_ARCHITECTURE_386 - Static variable in class land.oras.utils.Const
The platform value for 386 architecture
PLATFORM_ARCHITECTURE_AMD64 - Static variable in class land.oras.utils.Const
The platform value for amd64 architecture
PLATFORM_ARCHITECTURE_ARM - Static variable in class land.oras.utils.Const
The platform value for arm architecture
PLATFORM_ARCHITECTURE_ARM64 - Static variable in class land.oras.utils.Const
The platform value for arm64 architecture
PLATFORM_ARCHITECTURE_PPC64LE - Static variable in class land.oras.utils.Const
The platform value for ppc64le architecture
PLATFORM_ARCHITECTURE_RISCV64 - Static variable in class land.oras.utils.Const
The platform value for riscv64 architecture
PLATFORM_ARCHITECTURE_S390X - Static variable in class land.oras.utils.Const
The platform value for s390x architecture
PLATFORM_FEATURES - Static variable in class land.oras.utils.Const
The platform features key, which can be used in the annotation "features" to specify the features of the platform, such as gpu or fpga
PLATFORM_LINUX - Static variable in class land.oras.utils.Const
The platform value for linux os
PLATFORM_OS - Static variable in class land.oras.utils.Const
The platform OS key
PLATFORM_OS_FEATURES - Static variable in class land.oras.utils.Const
The platform OS features key, which can be used in the annotation "os.features" to specify the features of the OS, such as sse4 or aes
PLATFORM_OS_VERSION - Static variable in class land.oras.utils.Const
The platform OS version key, which can be used in the annotation "os.version" to specify the version of the OS, such as ubuntu 20.04 or alpine 3.14
PLATFORM_UNKNOWN - Static variable in class land.oras.utils.Const
The default value for unknown platform information
PLATFORM_VARIANT - Static variable in class land.oras.utils.Const
The platform variant key, which can be used in the annotation "variant" to specify the variant of the architecture, such as armv7 or armv8
PLATFORM_WINDOWS - Static variable in class land.oras.utils.Const
The platform value for windows OS
post(URI, byte[], Map<String, String>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Perform a POST request.
probeDescriptor(ContainerRef) - Method in class land.oras.Registry
 
probeDescriptor(LayoutRef) - Method in class land.oras.OCILayout
 
probeDescriptor(T) - Method in class land.oras.OCI
Probe a descriptor.
PULL - Enum constant in enum class land.oras.auth.Scope
Scope for pulling images.
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
pullConfig(T, Config) - Method in class land.oras.OCI
Pull config data or just return the data from config if set inline
PUSH - Enum constant in enum class land.oras.auth.Scope
Scope for pushing images.
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, long, Supplier<InputStream>, Map<String, String>) - 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, long, Supplier<InputStream>, Map<String, String>) - 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, long, Supplier<InputStream>, Map<String, String>) - Method in class land.oras.OCI
Push a blob from input stream with known digest and size
pushBlob(T, InputStream) - Method in class land.oras.OCI
Push a blob stream.
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
 
pushIndex(LayoutRef, Index) - Method in class land.oras.OCILayout
 
pushIndex(T, Index) - Method in class land.oras.OCI
Push an index
pushLayers(T, Annotations, boolean, LocalPath...) - Method in class land.oras.OCI
Push layers to the target
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>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
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
Constructor
Referrers - Class in land.oras
List of referrers
refreshToken(HttpClient.ResponseWrapper<T>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Retrieve a token from the registry
RegistriesConf - Class in land.oras.auth
Handle registries.conf configuration
registry - Variable in class land.oras.Descriptor
The registry
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
repositories() - Method in record class land.oras.Repositories
Returns the value of the repositories record component.
Repositories - Record Class in land.oras
The repositories response object
Repositories(List<String>) - Constructor for record class land.oras.Repositories
Creates an instance of a Repositories record class.
response() - Method in record class land.oras.auth.HttpClient.ResponseWrapper
Returns the value of the response record component.
ResponseWrapper(T, int, Map<String, String>) - Constructor for record class land.oras.auth.HttpClient.ResponseWrapper
Creates an instance of a ResponseWrapper record class.
rewrite(ContainerRef) - Method in class land.oras.auth.RegistriesConf
Rewrite the given container reference according to the matching registry configuration.

S

Scope - Enum Class in land.oras.auth
Enum representing the different scopes for authentication.
Scopes - Class in land.oras.auth
Store scopes
secret() - Method in record class land.oras.auth.AuthStore.CredentialHelperResponse
Returns the value of the secret record component.
serverUrl() - Method in record class land.oras.auth.AuthStore.CredentialHelperResponse
Returns the value of the serverUrl record component.
setToken(HttpClient.TokenResponse) - Method in class land.oras.auth.BearerTokenProvider
Set the token
SHA1 - Enum constant in enum class land.oras.utils.SupportedAlgorithm
SHA-1 This is unsecure, only useful when computing digests for git content (like Flux CD)
SHA256 - Enum constant in enum class land.oras.utils.SupportedAlgorithm
SHA-256
SHA384 - Enum constant in enum class land.oras.utils.SupportedAlgorithm
SHA-384
SHA512 - Enum constant in enum class land.oras.utils.SupportedAlgorithm
SHA-512
size - Variable in class land.oras.Descriptor
The size of the layer
statusCode() - Method in record class land.oras.auth.HttpClient.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

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
tarcompress(LocalPath, String) - Static method in class land.oras.utils.ArchiveUtils
Create a tar compressed 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.HttpClient.TokenResponse
Returns the value of the token record component.
TokenResponse(String, String, Integer, ZonedDateTime) - Constructor for record class land.oras.auth.HttpClient.TokenResponse
Creates an instance of a TokenResponse record class.
toLowerCase() - Method in enum class land.oras.auth.Scope
Converts the enum name to lowercase.
TomlUtils - Class in land.oras.utils
Utility class for TOML operations.
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.AuthStore.CredentialHelperResponse
Returns a string representation of this record class.
toString() - Method in record class land.oras.auth.HttpClient.ResponseWrapper
Returns a string representation of this record class.
toString() - Method in record class land.oras.auth.HttpClient.TokenResponse
Returns a string representation of this record class.
toString() - Method in class land.oras.Config
 
toString() - Method in class land.oras.ContainerRef
 
toString() - Method in class land.oras.Descriptor
 
toString() - Method in record class land.oras.exception.Error
Returns a string representation of this record class.
toString() - Method in class land.oras.Index
 
toString() - Method in class land.oras.Layer
 
toString() - Method in class land.oras.LayoutRef
 
toString() - Method in class land.oras.LocalPath
 
toString() - Method in class land.oras.Manifest
 
toString() - Method in class land.oras.ManifestDescriptor
 
toString() - Method in record class land.oras.Platform
Returns a string representation of this record class.
toString() - Method in class land.oras.Referrers
 
toString() - Method in record class land.oras.Repositories
Returns a string representation of this record class.
toString() - Method in class land.oras.Subject
 
toString() - Method in record class land.oras.Tags
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
toToml(Object) - Static method in class land.oras.utils.TomlUtils
Convert an object to a TOML string

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
uncompressuntar(Path, String) - Static method in class land.oras.utils.ArchiveUtils
Uncompress a compressed file and untar to a temporary directory
uncompressuntar(Path, Path, String) - Static method in class land.oras.utils.ArchiveUtils
Uncompress a compressed file and untar it to the target directory
unknown() - Static method in class land.oras.ArtifactType
Create an unknown artifact type
unknown() - Static method in record class land.oras.Platform
Create a new platform with unknown os and architecture
unspecified(Platform) - Static method in record class land.oras.Platform
Return true if the platform is unspecified, which means both os and architecture are either empty or unknown
unspecifiedPlatforms() - Method in class land.oras.Index
Get the list of manifests that have unspecified platform
untar(InputStream, Path) - Static method in class land.oras.utils.ArchiveUtils
Extract a tar file to a target directory
untar(Path) - Static method in class land.oras.utils.ArchiveUtils
Convienience method to extract a tar file to a temporary directory
untar(Path, Path) - Static method in class land.oras.utils.ArchiveUtils
Extract a tar file to a target directory
unzip(Path, Path) - Static method in class land.oras.utils.ArchiveUtils
Extract a zip file to a target directory
upload(String, URI, Map<String, String>, Path, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Upload a file
upload(URI, long, Map<String, String>, Supplier<InputStream>, Scopes, AuthProvider) - Method in class land.oras.auth.HttpClient
Upload from an input 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.Versions
User agent value
username() - Method in record class land.oras.auth.AuthStore.Credential
Returns the value of the username record component.
username() - Method in record class land.oras.auth.AuthStore.CredentialHelperResponse
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.auth.AuthScheme
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class land.oras.auth.Scope
Returns the enum constant of this class with the specified name.
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.auth.AuthScheme
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class land.oras.auth.Scope
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.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.
variant() - Method in record class land.oras.Platform
Returns the value of the variant record component.
VARIANT_V5 - Static variable in class land.oras.utils.Const
The v5 variant for arm architecture, which can be used in the annotation "variant" to specify the variant of the arm architecture
VARIANT_V6 - Static variable in class land.oras.utils.Const
The v6 variant for arm architecture, which can be used in the annotation "variant" to specify the variant of the arm architecture
VARIANT_V7 - Static variable in class land.oras.utils.Const
The v7 variant for arm architecture, which can be used in the annotation "variant" to specify the variant of the arm architecture
VARIANT_V8 - Static variable in class land.oras.utils.Const
The v8 variant for arm architecture, which can be used in the annotation "variant" to specify the variant of the arm architecture
Versions - Class in land.oras.utils
SDK Version

W

windowsAmd64() - Static method in record class land.oras.Platform
Create a new platform windows/amd64
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.Index
Return a new index with the given artifact type
withArtifactType(ArtifactType) - Method in class land.oras.Manifest
Return a new manifest with the given artifact type
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
withFeatures(List<String>) - Method in record class land.oras.Platform
Create a new platform with the given features
withFileAnnotations(String, Map<String, String>) - Method in record class land.oras.Annotations
Create a new annotations record with the given file annotations
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
withNewRegistryScopes(Scope...) - Method in class land.oras.auth.Scopes
Return a new copy of the Scopes object with the given scopes
withNewScope(String) - Method in class land.oras.auth.Scopes
Return a new copy of the Scopes object with the given scope
withOsFeatures(List<String>) - Method in record class land.oras.Platform
Create a new platform with the given os features
withOsVersion(String) - Method in record class land.oras.Platform
Create a new platform with the given os version
withPlatform(Platform) - Method in class land.oras.ManifestDescriptor
Create a manifest descriptor with the given platform
withRegistry(String) - Method in class land.oras.Config
 
withRegistry(String) - Method in class land.oras.Descriptor
Return same instance but with resolved registry
withRegistry(String) - Method in class land.oras.Manifest
 
withRegistry(String) - Method in class land.oras.Registry.Builder
Set the registry URL
withRegistryScopes(Scope...) - Method in class land.oras.auth.Scopes
Return a new copy of the Scopes object with the given scopes
withSkipTlsVerify(boolean) - Method in class land.oras.auth.HttpClient.Builder
Skip the TLS verification
withSkipTlsVerify(boolean) - Method in class land.oras.Registry.Builder
Set the skip TLS verify flag
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.auth.HttpClient.Builder
Set the timeout
withVariant(String) - Method in record class land.oras.Platform
Create a new platform with the given variant
WWW_AUTHENTICATE_HEADER - Static variable in class land.oras.utils.Const
WWW-Authenticate header

Z

zip(LocalPath) - Static method in class land.oras.utils.ArchiveUtils
Zip a local source dire and return a temporary zip file as a local path
ZIP - Enum constant in enum class land.oras.utils.SupportedCompression
ZIP
ZIP_MEDIA_TYPE - Static variable in class land.oras.utils.Const
Zip media type
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