refactor(claimcheck): rename s3offload sample to claimcheck

Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com>

Author: Bueller87

README.md

@@ -32,7 +32,7 @@ These samples demonstrate various capabilities of Java Cadence client and server
 * **DataConverter Samples** — three independent custom `DataConverter` patterns that transparently transform every workflow input, output, and activity parameter. Each lives in its own package and is fully standalone, so you can copy any one of them into your own project:
     * **Compression** ([`com.uber.cadence.samples.compression`](src/main/java/com/uber/cadence/samples/compression/)) — gzip-over-JSON; typically 60-80% size reduction for repetitive payloads. [README](src/main/java/com/uber/cadence/samples/compression/README.md).
     * **Encryption** ([`com.uber.cadence.samples.encryption`](src/main/java/com/uber/cadence/samples/encryption/)) — AES-256-GCM so payloads in Cadence history are unreadable without the key. [README](src/main/java/com/uber/cadence/samples/encryption/README.md).
-    * **S3 / claim-check offload** ([`com.uber.cadence.samples.s3offload`](src/main/java/com/uber/cadence/samples/s3offload/)) — payloads above a threshold are stored in an external `BlobStore`; only a small reference travels through history. [README](src/main/java/com/uber/cadence/samples/s3offload/README.md).
+    * **Claim-check offload** ([`com.uber.cadence.samples.claimcheck`](src/main/java/com/uber/cadence/samples/claimcheck/)) — payloads above a threshold are stored in an external `BlobStore` (S3, GCS, Azure Blob, MinIO, local disk); only a small reference travels through history. [README](src/main/java/com/uber/cadence/samples/claimcheck/README.md).
 
 ## Get the Samples
 
@@ -162,12 +162,12 @@ See [src/main/java/com/uber/cadence/samples/encryption/README.md](src/main/java/
     ./gradlew -q execute -PmainClass=com.uber.cadence.samples.encryption.EncryptionWorker
     ./gradlew -q execute -PmainClass=com.uber.cadence.samples.encryption.EncryptionStarter
 
-#### S3 / claim-check offload
+#### Claim-check offload
 
-See [src/main/java/com/uber/cadence/samples/s3offload/README.md](src/main/java/com/uber/cadence/samples/s3offload/README.md) for the AWS SDK swap-in instructions.
+See [src/main/java/com/uber/cadence/samples/claimcheck/README.md](src/main/java/com/uber/cadence/samples/claimcheck/README.md) for swap-in instructions for S3, GCS, Azure Blob, and MinIO.
 
-    ./gradlew -q execute -PmainClass=com.uber.cadence.samples.s3offload.S3OffloadWorker
-    ./gradlew -q execute -PmainClass=com.uber.cadence.samples.s3offload.S3OffloadStarter
+    ./gradlew -q execute -PmainClass=com.uber.cadence.samples.claimcheck.ClaimCheckWorker
+    ./gradlew -q execute -PmainClass=com.uber.cadence.samples.claimcheck.ClaimCheckStarter
 
 ### Trip Booking
 

…cadence/samples/s3offload/BlobStore.java …adence/samples/claimcheck/BlobStore.javasrc/main/java/com/uber/cadence/samples/s3offload/BlobStore.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/BlobStore.java src/main/java/com/uber/cadence/samples/s3offload/BlobStore.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/BlobStore.java

@@ -15,14 +15,14 @@
  *  permissions and limitations under the License.
  */
 
-package com.uber.cadence.samples.s3offload;
+package com.uber.cadence.samples.claimcheck;
 
 import java.io.IOException;
 
 /**
- * Abstraction over any external object store (local filesystem, S3, GCS, etc.).
+ * Abstraction over any external object store (local filesystem, S3, GCS, Azure Blob, etc.).
  *
- * <p>{@link S3OffloadDataConverter} uses this interface to store large payloads outside Cadence
+ * <p>{@link ClaimCheckDataConverter} uses this interface to store large payloads outside Cadence
  * history. The default implementation is {@link LocalFsBlobStore}, which writes to the system
  * temporary directory and requires no external services.
  */

…es/s3offload/S3OffloadDataConverter.java …/claimcheck/ClaimCheckDataConverter.javasrc/main/java/com/uber/cadence/samples/s3offload/S3OffloadDataConverter.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckDataConverter.java src/main/java/com/uber/cadence/samples/s3offload/S3OffloadDataConverter.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckDataConverter.java

@@ -15,7 +15,7 @@
  *  permissions and limitations under the License.
  */
 
-package com.uber.cadence.samples.s3offload;
+package com.uber.cadence.samples.claimcheck;
 
 import com.uber.cadence.converter.DataConverter;
 import com.uber.cadence.converter.DataConverterException;
@@ -39,7 +39,7 @@
  * <ul>
  *   <li>{@code 0x00 || json} — payload is small enough to inline.
  *   <li>{@code 0x01 || jsonEnvelope} — payload was offloaded; the envelope JSON has the form {@code
- *       {"s3Ref":"<bucket>/<sha256hex>"}}.
+ *       {"blobRef":"<bucket>/<sha256hex>"}}.
  * </ul>
  *
  * <p>Keys are derived from the SHA-256 of the payload so {@code toData} is idempotent across
@@ -50,12 +50,19 @@
  */
 /*
  * =============================================================================
- * S3 BlobStore stub
+ * Swapping LocalFsBlobStore for a real object store
  *
- * To use a real AWS S3 bucket instead of the local filesystem:
- *  1. Add AWS SDK v2 to build.gradle:
- *       implementation group: 'software.amazon.awssdk', name: 's3', version: '2.25.0'
- *  2. Implement BlobStore against software.amazon.awssdk.services.s3.S3Client:
+ * The DataConverter is storage-agnostic: any class that implements `BlobStore` (two methods, `put`
+ * and `get`) will work. Swap `new LocalFsBlobStore()` in ClaimCheckWorker for your own impl and the
+ * workflow/activity code stays the same. Backend pointers:
+ *
+ *  - AWS S3:        software.amazon.awssdk:s3:2.25.0  (S3Client + PutObjectRequest/GetObjectRequest)
+ *  - GCS:           com.google.cloud:google-cloud-storage  (Storage.create(blobInfo, bytes))
+ *  - Azure Blob:    com.azure:azure-storage-blob  (BlobContainerClient.getBlobClient(...))
+ *  - MinIO / R2 /
+ *    LocalStack:    same as S3, just call S3Client.builder().endpointOverride(URI.create("..."))
+ *
+ * Reference S3 sketch using AWS SDK v2:
  *
  * public final class S3BlobStore implements BlobStore {
  *   private final S3Client s3;
@@ -78,18 +85,18 @@
  *   }
  * }
  *
- *  3. Replace `new LocalFsBlobStore()` with `new S3BlobStore("my-bucket", "us-east-1")` in
- *     S3OffloadWorker.
- *  4. Set standard AWS env vars (AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) or use an
- *     IAM instance role.
- *
- * You can also point the SDK at LocalStack or MinIO for local testing without a real AWS account.
+ * Wiring steps for any backend:
+ *  1. Add the backend's SDK as a runtime dependency in build.gradle.
+ *  2. Implement BlobStore against that SDK (≈30 lines, like the sketch above).
+ *  3. Replace `new LocalFsBlobStore()` with your `BlobStore` impl in ClaimCheckWorker.
+ *  4. Provide credentials via the SDK's standard mechanism (env vars, IAM role, etc.).
  *
  * Note on cleanup: this DataConverter does not delete blobs after the workflow completes. In
- * production, use S3 object lifecycle policies to automatically expire old blobs.
+ * production, use the object store's lifecycle policies (S3 object lifecycle, GCS object lifecycle
+ * management, Azure Blob lifecycle management, etc.) to automatically expire old blobs.
  * =============================================================================
  */
-public final class S3OffloadDataConverter implements DataConverter {
+public final class ClaimCheckDataConverter implements DataConverter {
 
   /** Prefix byte for inline (below-threshold) payloads. */
   static final byte INLINE_PREFIX = (byte) 0x00;
@@ -104,12 +111,12 @@ public final class S3OffloadDataConverter implements DataConverter {
   private final int thresholdBytes;
 
   static final class BlobReference {
-    public String s3Ref;
+    public String blobRef;
 
     public BlobReference() {}
 
-    BlobReference(String s3Ref) {
-      this.s3Ref = s3Ref;
+    BlobReference(String blobRef) {
+      this.blobRef = blobRef;
     }
   }
 
@@ -118,7 +125,7 @@ public BlobReference() {}
    * @param bucket logical bucket / prefix name embedded in the reference key.
    * @param thresholdBytes max inline payload size; larger payloads are offloaded.
    */
-  public S3OffloadDataConverter(BlobStore store, String bucket, int thresholdBytes) {
+  public ClaimCheckDataConverter(BlobStore store, String bucket, int thresholdBytes) {
     if (store == null) {
       throw new IllegalArgumentException("store must not be null");
     }
@@ -190,26 +197,26 @@ private byte[] unwrap(byte[] content) throws DataConverterException {
       case INLINE_PREFIX:
         return body;
       case OFFLOAD_PREFIX:
-        String key = extractS3Ref(body);
+        String key = extractBlobRef(body);
         try {
           return store.get(key);
         } catch (IOException e) {
           throw new DataConverterException(
-              "s3 offload: failed to fetch payload from blob store (key=" + key + ")", e);
+              "claimcheck: failed to fetch payload from blob store (key=" + key + ")", e);
         }
       default:
         throw new DataConverterException(
-            "s3 offload: unknown prefix byte 0x" + String.format("%02x", prefix & 0xff), null);
+            "claimcheck: unknown prefix byte 0x" + String.format("%02x", prefix & 0xff), null);
     }
   }
 
-  private static String extractS3Ref(byte[] envelopeJson) throws DataConverterException {
+  private static String extractBlobRef(byte[] envelopeJson) throws DataConverterException {
     BlobReference reference =
         delegate.fromData(envelopeJson, BlobReference.class, BlobReference.class);
-    if (reference == null || reference.s3Ref == null || reference.s3Ref.isEmpty()) {
-      throw new DataConverterException("s3 offload: envelope missing s3Ref field", null);
+    if (reference == null || reference.blobRef == null || reference.blobRef.isEmpty()) {
+      throw new DataConverterException("claimcheck: envelope missing blobRef field", null);
     }
-    return reference.s3Ref;
+    return reference.blobRef;
   }
 
   private static String sha256Hex(byte[] data) throws DataConverterException {

…load/S3OffloadDataConverterWorkflow.java …eck/ClaimCheckDataConverterWorkflow.javasrc/main/java/com/uber/cadence/samples/s3offload/S3OffloadDataConverterWorkflow.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckDataConverterWorkflow.java src/main/java/com/uber/cadence/samples/s3offload/S3OffloadDataConverterWorkflow.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckDataConverterWorkflow.java

@@ -15,7 +15,7 @@
  *  permissions and limitations under the License.
  */
 
-package com.uber.cadence.samples.s3offload;
+package com.uber.cadence.samples.claimcheck;
 
 import com.uber.cadence.activity.ActivityMethod;
 import com.uber.cadence.activity.ActivityOptions;
@@ -34,55 +34,55 @@
  * <p>The workflow takes no inputs and builds a payload well above the threshold internally so it
  * can be started from the Cadence CLI and every run exercises the offload path.
  */
-public final class S3OffloadDataConverterWorkflow {
+public final class ClaimCheckDataConverterWorkflow {
 
-  private S3OffloadDataConverterWorkflow() {}
+  private ClaimCheckDataConverterWorkflow() {}
 
-  /** Task list polled by {@link S3OffloadWorker}. */
-  public static final String TASK_LIST = "data-s3";
+  /** Task list polled by {@link ClaimCheckWorker}. */
+  public static final String TASK_LIST = "data-claimcheck";
 
   /**
    * Registered workflow type, used for both {@code @WorkflowMethod} and CLI {@code workflow start}.
    */
-  public static final String WORKFLOW_TYPE = "S3OffloadDataConverterWorkflow";
+  public static final String WORKFLOW_TYPE = "ClaimCheckDataConverterWorkflow";
 
-  /** Logical bucket / prefix embedded in S3-offload reference keys. */
-  public static final String S3_BUCKET = "data-s3";
+  /** Logical bucket / prefix embedded in claim-check reference keys. */
+  public static final String BLOB_BUCKET = "claimcheck-blobs";
 
   /**
-   * Payloads larger than this are offloaded to the BlobStore by {@link S3OffloadDataConverter}.
+   * Payloads larger than this are offloaded to the BlobStore by {@link ClaimCheckDataConverter}.
    * Cadence's default max payload is roughly 2 MB; the threshold is set intentionally low so the
    * demo workflow comfortably triggers offloading.
    */
   public static final int DEFAULT_THRESHOLD_BYTES = 4096;
 
   // ---------------- POJOs ----------------
 
-  public static final class S3LargePayload {
+  public static final class LargePayload {
     public String jobId;
     public String description;
-    public List<S3DataPoint> dataPoints;
+    public List<DataPoint> dataPoints;
     public Map<String, String> metadata;
     public String processedBy;
 
-    public S3LargePayload() {}
+    public LargePayload() {}
   }
 
-  public static final class S3DataPoint {
+  public static final class DataPoint {
     public String timestamp;
     public String metric;
     public double value;
     public String tags;
 
-    public S3DataPoint() {}
+    public DataPoint() {}
   }
 
   /**
    * Builds a payload comfortably larger than {@link #DEFAULT_THRESHOLD_BYTES} so every workflow run
    * triggers an offload.
    */
-  public static S3LargePayload createS3LargePayload() {
-    S3LargePayload p = new S3LargePayload();
+  public static LargePayload createLargePayload() {
+    LargePayload p = new LargePayload();
     p.jobId = "batch-job-20240115-001";
     p.description =
         repeat(
@@ -91,7 +91,7 @@ public static S3LargePayload createS3LargePayload() {
 
     p.dataPoints = new ArrayList<>(200);
     for (int i = 0; i < 200; i++) {
-      S3DataPoint dp = new S3DataPoint();
+      DataPoint dp = new DataPoint();
       dp.timestamp = String.format("2024-01-15T%02d:30:00Z", i % 24);
       dp.metric = String.format("telemetry.sensor_%03d.temperature", i);
       dp.value = 20.0 + (i % 30) / 10.0;
@@ -103,7 +103,7 @@ public static S3LargePayload createS3LargePayload() {
     for (int i = 0; i < 20; i++) {
       p.metadata.put(String.format("batch_key_%02d", i), repeat("value-data-", 5));
     }
-    p.processedBy = "s3-offload-worker-v1";
+    p.processedBy = "claimcheck-worker-v1";
     return p;
   }
 
@@ -124,13 +124,13 @@ public interface WorkflowIface {
       executionStartToCloseTimeoutSeconds = 60,
       taskList = TASK_LIST
     )
-    S3LargePayload run();
+    LargePayload run();
   }
 
   public interface Activities {
 
     @ActivityMethod(scheduleToCloseTimeoutSeconds = 60)
-    S3LargePayload processS3Payload(S3LargePayload payload);
+    LargePayload processPayload(LargePayload payload);
   }
 
   public static final class WorkflowImpl implements WorkflowIface {
@@ -144,20 +144,20 @@ public static final class WorkflowImpl implements WorkflowIface {
                 .build());
 
     @Override
-    public S3LargePayload run() {
-      S3LargePayload payload = createS3LargePayload();
+    public LargePayload run() {
+      LargePayload payload = createLargePayload();
 
-      Workflow.getLogger(S3OffloadDataConverterWorkflow.class)
+      Workflow.getLogger(ClaimCheckDataConverterWorkflow.class)
           .info(
-              "S3 offload workflow started: job_id={}, data_points={}. Payload will be offloaded; only a reference travels through Cadence history.",
+              "Claim-check workflow started: job_id={}, data_points={}. Payload will be offloaded; only a reference travels through Cadence history.",
               payload.jobId,
               payload.dataPoints.size());
 
-      S3LargePayload result = activities.processS3Payload(payload);
+      LargePayload result = activities.processPayload(payload);
 
-      Workflow.getLogger(S3OffloadDataConverterWorkflow.class)
+      Workflow.getLogger(ClaimCheckDataConverterWorkflow.class)
           .info(
-              "S3 offload workflow completed: job_id={}. Payload was transparently offloaded and retrieved via the BlobStore.",
+              "Claim-check workflow completed: job_id={}. Payload was transparently offloaded and retrieved via the BlobStore.",
               result.jobId);
       return result;
     }
@@ -166,7 +166,7 @@ public S3LargePayload run() {
   public static final class ActivitiesImpl implements Activities {
 
     @Override
-    public S3LargePayload processS3Payload(S3LargePayload payload) {
+    public LargePayload processPayload(LargePayload payload) {
       payload.processedBy = payload.processedBy + " (Processed)";
       return payload;
     }

…/samples/s3offload/S3OffloadStarter.java …amples/claimcheck/ClaimCheckStarter.javasrc/main/java/com/uber/cadence/samples/s3offload/S3OffloadStarter.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckStarter.java src/main/java/com/uber/cadence/samples/s3offload/S3OffloadStarter.java renamed to src/main/java/com/uber/cadence/samples/claimcheck/ClaimCheckStarter.java

@@ -15,7 +15,7 @@
  *  permissions and limitations under the License.
  */
 
-package com.uber.cadence.samples.s3offload;
+package com.uber.cadence.samples.claimcheck;
 
 import com.uber.cadence.client.WorkflowClient;
 import com.uber.cadence.client.WorkflowClientOptions;
@@ -27,23 +27,23 @@
 import java.util.UUID;
 
 /**
- * Starts {@link S3OffloadDataConverterWorkflow} (async, fire-and-forget).
+ * Starts {@link ClaimCheckDataConverterWorkflow} (async, fire-and-forget).
  *
  * <p>The workflow takes no inputs and generates its own payload, so this starter does not need to
- * use the matching {@link S3OffloadDataConverter}. The same effect can be achieved from the Cadence
- * CLI via:
+ * use the matching {@link ClaimCheckDataConverter}. The same effect can be achieved from the
+ * Cadence CLI via:
  *
  * <pre>
  * cadence --domain samples-domain \
  *   workflow start \
- *   --workflow_type S3OffloadDataConverterWorkflow \
- *   --tl data-s3 \
+ *   --workflow_type ClaimCheckDataConverterWorkflow \
+ *   --tl data-claimcheck \
  *   --et 60
  * </pre>
  */
-public final class S3OffloadStarter {
+public final class ClaimCheckStarter {
 
-  private S3OffloadStarter() {}
+  private ClaimCheckStarter() {}
 
   public static void main(String[] args) {
     try {
@@ -53,20 +53,20 @@ public static void main(String[] args) {
               WorkflowClientOptions.newBuilder().setDomain(SampleConstants.DOMAIN).build());
       WorkflowOptions options =
           new WorkflowOptions.Builder()
-              .setTaskList(S3OffloadDataConverterWorkflow.TASK_LIST)
+              .setTaskList(ClaimCheckDataConverterWorkflow.TASK_LIST)
               .setExecutionStartToCloseTimeout(Duration.ofMinutes(1))
-              .setWorkflowId("s3-offload-" + UUID.randomUUID())
+              .setWorkflowId("claimcheck-" + UUID.randomUUID())
               .build();
 
-      S3OffloadDataConverterWorkflow.WorkflowIface workflow =
-          client.newWorkflowStub(S3OffloadDataConverterWorkflow.WorkflowIface.class, options);
+      ClaimCheckDataConverterWorkflow.WorkflowIface workflow =
+          client.newWorkflowStub(ClaimCheckDataConverterWorkflow.WorkflowIface.class, options);
 
       WorkflowClient.start(workflow::run);
       System.out.println(
           "Started "
-              + S3OffloadDataConverterWorkflow.WORKFLOW_TYPE
+              + ClaimCheckDataConverterWorkflow.WORKFLOW_TYPE
               + " on task list \""
-              + S3OffloadDataConverterWorkflow.TASK_LIST
+              + ClaimCheckDataConverterWorkflow.TASK_LIST
               + "\".");
       System.exit(0);
     } catch (RuntimeException e) {