Add support for renaming/refactoring metadata and hop files, fixes #6777 (#6778)

Author: hansva

core/src/main/java/org/apache/hop/core/database/DatabaseMeta.java

@@ -63,7 +63,8 @@
     description = "i18n::DatabaseMeta.description",
     image = "ui/images/database.svg",
     documentationUrl = "/metadata-types/rdbms-connection.html",
-    hopMetadataPropertyType = HopMetadataPropertyType.RDBMS_CONNECTION)
+    hopMetadataPropertyType = HopMetadataPropertyType.RDBMS_CONNECTION,
+    supportsGlobalReplace = true)
 public class DatabaseMeta extends HopMetadataBase implements Cloneable, IHopMetadata {
   private static final Class<?> PKG = Database.class;
 

core/src/main/java/org/apache/hop/core/variables/resolver/VariableResolver.java

@@ -23,16 +23,14 @@
 import org.apache.hop.metadata.api.HopMetadata;
 import org.apache.hop.metadata.api.HopMetadataBase;
 import org.apache.hop.metadata.api.HopMetadataProperty;
-import org.apache.hop.metadata.api.HopMetadataPropertyType;
 import org.apache.hop.metadata.api.IHopMetadata;
 
 @HopMetadata(
     key = "variable-resolver",
     name = "i18n::VariableResolver.name",
     description = "i18n::VariableResolver.Description",
     image = "ui/images/variable.svg",
-    documentationUrl = "/metadata-types/variable-resolver/",
-    hopMetadataPropertyType = HopMetadataPropertyType.RDBMS_CONNECTION)
+    documentationUrl = "/metadata-types/variable-resolver/")
 @Getter
 @Setter
 public class VariableResolver extends HopMetadataBase implements IHopMetadata {

core/src/main/java/org/apache/hop/metadata/api/HopMetadata.java

@@ -51,4 +51,12 @@
    * @return the type of metadata this property represents.
    */
   HopMetadataPropertyType hopMetadataPropertyType() default HopMetadataPropertyType.NONE;
+
+  /**
+   * Set this to identify if this metadata object supports replacing values in Workflows and
+   * Pipelines
+   *
+   * @return true if global replace is supported
+   */
+  boolean supportsGlobalReplace() default false;
 }

core/src/main/java/org/apache/hop/metadata/api/MetadataRefactorUtil.java

@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file 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 org.apache.hop.metadata.api;
+
+import org.apache.hop.core.exception.HopException;
+
+/**
+ * Utility to link metadata elements to their {@link HopMetadataPropertyType} for refactoring (e.g.
+ * rename) so references in pipelines and workflows can be found and updated.
+ */
+public final class MetadataRefactorUtil {
+
+  private MetadataRefactorUtil() {}
+
+  /**
+   * Returns the property type for a metadata type key, if the metadata class declares it via {@link
+   * HopMetadata#hopMetadataPropertyType()}. This links the metadata element to the kind of
+   * reference used in pipeline/workflow XML (e.g. RDBMS_CONNECTION for "rdbms").
+   *
+   * @param provider metadata provider (used to resolve the class for the key)
+   * @param metadataKey the metadata type key (e.g. "rdbms", "restconnection")
+   * @return the property type, or {@link HopMetadataPropertyType#NONE} if not declared or unknown
+   */
+  public static HopMetadataPropertyType getPropertyTypeForMetadataKey(
+      IHopMetadataProvider provider, String metadataKey) {
+    try {
+      Class<? extends IHopMetadata> clazz = provider.getMetadataClassForKey(metadataKey);
+      HopMetadata annotation = clazz.getAnnotation(HopMetadata.class);
+      if (annotation == null) {
+        return HopMetadataPropertyType.NONE;
+      }
+      HopMetadataPropertyType type = annotation.hopMetadataPropertyType();
+      return type == null ? HopMetadataPropertyType.NONE : type;
+    } catch (HopException e) {
+      return HopMetadataPropertyType.NONE;
+    }
+  }
+
+  /**
+   * Returns whether the metadata type supports global replace (finding and updating references in
+   * pipelines and workflows when renaming). Uses {@link HopMetadata#supportsGlobalReplace()}.
+   *
+   * @param provider metadata provider (used to resolve the class for the key)
+   * @param metadataKey the metadata type key (e.g. "rdbms", "restconnection")
+   * @return true if global replace is supported, false otherwise
+   */
+  public static boolean supportsGlobalReplace(IHopMetadataProvider provider, String metadataKey) {
+    try {
+      Class<? extends IHopMetadata> clazz = provider.getMetadataClassForKey(metadataKey);
+      HopMetadata annotation = clazz.getAnnotation(HopMetadata.class);
+      return annotation != null && annotation.supportsGlobalReplace();
+    } catch (HopException e) {
+      return false;
+    }
+  }
+}

engine/src/main/java/org/apache/hop/execution/ExecutionInfoLocation.java

@@ -31,7 +31,8 @@
     description = "i18n::ExecutionInfoLocation.description",
     image = "ui/images/location.svg",
     documentationUrl = "/metadata-types/execution-information-location.html",
-    hopMetadataPropertyType = HopMetadataPropertyType.EXEC_INFO_LOCATION)
+    hopMetadataPropertyType = HopMetadataPropertyType.EXEC_INFO_LOCATION,
+    supportsGlobalReplace = true)
 public class ExecutionInfoLocation extends HopMetadataBase implements IHopMetadata, Cloneable {
   public static final String GUI_PLUGIN_ELEMENT_PARENT_ID =
       "ExecutionInfoLocation-PluginSpecific-Options";

engine/src/main/java/org/apache/hop/execution/profiling/ExecutionDataProfile.java

@@ -37,7 +37,8 @@
     description = "i18n::ExecutionDataProfile.description",
     image = "ui/images/analyzer.svg",
     documentationUrl = "/metadata-types/execution-data-profile.html",
-    hopMetadataPropertyType = HopMetadataPropertyType.EXEC_INFO_DATA_PROFILE)
+    hopMetadataPropertyType = HopMetadataPropertyType.EXEC_INFO_DATA_PROFILE,
+    supportsGlobalReplace = true)
 public class ExecutionDataProfile extends HopMetadataBase implements IHopMetadata, Cloneable {
 
   public static final String GUI_PLUGIN_ELEMENT_PARENT_ID = "ExecutionDataSamplerParent";

engine/src/main/java/org/apache/hop/execution/remote/RemoteExecutionInfoLocation.java

@@ -44,6 +44,7 @@
 import org.apache.hop.execution.IExecutionSelector;
 import org.apache.hop.execution.plugin.ExecutionInfoLocationPlugin;
 import org.apache.hop.metadata.api.HopMetadataProperty;
+import org.apache.hop.metadata.api.HopMetadataPropertyType;
 import org.apache.hop.metadata.api.IHopMetadataProvider;
 import org.apache.hop.server.HopServerMeta;
 import org.apache.hop.www.GetExecutionInfoServlet;
@@ -71,7 +72,9 @@ public class RemoteExecutionInfoLocation implements IExecutionInfoLocation {
       metadata = HopServerMeta.class,
       toolTip = "i18n::RemoteExecutionInfoLocation.HopServer.Tooltip",
       label = "i18n::RemoteExecutionInfoLocation.HopServer.Label")
-  @HopMetadataProperty(key = "server")
+  @HopMetadataProperty(
+      key = "server",
+      hopMetadataPropertyType = HopMetadataPropertyType.SERVER_DEFINITION)
   protected String serverName;
 
   @GuiWidgetElement(

engine/src/main/java/org/apache/hop/metadata/refactor/MetadataObjectReference.java

@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file 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 org.apache.hop.metadata.refactor;
+
+import java.util.Objects;
+
+/**
+ * Describes a reference to a metadata element from another metadata object (e.g. a
+ * PipelineRunConfiguration referencing an ExecutionInfoLocation by name).
+ */
+public class MetadataObjectReference {
+
+  private final String containerMetadataKey;
+  private final String containerObjectName;
+
+  public MetadataObjectReference(String containerMetadataKey, String containerObjectName) {
+    this.containerMetadataKey = containerMetadataKey;
+    this.containerObjectName = containerObjectName;
+  }
+
+  public String getContainerMetadataKey() {
+    return containerMetadataKey;
+  }
+
+  public String getContainerObjectName() {
+    return containerObjectName;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    MetadataObjectReference that = (MetadataObjectReference) o;
+    return Objects.equals(containerMetadataKey, that.containerMetadataKey)
+        && Objects.equals(containerObjectName, that.containerObjectName);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(containerMetadataKey, containerObjectName);
+  }
+}