iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
iceberg::SupportsStorageCredentials Class Referenceabstract

Mix-in for FileIO implementations that route object paths to per-prefix file systems built from vended storage credentials, letting the catalog stay decoupled from concrete storage implementations. More...

#include <file_io.h>

Inheritance diagram for iceberg::SupportsStorageCredentials:
iceberg::ResolvingFileIO

Public Member Functions

virtual Status SetStorageCredentials (const std::vector< StorageCredential > &storage_credentials)=0
 Install vended storage credentials.
 
virtual std::vector< StorageCredential > credentials () const =0
 Return the storage credentials this FileIO holds.
 
virtual Status InitializeStorageCredentials (const std::vector< StorageCredential > &storage_credentials, std::shared_ptr< StorageCredentialProvider > provider)
 Install initial credentials and their refresh source before first use.
 

Detailed Description

Mix-in for FileIO implementations that route object paths to per-prefix file systems built from vended storage credentials, letting the catalog stay decoupled from concrete storage implementations.

Member Function Documentation

◆ credentials()

virtual std::vector< StorageCredential > iceberg::SupportsStorageCredentials::credentials ( ) const
pure virtual

Return the storage credentials this FileIO holds.

By value because a concurrent install may replace them. An implementation that delegates may report what was installed on it.

Implemented in iceberg::ResolvingFileIO.

◆ InitializeStorageCredentials()

virtual Status iceberg::SupportsStorageCredentials::InitializeStorageCredentials ( const std::vector< StorageCredential > &  storage_credentials,
std::shared_ptr< StorageCredentialProvider >  provider 
)
inlinevirtual

Install initial credentials and their refresh source before first use.

The default implementation supports static credentials only.

Reimplemented in iceberg::ResolvingFileIO.

◆ SetStorageCredentials()

virtual Status iceberg::SupportsStorageCredentials::SetStorageCredentials ( const std::vector< StorageCredential > &  storage_credentials)
pure virtual

Install vended storage credentials.

Implemented in iceberg::ResolvingFileIO.


The documentation for this class was generated from the following file: