New Update-with-Start API

temporal-sdk/src/main/java/io/temporal/client/WithStartWorkflowOperation.java

@@ -0,0 +1,335 @@
+/*
+ * Copyright (C) 2024 Temporal Technologies, Inc. All Rights Reserved.
+ *
+ * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Modifications copyright (C) 2017 Uber Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this material except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.temporal.client;
+
+import io.temporal.common.Experimental;
+import io.temporal.workflow.Functions;
+import java.util.concurrent.atomic.AtomicBoolean;
+import javax.annotation.Nullable;
+
+/** TODO UwS */
+@Experimental
+public final class WithStartWorkflowOperation<R> {
+
+  private final AtomicBoolean invoked = new AtomicBoolean(false);
+  private WorkflowStub stub;
+  private Object[] args;
+  @Nullable private Functions.Proc startMethod;
+  private Class<? extends R> resultClass;
+
+  private WithStartWorkflowOperation() {}
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a zero argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   */
+  public WithStartWorkflowOperation(Functions.Func<R> startMethod) {
+    this.startMethod =
+        () -> {
+          startMethod.apply();
+        };
+    this.args = new Object[] {};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a one argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   */
+  public <A1> WithStartWorkflowOperation(Functions.Func1<A1, R> startMethod, A1 arg1) {
+    this.startMethod = () -> startMethod.apply(arg1);
+    this.args = new Object[] {arg1};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a two argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   */
+  public <A1, A2> WithStartWorkflowOperation(
+      Functions.Func2<A1, A2, R> startMethod, A1 arg1, A2 arg2) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2);
+    this.args = new Object[] {arg1, arg2};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a three argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   */
+  public <A1, A2, A3> WithStartWorkflowOperation(
+      Functions.Func3<A1, A2, A3, R> startMethod, A1 arg1, A2 arg2, A3 arg3) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3);
+    this.args = new Object[] {arg1, arg2, arg3};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a four argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   */
+  public <A1, A2, A3, A4> WithStartWorkflowOperation(
+      Functions.Func4<A1, A2, A3, A4, R> startMethod, A1 arg1, A2 arg2, A3 arg3, A4 arg4) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4);
+    this.args = new Object[] {arg1, arg2, arg3, arg4};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a five argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   * @param arg5 fifth request function parameter
+   */
+  public <A1, A2, A3, A4, A5> WithStartWorkflowOperation(
+      Functions.Func5<A1, A2, A3, A4, A5, R> startMethod,
+      A1 arg1,
+      A2 arg2,
+      A3 arg3,
+      A4 arg4,
+      A5 arg5) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4, arg5);
+    this.args = new Object[] {arg1, arg2, arg3, arg4, arg5};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a six argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   * @param arg5 fifth request function parameter
+   * @param arg6 sixth request function parameter
+   */
+  public <A1, A2, A3, A4, A5, A6> WithStartWorkflowOperation(
+      Functions.Func6<A1, A2, A3, A4, A5, A6, R> startMethod,
+      A1 arg1,
+      A2 arg2,
+      A3 arg3,
+      A4 arg4,
+      A5 arg5,
+      A6 arg6) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4, arg5, arg6);
+    this.args = new Object[] {arg1, arg2, arg3, arg4, arg5, arg6};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a zero argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   */
+  public WithStartWorkflowOperation(Functions.Proc startMethod) {
+    this.startMethod =
+        () -> {
+          startMethod.apply();
+        };
+    this.args = new Object[] {};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a one argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   */
+  public <A1> WithStartWorkflowOperation(Functions.Proc1<A1> startMethod, A1 arg1) {
+    this.startMethod = () -> startMethod.apply(arg1);
+    this.args = new Object[] {arg1};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a two argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   */
+  public <A1, A2> WithStartWorkflowOperation(
+      Functions.Proc2<A1, A2> startMethod, A1 arg1, A2 arg2) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2);
+    this.args = new Object[] {arg1, arg2};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a three argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   */
+  public <A1, A2, A3> WithStartWorkflowOperation(
+      Functions.Proc3<A1, A2, A3> startMethod, A1 arg1, A2 arg2, A3 arg3) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3);
+    this.args = new Object[] {arg1, arg2, arg3};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a four argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   */
+  public <A1, A2, A3, A4> WithStartWorkflowOperation(
+      Functions.Proc4<A1, A2, A3, A4> startMethod, A1 arg1, A2 arg2, A3 arg3, A4 arg4) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4);
+    this.args = new Object[] {arg1, arg2, arg3, arg4};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a five argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   * @param arg5 fifth request function parameter
+   */
+  public <A1, A2, A3, A4, A5> WithStartWorkflowOperation(
+      Functions.Proc5<A1, A2, A3, A4, A5> startMethod,
+      A1 arg1,
+      A2 arg2,
+      A3 arg3,
+      A4 arg4,
+      A5 arg5) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4, arg5);
+    this.args = new Object[] {arg1, arg2, arg3, arg4, arg5};
+  }
+
+  /**
+   * Returns a new {@link WithStartWorkflowOperation} for a six argument request.
+   *
+   * @param startMethod method reference annotated with @WorkflowMethod of a proxy created through
+   *     {@link WorkflowClient#newWorkflowStub(Class, WorkflowOptions)}.
+   * @param arg1 first request function parameter
+   * @param arg2 second request function parameter
+   * @param arg3 third request function parameter
+   * @param arg4 fourth request function parameter
+   * @param arg5 fifth request function parameter
+   * @param arg6 sixth request function parameter
+   */
+  public <A1, A2, A3, A4, A5, A6> WithStartWorkflowOperation(
+      Functions.Proc6<A1, A2, A3, A4, A5, A6> startMethod,
+      A1 arg1,
+      A2 arg2,
+      A3 arg3,
+      A4 arg4,
+      A5 arg5,
+      A6 arg6) {
+    this.startMethod = () -> startMethod.apply(arg1, arg2, arg3, arg4, arg5, arg6);
+    this.args = new Object[] {arg1, arg2, arg3, arg4, arg5, arg6};
+  }
+
+  public WithStartWorkflowOperation(
+      WorkflowStub stub, Class<? extends R> resultClass, Object... args) {
+    this.stub = stub;
+    this.resultClass = resultClass;
+    this.args = args;
+  }
+
+  /** Returns the result of the update request. */
+  public R getResult() {
+    return this.stub.getResult(this.resultClass);
+  }
+
+  @Nullable
+  Functions.Proc getStartMethod() {
+    return startMethod;
+  }
+
+  void setResultClass(Class resultClass) {
+    this.resultClass = resultClass;
+  }
+
+  WorkflowStub getStub() {
+    return stub;
+  }
+
+  Object[] getArgs() {
+    return this.args;
+  }
+
+  void setArgs(Object[] args) {
+    this.args = args;
+  }
+
+  // equals/hashCode intentionally left as default
+
+  // TODO
+  //  @Override
+  //  public String toString() {
+  //    StringBuilder sb = new StringBuilder();
+  //    sb.append("WithStartWorkflowOperation{options=").append(options);
+  //    if (updateRequest != null) {
+  //      sb.append(", updateRequest=").append(updateRequest);
+  //    }
+  //    if (updateArgs != null) {
+  //      sb.append(", updateArgs=").append(Arrays.toString(updateArgs));
+  //    }
+  //    return sb.toString();
+  //  }
+
+  void setStub(WorkflowStub stub) {
+    this.stub = stub;
+  }
+
+  /**
+   * Mark the operation as having been invoked.
+   *
+   * @return false if the operation was already invoked
+   */
+  boolean markInvoked() {
+    return invoked.compareAndSet(false, true);
+  }
+}