Fix javadocs

Signed-off-by: Daniel Widdis <[email protected]>

src/main/java/org/opensearch/flowframework/indices/FlowFrameworkIndicesHandler.java

@@ -512,7 +512,7 @@ public void updateTemplateInGlobalContext(
      * Check if the given template exists in the template index
      *
      * @param documentId document id
-     * @param tenantID tenant id
+     * @param tenantId tenant id
      * @param booleanResultConsumer a consumer based on whether the template exist
      * @param listener action listener
      * @param <T> action listener response type
@@ -667,6 +667,7 @@ public <T> void getProvisioningProgress(
      * Check workflow provisioning state and resources to see if state can be deleted with template
      *
      * @param workflowId workflow id
+     * @param tenantId tenant id
      * @param clearStatus if set true, always deletes the state document unless status is IN_PROGRESS
      * @param canDeleteStateConsumer consumer function which will be true if workflow state is not IN_PROGRESS and either no resources or true clearStatus
      * @param listener action listener from caller to fail on error

src/main/java/org/opensearch/flowframework/model/Template.java

@@ -281,7 +281,7 @@ public Builder lastProvisionedTime(Instant lastProvisionedTime) {
 
         /**
          * Builder method for adding user
-         * @param user user
+         * @param tenantId the tenant id
          * @return the Builder object
          */
         public Builder tenantId(String tenantId) {

src/main/java/org/opensearch/flowframework/transport/CreateWorkflowTransportAction.java

@@ -89,6 +89,7 @@ public class CreateWorkflowTransportAction extends HandledTransportAction<Workfl
      * @param flowFrameworkIndicesHandler The handler for the global context index
      * @param flowFrameworkSettings Plugin settings
      * @param client The client used to make the request to OS
+     * @param sdkClient the Multitenant Client
      * @param pluginsService The plugin service
      * @param clusterService the cluster service
      * @param xContentRegistry the named content registry

src/main/java/org/opensearch/flowframework/transport/DeleteWorkflowTransportAction.java

@@ -63,6 +63,7 @@ public class DeleteWorkflowTransportAction extends HandledTransportAction<Workfl
      * @param flowFrameworkIndicesHandler The Flow Framework indices handler
      * @param flowFrameworkSettings The Flow Framework settings
      * @param client the OpenSearch Client
+     * @param sdkClient the Multitenant Client
      * @param clusterService the cluster service
      * @param xContentRegistry contentRegister to parse get response
      * @param settings the plugin settings

src/main/java/org/opensearch/flowframework/transport/DeprovisionWorkflowTransportAction.java

@@ -88,6 +88,7 @@ public class DeprovisionWorkflowTransportAction extends HandledTransportAction<W
      * @param actionFilters action filters
      * @param threadPool The OpenSearch thread pool
      * @param client The node client to retrieve a stored use case template
+     * @param sdkClient the Multitenant Client
      * @param workflowStepFactory The factory instantiating workflow steps
      * @param flowFrameworkIndicesHandler Class to handle all internal system indices actions
      * @param flowFrameworkSettings The plugin settings

src/main/java/org/opensearch/flowframework/transport/GetWorkflowStateTransportAction.java

@@ -56,7 +56,9 @@ public class GetWorkflowStateTransportAction extends HandledTransportAction<GetW
      * Instantiates a new GetWorkflowStateTransportAction
      * @param transportService The TransportService
      * @param actionFilters action filters
+     * @param flowFrameworkIndicesHandler the handler class for index actions
      * @param client The client used to make the request to OS
+     * @param sdkClient the Multitenant Client
      * @param xContentRegistry contentRegister to parse get response
      * @param clusterService the cluster service
      * @param settings the plugin settings

src/main/java/org/opensearch/flowframework/transport/GetWorkflowTransportAction.java

@@ -63,6 +63,7 @@ public class GetWorkflowTransportAction extends HandledTransportAction<WorkflowR
      * @param flowFrameworkSettings The Flow Framework settings
      * @param encryptorUtils Encryptor utils
      * @param client the Opensearch Client
+     * @param sdkClient the Multitenant Client
      * @param xContentRegistry contentRegister to parse get response
      * @param clusterService the cluster service
      * @param settings the plugin settings

src/main/java/org/opensearch/flowframework/transport/ProvisionWorkflowTransportAction.java

@@ -82,8 +82,8 @@ public class ProvisionWorkflowTransportAction extends HandledTransportAction<Wor
      * Instantiates a new ProvisionWorkflowTransportAction
      * @param transportService The TransportService
      * @param actionFilters action filters
-     * @param threadPool The OpenSearch thread pool
      * @param client The node client to retrieve a stored use case template
+     * @param sdkClient the Multitenant Client
      * @param workflowProcessSorter Utility class to generate a togologically sorted list of Process nodes
      * @param flowFrameworkIndicesHandler Class to handle all internal system indices actions
      * @param flowFrameworkSettings The Flow Framework settings

src/main/java/org/opensearch/flowframework/transport/ReprovisionWorkflowTransportAction.java

@@ -90,6 +90,7 @@ public class ReprovisionWorkflowTransportAction extends HandledTransportAction<R
      * @param actionFilters action filters
      * @param threadPool The OpenSearch thread pool
      * @param client The node client to retrieve a stored use case template
+     * @param sdkClient the Multitenant Client
      * @param workflowStepFactory The factory instantiating workflow steps
      * @param workflowProcessSorter Utility class to generate a togologically sorted list of Process nodes
      * @param flowFrameworkIndicesHandler Class to handle all internal system indices actions

src/main/java/org/opensearch/flowframework/util/EncryptorUtils.java

@@ -89,6 +89,7 @@ public class EncryptorUtils {
      * Instantiates a new EncryptorUtils object
      * @param clusterService the cluster service
      * @param client the node client
+     * @param sdkClient the Multitenant Client
      * @param xContentRegistry the OpenSearch XContent Registry
      */
     public EncryptorUtils(ClusterService clusterService, Client client, SdkClient sdkClient, NamedXContentRegistry xContentRegistry) {

src/main/java/org/opensearch/flowframework/util/ParseUtils.java

@@ -394,7 +394,7 @@ public static void checkFilterByBackendRoles(User requestedUser) {
      * @param listener action listener
      * @param function workflow function
      * @param client node client
-     * @param sdkclient the tenant aware client
+     * @param sdkClient the tenant aware client
      * @param clusterService cluster service
      * @param xContentRegistry contentRegister to parse get response
      */

src/main/java/org/opensearch/flowframework/util/TenantAwareHelper.java

@@ -14,6 +14,9 @@
 
 import java.util.Objects;
 
+/**
+ * Helper class for tenant ID validation
+ */
 public class TenantAwareHelper {
 
     /**