Merge pull request #21013 from vespa-engine/deprecate-config.subscription

Deprecate config.subscription

17 files changed, 43 insertions, 2 deletions

diff --git a/config/pom.xml b/config/pom.xml
index 4eceef8c748..546e65c048c 100755
--- a/config/pom.xml
+++ b/config/pom.xml
@@ -186,6 +186,14 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
+        <!-- TODO Vespa 8: remove configuration.
+             Included to allow 'removal' warnings for classes in its own module -->
+        <configuration>
+          <compilerArgs>
+            <arg>-Xlint:all,-serial,-try,-processing,-removal</arg>
+            <arg>-Werror</arg>
+          </compilerArgs>
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
diff --git a/config/src/main/java/com/yahoo/config/subscription/CfgConfigPayloadBuilder.java b/config/src/main/java/com/yahoo/config/subscription/CfgConfigPayloadBuilder.java
index 1a110fe8e6c..7d3fdad43c7 100644
--- a/config/src/main/java/com/yahoo/config/subscription/CfgConfigPayloadBuilder.java
+++ b/config/src/main/java/com/yahoo/config/subscription/CfgConfigPayloadBuilder.java
@@ -17,7 +17,9 @@ import static java.util.logging.Level.FINEST;
  * Deserializes config payload (cfg format) to a ConfigPayload.
  *
  * @author hmusum
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class CfgConfigPayloadBuilder {
     private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(CfgConfigPayloadBuilder.class.getName());
 
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigDebug.java b/config/src/main/java/com/yahoo/config/subscription/ConfigDebug.java
index 85aa7a05e17..2fcbdce7030 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigDebug.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigDebug.java
@@ -9,6 +9,7 @@ import java.util.logging.Logger;
 import static java.util.logging.Level.INFO;
 
 // Debug class that provides useful helper routines
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigDebug {
     public static void logDebug(Logger logger, long timestamp, ConfigKey<?> key, String logmessage) {
         if (key.getConfigId().matches(".*container.?\\d+.*") || key.getConfigId().matches(".*doc.api.*")) {
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigGetter.java b/config/src/main/java/com/yahoo/config/subscription/ConfigGetter.java
index f349c8fe47d..305ecbd6483 100755
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigGetter.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigGetter.java
@@ -34,7 +34,10 @@ public class ConfigGetter<T extends ConfigInstance> {
      *
      * @param source a {@link ConfigSource}
      * @param clazz  a config class
+     *
+     * @deprecated Config should always be injected via the component class constructor. For unit tests, use config builders.
      */
+    @Deprecated(forRemoval = true, since = "7")
     public ConfigGetter(ConfigSource source, Class<T> clazz) {
         this.clazz = clazz;
         this.source = source;
@@ -74,7 +77,10 @@ public class ConfigGetter<T extends ConfigInstance> {
      * @param configId a config id to use when getting the config
      * @param source   a {@link ConfigSource}
      * @return an instance of a config class
+     *
+     * @deprecated Config should always be injected via the component class constructor. For unit tests, use config builders.
      */
+    @Deprecated(forRemoval = true, since = "7")
     public static <T extends ConfigInstance> T getConfig(Class<T> c, String configId, ConfigSource source) {
         ConfigGetter<T> getter = new ConfigGetter<>(source, c);
         return getter.getConfig(configId);
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigHandle.java b/config/src/main/java/com/yahoo/config/subscription/ConfigHandle.java
index c0eff773bac..6b832205211 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigHandle.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigHandle.java
@@ -10,7 +10,9 @@ import com.yahoo.config.subscription.impl.ConfigSubscription;
  *
  * @param <T> the type of the config
  * @author vegardh
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigHandle<T extends ConfigInstance> {
 
     private final ConfigSubscription<T> sub;
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceSerializer.java b/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceSerializer.java
index e035991abf4..d8062a9f95b 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceSerializer.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceSerializer.java
@@ -9,7 +9,9 @@ import com.yahoo.slime.Slime;
  * Implements a config instance serializer, serializing a config instance to a slime object.
  *
  * @author Ulf Lilleengen
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigInstanceSerializer implements Serializer {
     private final Slime slime;
     private final Cursor root;
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceUtil.java b/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceUtil.java
index f1b7952f3b1..5831753eacb 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceUtil.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigInstanceUtil.java
@@ -14,7 +14,9 @@ import com.yahoo.vespa.config.*;
 
 /**
  * @author gjoranv
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigInstanceUtil {
 
     /**
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigInterruptedException.java b/config/src/main/java/com/yahoo/config/subscription/ConfigInterruptedException.java
index a7c2c2d9127..050b7a81fa2 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigInterruptedException.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigInterruptedException.java
@@ -4,8 +4,10 @@ package com.yahoo.config.subscription;
 /**
  * This exception is thrown when any blocking call within the Config API is interrupted.
  * @author Ulf Lilleengen
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
 @SuppressWarnings("serial")
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigInterruptedException extends RuntimeException {
     public ConfigInterruptedException(Throwable cause) {
         super(cause);
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigSet.java b/config/src/main/java/com/yahoo/config/subscription/ConfigSet.java
index 02cc87f65d7..36d9047aa87 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigSet.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigSet.java
@@ -11,7 +11,9 @@ import com.yahoo.vespa.config.ConfigKey;
  * Config source as a programmatically built set of {@link com.yahoo.config.ConfigInstance}s
  *
  * @author Vegard Havdal
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigSet implements ConfigSource {
     private final Map<ConfigKey<?>, ConfigInstance.Builder> configs = new ConcurrentHashMap<>();
 
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigSource.java b/config/src/main/java/com/yahoo/config/subscription/ConfigSource.java
index 5814a004216..b8abeb48c3d 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigSource.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigSource.java
@@ -5,7 +5,9 @@ package com.yahoo.config.subscription;
  * A type of source of config
  *
  * @author Vegard Havdal
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public interface ConfigSource {
 
 }
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigSourceSet.java b/config/src/main/java/com/yahoo/config/subscription/ConfigSourceSet.java
index 81aeda52b54..37f91605a54 100755
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigSourceSet.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigSourceSet.java
@@ -18,7 +18,9 @@ import static java.util.logging.Level.INFO;
  * upper/lower-casing and whitespaces.
  *
  * @author gjoranv
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigSourceSet implements ConfigSource {
 
     private static final Logger log = Logger.getLogger(ConfigSourceSet.class.getName());
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigSubscriber.java b/config/src/main/java/com/yahoo/config/subscription/ConfigSubscriber.java
index 4bf442a0890..de5eeb5649c 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigSubscriber.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigSubscriber.java
@@ -28,7 +28,9 @@ import static java.util.stream.Collectors.toList;
  * {@link ConfigHandle} which {@link #subscribe(Class, String)} returned.
  *
  * @author Vegard Havdal
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigSubscriber implements AutoCloseable {
 
     private static final Logger log = Logger.getLogger(ConfigSubscriber.class.getName());
diff --git a/config/src/main/java/com/yahoo/config/subscription/ConfigURI.java b/config/src/main/java/com/yahoo/config/subscription/ConfigURI.java
index 6053ba5303a..46db3c6c83a 100644
--- a/config/src/main/java/com/yahoo/config/subscription/ConfigURI.java
+++ b/config/src/main/java/com/yahoo/config/subscription/ConfigURI.java
@@ -10,7 +10,9 @@ import com.yahoo.config.subscription.impl.JRTConfigRequester;
  * object to simplify parameter passing.
  *
  * @author Ulf Lilleengen
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class ConfigURI {
 
     private String configId;
diff --git a/config/src/main/java/com/yahoo/config/subscription/DirSource.java b/config/src/main/java/com/yahoo/config/subscription/DirSource.java
index 240d1b8e81d..48d52bd49f3 100644
--- a/config/src/main/java/com/yahoo/config/subscription/DirSource.java
+++ b/config/src/main/java/com/yahoo/config/subscription/DirSource.java
@@ -6,8 +6,9 @@ import java.io.File;
 /**
  * Source specifying config from a local directory
  * @author Vegard Havdal
- *
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class DirSource implements ConfigSource {
     private final File dir;
 
diff --git a/config/src/main/java/com/yahoo/config/subscription/FileSource.java b/config/src/main/java/com/yahoo/config/subscription/FileSource.java
index 2178c64cca3..bbad7286b4c 100644
--- a/config/src/main/java/com/yahoo/config/subscription/FileSource.java
+++ b/config/src/main/java/com/yahoo/config/subscription/FileSource.java
@@ -7,7 +7,9 @@ import java.io.File;
  * Source specifying config from one local file
  *
  * @author Vegard Havdal
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class FileSource implements ConfigSource {
 
     private final File file;
diff --git a/config/src/main/java/com/yahoo/config/subscription/JarSource.java b/config/src/main/java/com/yahoo/config/subscription/JarSource.java
index e367f78c31f..f39ee5e9262 100644
--- a/config/src/main/java/com/yahoo/config/subscription/JarSource.java
+++ b/config/src/main/java/com/yahoo/config/subscription/JarSource.java
@@ -6,8 +6,9 @@ import java.util.jar.JarFile;
 /**
  * Source specifying config as a jar file entry
  * @author Vegard Havdal
- *
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class JarSource implements ConfigSource {
     private final String path;
     private final JarFile jarFile;
diff --git a/config/src/main/java/com/yahoo/config/subscription/RawSource.java b/config/src/main/java/com/yahoo/config/subscription/RawSource.java
index 8b73d2058f5..28b249c6ece 100644
--- a/config/src/main/java/com/yahoo/config/subscription/RawSource.java
+++ b/config/src/main/java/com/yahoo/config/subscription/RawSource.java
@@ -5,7 +5,9 @@ package com.yahoo.config.subscription;
  * Source specifying raw config, where payload is given programmatically
  *
  * @author Vegard Havdal
+ * @deprecated  Will be removed in Vespa 8. Only for internal use.
  */
+@Deprecated(forRemoval = true, since = "7")
 public class RawSource implements ConfigSource {
 
     public final String payload;