Welcome to Cloud Cloud Store’s (CCS) documentation!

Version:

Date:

Feb 21, 2024

Contents:

• 1. Architecture
  • 1.1. Description
    • 1.1.1. Available functionalities
    • 1.1.2. Notes of versions
      • 1.1.2.1. 0.8.0 2024/02
      • 1.1.2.2. 0.7.0 2024/01
      • 1.1.2.3. 0.6.0 2023/11
      • 1.1.2.4. 0.5.0 2023/10
      • 1.1.2.5. 0.4.0 2023/09
      • 1.1.2.6. 0.3.0 2023/07
      • 1.1.2.7. 0.2.0 2023/01
      • 1.1.2.8. 0.1.0 2022/06
    • 1.1.3. Status logic
    • 1.1.4. Architecture
      • 1.1.4.1. Zoom when using Buffered Accessor
    • 1.1.5. Disaster Recovery or Cloud Migration
  • 1.2. Missing or In Progress Functionalities
  • 1.3. Common Configuration
    • 1.3.1. application.yaml configuration
    • 1.3.2. Metrics
• 2. Accessor
  • 2.1. BPMN for Accessor
    • 2.1.1. Short description of Dtos
    • 2.1.2. Status logic
    • 2.1.3. Bucket
    • 2.1.4. Object
    • 2.1.5. Object with special Buffered option
    • 2.1.6. Bucket Internal
    • 2.1.7. Object Internal
  • 2.2. Configuration
    • 2.2.1. Various Accessor services
      • 2.2.1.1. Accessor-Replicator
      • 2.2.1.2. Accessor-Simple-Gateway
      • 2.2.1.3. Accessor-Server
    • 2.2.2. Client with Apache httpclient5
    • 2.2.3. application.yaml configuration
      • 2.2.3.1. Client configurations
      • 2.2.3.2. Accessor Replicator configuration
      • 2.2.3.3. Accessor configuration
      • 2.2.3.4. Accessor Simple Gateway configuration
      • 2.2.3.5. Accessor common configuration
        • 2.2.3.5.1. Specific Driver configurations
      • 2.2.3.6. Accessor buffered configuration
  • 2.3. Open API
    • 2.3.1. Accessor Service
      • 2.3.1.1. Internal API / Bucket
      • 2.3.1.2. Internal API / Directory or Object
      • 2.3.1.3. Public API / Bucket
      • 2.3.1.4. Public API / Directory or Object
    • 2.3.2. Accessor Simple Gateway Service
      • 2.3.2.1. Public API / Bucket
      • 2.3.2.2. Public API / Directory or Object
• 3. Replicator
  • 3.1. BPMN for Replicator
  • 3.2. Configuration
    • 3.2.1. Various Replicator services
      • 3.2.1.1. Local Replicator
      • 3.2.1.2. Remote Replicator
    • 3.2.2. application.yaml configuration
  • 3.3. Open API
    • 3.3.1. Replicator API /local
    • 3.3.2. Replicator API /remote
• 4. Reconciliator
  • 4.1. BPMN for Reconciliator
  • 4.2. Reconciliator’s Algorithm
    • 4.2.1. Recurrent purge
    • 4.2.2. Reconciliation
      • 4.2.2.1. Clean step
      • 4.2.2.2. Snapshot step
      • 4.2.2.3. Local Reconciliation step
      • 4.2.2.4. Final Reconciliation step
    • 4.2.3. Special Reconciliation modes
      • 4.2.3.1. Initialization from existing Object Storage without CCS
      • 4.2.3.2. PRA reinitialization or new site initialization
  • 4.3. Configuration
    • 4.3.1. Various Reconciliation services
      • 4.3.1.1. Remote Listing
      • 4.3.1.2. Local Reconciliation
    • 4.3.2. application.yaml configuration
  • 4.4. Open API
    • 4.4.1. default
• 5. Administration
  • 5.1. BPMN for Administration
  • 5.2. Configuration
    • 5.2.1. Various Administration services
      • 5.2.1.1. Topology
      • 5.2.1.2. Ownership
    • 5.2.2. application.yaml configuration
  • 5.3. Open API
    • 5.3.1. Administration API / Ownership
    • 5.3.2. Administration API / Topology
• 6. Object Storage Driver
  • 6.1. Driver API
    • 6.1.1. Global logic of API
    • 6.1.2. 3 implementations
    • 6.1.3. Driver API details
      • 6.1.3.1. Bucket operations
      • 6.1.3.2. Object operations
  • 6.2. Specific Driver configurations
• 7. Commons
  • 7.1. Modules
  • 7.2. Common Standard
    • 7.2.1. GuidLike and relative Guid
    • 7.2.2. BaseXx
    • 7.2.3. Various X InputStream
      • 7.2.3.1. ZstdCompressInputStream and ZstdDecompressInputStream
    • 7.2.4. ParametersChecker
    • 7.2.5. Various Random
    • 7.2.6. Singleton
    • 7.2.7. SysErrLogger
    • 7.2.8. System Properties and Quarkus Configuration
  • 7.3. Common Quarkus
    • 7.3.1. Client and Server Abstract implementation for InputStream
      • 7.3.1.1. Client sending InputStream
      • 7.3.1.2. Client receiving InputStream
      • 7.3.1.3. Client definition of Service
      • 7.3.1.4. Server definition of Service
      • 7.3.1.5. Client implementation
      • 7.3.1.6. Client implementation using Quarkus Service
      • 7.3.1.7. Server implementation
    • 7.3.2. TrafficShaping
    • 7.3.3. JsonUtil
  • 7.4. Common DB
    • 7.4.1. DB Utils
      • 7.4.1.1. RestQuery, DbQuery and DbUpdate
      • 7.4.1.2. StreamHelperAbstract
      • 7.4.1.3. RepositoryBaseInterface
    • 7.4.2. MongoDb
      • 7.4.2.1. MongoBulkInsertHelper
    • 7.4.3. PostgreSQL
    • 7.4.4. Database Schema
      • 7.4.4.1. MongoDB
      • 7.4.4.2. PostgreSQL
  • 7.5. Common Configuration
    • 7.5.1. application.yaml configuration
    • 7.5.2. Metrics
• 8. Dev Detail
  • 8.1. POM Version management
  • 8.2. Full Build on local
    • 8.2.1. How to integrate Containers in Quarkus tests
      • 8.2.1.1. Properties
      • 8.2.1.2. Handling startup of containers
        • 8.2.1.2.1. Use QuarkusTestResourceLifecycleManager and QuarkusTestProfile
  • 8.3. Using fake Streams in tests