tmf: extend api for configuration 5

Reviews round #1

Author: frallax

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/config/AbstractTmfDataProviderConfigurator.java

@@ -1,3 +1,13 @@
+/**********************************************************************
+ * Copyright (c) 2025 Ericsson
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
 package org.eclipse.tracecompass.tmf.core.config;
 
 import java.io.File;
@@ -14,6 +24,7 @@
 import org.eclipse.tracecompass.tmf.core.dataprovider.IDataProviderDescriptor;
 import org.eclipse.tracecompass.tmf.core.exceptions.TmfConfigurationException;
 import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
+import org.eclipse.tracecompass.tmf.core.signal.TmfSignalManager;
 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceClosedSignal;
 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceOpenedSignal;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
@@ -28,8 +39,18 @@
 /**
  * This class meant to be extended by data provider factories that want to be
  * able to handle configurations.
+ *
+ * @since 9.6
  */
 public abstract class AbstractTmfDataProviderConfigurator implements ITmfDataProviderConfigurator{
+
+    /**
+     * Constructor
+     */
+    protected AbstractTmfDataProviderConfigurator() {
+        TmfSignalManager.register(this);
+    }
+
     /**
      * The json file extension
      * @since 9.5
@@ -239,4 +260,11 @@ protected static void writeConfiguration(ITmfConfiguration configuration, IPath
     @SuppressWarnings("null")
     protected @NonNull abstract IPath getConfigurationRootFolder(@NonNull ITmfTrace trace);
 
+    /**
+     * Disposes the signal manager
+     */
+    protected void dispose() {
+        TmfSignalManager.dispose();
+    }
+
 }

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/config/TmfConfiguration.java

@@ -12,14 +12,17 @@
 
 import java.io.File;
 import java.io.FileReader;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.io.Reader;
+import java.io.Writer;
 import java.nio.charset.Charset;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
 import java.util.UUID;
 
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.internal.tmf.core.Activator;
 import org.eclipse.tracecompass.tmf.core.exceptions.TmfConfigurationException;
@@ -43,6 +46,15 @@ public class TmfConfiguration implements ITmfConfiguration {
      */
     public static final String UNKNOWN = "---unknown---"; //$NON-NLS-1$
 
+    /**
+     * The json file extension
+     *
+     * @since 9.5
+     * @deprecated use {@link AbstractTmfDataProviderConfigurator#JSON_EXTENSION} instead
+     */
+    @Deprecated
+    public static final String JSON_EXTENSION = "json"; //$NON-NLS-1$
+
     @Expose
     @SerializedName(value = "id")
     @Nullable
@@ -307,4 +319,35 @@ public static ITmfConfiguration fromJsonFile(File jsonFile) throws TmfConfigurat
         }
     }
 
+    /**
+     * Serialize {@link ITmfConfiguration} to JSON file with name configId.json
+     *
+     * @param configuration
+     *            the configuration to serialize
+     * @param rootPath
+     *            the root path to store the configuration
+     * @throws TmfConfigurationException
+     *             if an error occurs
+     * @since 9.5
+     * @deprecated use
+     *             {@link AbstractTmfDataProviderConfigurator#writeConfiguration(ITmfConfiguration, IPath)}
+     *             instead
+     */
+    @Deprecated
+    public static void writeConfiguration(ITmfConfiguration configuration, IPath rootPath) throws TmfConfigurationException {
+        IPath supplPath = rootPath;
+        File folder = supplPath.toFile();
+        if (!folder.exists()) {
+            folder.mkdir();
+        }
+        supplPath = supplPath.addTrailingSeparator().append(configuration.getId()).addFileExtension(JSON_EXTENSION);
+        File file = supplPath.toFile();
+        try (Writer writer = new FileWriter(file)) {
+            writer.append(new Gson().toJson(configuration));
+        } catch (IOException | JsonParseException e) {
+            Activator.logError(e.getMessage(), e);
+            throw new TmfConfigurationException("Error writing configuration.", e); //$NON-NLS-1$
+        }
+    }
+
 }