All Classes and Interfaces
Class
Description
Abstracts common code from KeyDeletingService and DirectoryDeletingService
which is now used by SnapshotDeletingService as well.
Base class for responses that need to move keys from an arbitrary table to
the deleted table.
Base class for responses that need to move multipart info part keys to the
deleted table.
Authorizer access lock interface.
Implementation of
AuthorizerLock.Utility class for common bucket encryption key operations.
Annotation to mark a class that belongs to a specific Layout Version.
Factory class to instantiate bucket layout aware request classes.
BucketManager handles all the bucket level operations.
Implementation for
BucketManager
BucketManager uses MetadataDB to store bucket level information.A class for collecting and reporting bucket utilization metrics.
A collection of things that we want to maintain about a tenant in memory.
Stores cached Access ID info.
Annotation to provide information about clean up table information for
OMClientResponse.This service issues a compaction request for a column family of om.db.
This is the background service to compact OM rocksdb tables.
Used in
DirectoryDeletingService
to capture the result of each delete task.Class contains metrics related to the OM Deletion services.
Background service responsible for purging deleted directories and files
in the Ozone Manager (OM) and associated snapshots.
Annotation used to "disallow" an API if current layout version does
not include the associated layout feature.
A dummy OMClientResponse implementation.
Context required for execution of a request.
Class to resolve absolute paths for FSO DirectoryInfo Objects.
Separated network server for gRPC transport OzoneManagerService s3g->OM.
In Memory version of MultiTenantAccessController.
Interface for Ozone Acl management.
This is the background service to delete keys.
Handles key level commands.
Implementation of keyManager.
Common class to do listing of resources after merging
rocksDB table cache and actual table.
Iterator for Cache entries in a Dir and File Table.
Interface for iteration of Heap Entries.
Iterator for DB entries from a given rocksDB table.
Entry to be added to the heap.
Implement lexicographical sorting of the file status by sorting file status
across multiple lists.
Implementation of provider with local S3 secret store.
This is the background service to abort incomplete Multipart Upload.
Class to take multiple locks on multiple snapshots.
Defines the operations needed for multi-tenant access control.
Define an acl.
Define a policy to be created.
Builder class for a policy.
Define a role to be created.
Builder class for a role.
Utility class to parse
OzoneObj.getPath().Class to resolve paths of Objects.
Implementation of OzoneLockStrategy interface.
Enum to define Audit Action types for OzoneManager.
This class is the server-side translator that forwards requests received on
OMAdminProtocolPB to the OMAdminProtocolServer implementation.Handles allocate block request.
Handles allocate block request - prefix layout.
Response for AllocateBlock request.
Response for AllocateBlock request - prefix layout.
This class is used for OM Audit logs.
Builder class for build AuditMessage.
Base class for Bucket acl request.
Response for Bucket acl request.
Handle add Acl request for bucket.
Handles CreateBucket Request.
Response for CreateBucket request.
Handles DeleteBucket Request.
Response for DeleteBucket request.
Handle removeAcl request for bucket.
Handle setAcl request for bucket.
Handle set owner request for bucket.
Response for set owner request.
Handle SetBucketProperty Request.
Response for SetBucketProperty request.
Handle CancelDelegationToken Request.
Handle response for CancelDelegationToken request.
OM request class to cancel preparation.
Response for cancel prepare.
Certificate client for OzoneManager.
OMClientRequest provides methods which every write OM request should
implement.
Stores the result of request execution in
OMClientRequest#validateAndUpdateCache.
Utility class for OMClientRequest.
Interface for OM Responses, each OM response should implement this interface.
An annotation to mark methods that do certain request validations based on the
request protocol's client version.
Provides the current checkpoint Snapshot of the OM DB.
Utility class for handling operations related to OM DB Checkpoints.
OM database definitions.
Handles purging of keys from OM DB.
Response for
OMDirectoriesPurgeRequestWithFSO request.Handle create directory request.
Stores the result of request execution in
OMClientRequest#validateAndUpdateCache.
Handle create directory request.
Response for create directory request.
Response for create directory request.
Handles EchoRPC request (write).
Response for EchoRPC request (write).
entry for execution flow for write request.
Handles create file request.
Handles create file request layout version1.
Response for crate file request.
Response for create file request - prefix layout.
Base class for file requests.
Return codes used by verifyFilesInPath method.
Class to return the results from verifyFilesInPath.
Class to return the results from verifyDirectoryKeysInPath.
Handles finalizeUpgrade request.
Response for finalizeUpgrade request.
This class is used exclusively in FSO buckets..
Builder class for OmFSOFile.
Handle GetDelegationToken Request.
Handle response for GetDelegationToken request.
Class to maintain metrics and info related to OM HA.
Class which maintains peer information and it's own OM node information.
This class is the server-side translator that forwards requests received on
OMInterServiceProtocolPB
to the OzoneManagerInterService server implementation.Base class for Bucket acl request.
Handles key ACL requests - prefix layout.
Response for Bucket acl request.
Response for Bucket acl request for prefix layout.
Handle add Acl request for bucket.
Handle add Acl request for bucket for prefix layout.
Handles CommitKey request.
Handles CommitKey request - prefix layout.
Response for CommitKey request.
Response for CommitKey request - prefix layout1.
Handles CreateKey request.
Handles CreateKey request layout version1.
Response for CreateKey request.
Response for CreateKey request - prefix layout.
Handles DeleteKey request.
Handles DeleteKey request - prefix layout.
Response for DeleteKey request.
Response for DeleteKey request.
Helper methods related to OM key HSync.
Handles purging of keys from OM DB.
Response for
OMKeyPurgeRequest request.Handle add Acl request for bucket.
Handle remove Acl request for bucket for prefix layout.
Handles rename key request.
Handles rename key request - prefix layout.
Response for RenameKey request.
Response for RenameKey request - prefix layout.
Interface for key write requests.
OmKeyResponse.
Handles DeleteKey request.
Handles DeleteKeys request for recursive bucket deletion.
Response for DeleteKey request.
Response for DeleteKeys request.
Handle add Acl request for bucket.
Handle set Acl request for bucket for prefix layout.
Handle add SetTimes request for key.
Handle set times request for bucket for prefix layout.
Response for Bucket acl request.
Response for Bucket acl request for prefix layout.
Handles rename keys request.
Response for RenameKeys request.
List of OM Layout features / versions.
'Aspect' for OM Layout Feature API.
Class to manage layout versions and features for Ozone Manager.
An annotation to mark methods that do certain request validations based on the
server's layout version and capability to perform a certain operation.
Ozone metadata manager interface.
OM Metadata Reading class for the OM and Snapshot managers.
Interface OM Metadata Reading metrics classes.
This class is for maintaining Ozone Manager statistics.
OmMetricsInfo stored in a file, which will be used during OM restart to
initialize the metrics.
Utility class related to OM Multipart Upload.
OM MultiTenant manager interface.
Implements OMMultiTenantManager.
This is the JMX management interface for OM information.
Handles requests to move open keys from the open key table to the delete
table.
Handles responses to move open keys from the open key table to the delete
table.
Including OM performance related metrics.
PolicyProvider for OM protocols.Base class for Prefix acl request.
Response for Prefix Acl request.
Handle add Acl request for prefix.
Handle remove Acl request for prefix.
Handle set Acl request for prefix.
OM Request used to flush all transactions to disk, take a DB snapshot, and
purge the logs, leaving Ratis in a clean state without unapplied log
entries.
Response for prepare request.
Handle OMQuotaRepairRequest Request.
Response for
OMQuotaRepairRequest request.Background Sync thread that reads Multi-Tenancy state from OM DB
and applies it to Ranger.
OmRatisSnapshotProvider downloads the latest checkpoint from the
leader OM and loads the checkpoint into State Machine.
Perform actions for RecoverLease requests.
Performs tasks for RecoverLease request responses.
Handle RenewDelegationToken Request.
Handle response for RenewDelegationToken request.
Utility class to build OmResponse.
Handles OMSetRangerServiceVersionRequest.
Response for OMSetRangerServiceVersionRequest.
Handles SetSecret request.
Response for SetSecret request.
Metadata Reading class for OM Snapshots.
Handles CreateSnapshot Request.
Response for OMSnapshotCreateRequest.
Handles DeleteSnapshot Request.
Response for OMSnapshotDeleteRequest.
This class contains internal Snapshot Operation metrics.
OmSnapshotLocalData is the in-memory representation of snapshot local metadata.
Represents metadata for a specific version in a snapshot.
Manages local data and metadata associated with Ozone Manager (OM) snapshots,
including the creation, storage, and representation of data as YAML files.
Class for creating and reading snapshot local properties / data YAML files.
Factory class for constructing and pooling instances of the Yaml object.
This class is used to manage/create OM snapshots.
This class is for maintaining Snapshot Manager statistics.
Handles OMSnapshotMoveDeletedKeys Request.
Response for OMSnapshotMoveDeletedKeysRequest.
Handles OMSnapshotMoveTableKeysRequest Request.
Response for OMSnapshotMoveDeletedKeysRequest.
Utility class for snapshot move requests.
Handles OMSnapshotPurge Request.
Response for OMSnapshotPurgeRequest.
Changes snapshot name.
Response for OMSnapshotRenameRequest.
Updates the exclusive size of the snapshot.
Response for OMSnapshotSetPropertyRequest.
Ozone Manager Snapshot Utilities.
This interface is used by the OzoneManagerStarter class to allow the
dependencies to be injected to the CLI class.
Ozone Manager VERSION file representation.
Enum to define Audit Action types for system audit in OzoneManager.
Handles OMTenantAssignAdminRequest.
Response for OMTenantAssignAdminRequest.
Handles OMAssignUserToTenantRequest.
Response for OMAssignUserToTenantRequest.
Handles OMTenantCreate request.
Response for OMTenantCreate request.
Handles OMTenantDelete request.
Response for DeleteTenant request.
Handles OMTenantRevokeAdminRequest.
Response for OMTenantAssignAdminRequest.
Handles OMTenantRevokeUserAccessIdRequest request.
Response for OMTenantRevokeUserAccessIdRequest.
Upgrade Action for OzoneManager which takes in an 'OM' instance.
UpgradeFinalizer implementation for the Ozone Manager service.
Response for om volume acl operation request.
Base class for OMVolumeAcl Request.
Volume ACL operation.
Handles volume add acl request.
Handles volume create request.
Response for CreateVolume request.
Handles volume delete request.
Response for DeleteVolume request.
Handles volume remove acl request.
Defines common methods required for volume requests.
Handles volume set acl request.
Handle set owner request for volume.
Response for set owner request.
Handles set Quota request for volume.
Response for set quota request.
This is the background service to delete hanging open keys.
Ozone Acl Wrapper class.
Creates
IAccessAuthorizer instances based on configuration.Utility class for ozone configurations.
SecretManager for Ozone Master.
Builder to help construct OzoneDelegationTokenSecretManager.
Helper class for fetching List Status for a path.
Interface to get the File Status for a path.
OzoneLockProvider class returns the appropriate lock strategy pattern
implementation based on the configuration flags passed.
This is a common strategy interface for all concrete lock strategies.
Ozone Manager is the metadata manager of ozone.
OM Startup mode.
A subinterface of
IAccessAuthorizer specifically for Ozone Manager.This class implements DoubleBuffer implementation of OMClientResponse's.
Builder for creating OzoneManagerDoubleBuffer.
Class which maintains metrics related to OzoneManager DoubleBuffer.
Ozone Manager FileSystem interface.
HttpServer wrapper for the OzoneManager.
Controls the prepare state of the
OzoneManager containing the
instance.The current state of preparation is defined by the status and the
prepare index that are currently set.
This is the server-side translator that forwards requests received
from
OzoneManagerProtocolPB to OzoneManager.Creates a Ratis server endpoint for OM.
Defines RaftServer Status.
Class which defines OzoneManager Ratis Server config.
Utility class used by OzoneManager HA.
Command Handler for OM requests.
Grpc Service for handling S3 gateway OzoneManagerProtocol client requests.
This class provides a command line interface to start the OM
using Picocli.
The OM StateMachine is the state machine for OM Ratis server.
Ozone Manager utility class.
Native (internal) implementation of
IAccessAuthorizer.Implementation of OzonePrefixPath interface.
SecretStore for Ozone Master.
Support class to maintain state of OzoneSecretStore.
OzoneTrash which takes an OM as parameter .
Tracks metadata for keys pending deletion and their associated blocks.
Represents metadata for a key that has been purged.
Define an interface for persistent list.
Define an interface for persistent map.
Define an interface for persistent set.
Handles prefix commands.
Implementation of PrefixManager.
Result of the prefix acl operation.
Quota repair task.
Repair status for last run.
Quota repair for usages action to be triggered after upgrade.
Class to filter out deleted directories which are reclaimable based on their presence in previous snapshot in
the snapshot chain.
This class is responsible for opening last N snapshot given a snapshot metadata manager or AOS metadata manager by
acquiring a lock.
Filter to return deleted keys which are reclaimable based on their presence in previous snapshot in
the snapshot chain.
Class to filter out rename table entries which are reclaimable based on the key presence in previous snapshot's
keyTable/DirectoryTable in the snapshot chain.
Callback interface for ReferenceCounted.
Implementation of OzoneLockStrategy interface.
Interface for OM Requests to convert to audit objects.
An annotation to mark methods that do certain request validations.
Handler to handleRequest the OmRequests.
Main class to configure and set up and access the request/response
validation framework.
Annotation used to check that the snapshot feature in desired state.
'Aspect' for checking whether snapshot feature is enabled.
Bundles information about a bucket, which is possibly a symlink,
and the real bucket that it resolves to, if it is indeed a link.
Persistent list backed by RocksDB.
Persistent map backed by RocksDB.
Persistent set backed by RocksDB.
Handles delete object tagging request.
Handles delete object tagging request for FSO bucket.
Response for delete object tagging request.
Response for delete object tagging request for FSO bucket.
Handles requests to move both MPU open keys from the open key/file table and
MPU part keys to delete table.
Handles response to abort expired MPUs.
Handles GetS3Secret request.
Response for GetS3Secret request.
Handles initiate multipart upload request.
Handles initiate multipart upload request.
Response for S3 Initiate Multipart Upload request.
Response for S3 Initiate Multipart Upload request for prefix layout.
Handles Abort of multipart upload request.
Handles Abort of multipart upload request.
Response for Multipart Abort Request.
Response for Multipart Abort Request - prefix layout.
Handle Multipart upload commit upload part file.
Handle Multipart upload commit upload part file.
Response for S3MultipartUploadCommitPart request.
Response for S3MultipartUploadCommitPartWithFSO request.
Handle Multipart upload complete request.
Handle Multipart upload complete request.
Response for Multipart Upload Complete request.
Response for Multipart Upload Complete request.
Handles put object tagging request.
Handles put object tagging request for FSO bucket.
Response for put object tagging request.
Response for put object tagging request for FSO bucket.
Handles RevokeS3Secret request.
Response for RevokeS3Secret request.
Provider of
S3SecretCache.S3 Secret manager.
Common helper function for S3 secret requests.
Configuration keys for S3 secret store and cache.
S3 secret store provider.
Utility class which holds methods required for parse/validation of
S3 Authentication Information which is part of OMRequest.
Wrapper class for Scm protocol clients.
Provides REST access to Ozone Service List.
SharedTmp implementation of
IAccessAuthorizer.Thread-safe custom unbounded LRU cache to manage open snapshot DB instances.
State the reason the current thread is getting the OmSnapshot instance.
SnapshotChain supporting SnapshotInfo class.
This class is used for creating and accessing Snapshot Chains.
Background service for defragmenting snapshots in the active snapshot chain.
Background Service to clean-up deleted snapshot and reclaim space.
Background service to clean-up snapDiff jobs which are stable and
corresponding reports.
Class to generate snapshot diff.
Util class for snapshot diff APIs.
When snapshots are taken, an entire snapshot of the
OM RocksDB is captured and it will contain SST files corresponding
to all volumes/buckets and keys and also have data from
all the tables (columnFamilies) defined in the rocksdb
This is a background service which will cleanup and filter out
all the irrelevant and safe to delete sst files that don't correspond
to the bucket on which the snapshot was taken.
Interface for tenant operations.
Codec to serialize/deserialize
OzoneTokenIdentifier.FileSystem to be used by the Trash Emptier.
Annotation to specify upgrade action run during specific phases.
Defines conditions for which validators can be assigned to.
A context that contains useful information for request validator instances.
Registry that loads and stores the request validators to be applied by
a service.
Class to extract version out of OM request.
VolumeManager is responsible for read operations on a volume.
Volume Manager implementation.