Change SaslInspection filter's package using @DeprecatedPluginName (kroxylicious#3113)

tombentley · web-flow · commit d3b2e7f72718 · 2026-01-13T02:07:44.000Z
From `io.kroxylicious.filters.sasl.inspection` to `io.kroxylicious.filter.sasl.inspection` (singular filter)
Signed-off-by: Tom Bentley &lt;tbentley@redhat.com&gt;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/Config.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/Config.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.Set;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserver.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserver.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.Optional;
 import java.util.function.Predicate;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserverFactory.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserverFactory.java
@@ -4,14 +4,16 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
+import io.kroxylicious.proxy.plugin.DeprecatedPluginName;
 import io.kroxylicious.proxy.plugin.Plugin;
 
 /**
  * Factory for the {@link OauthBearerSaslObserver} instances.
  */
 @Plugin(configType = Void.class)
+@DeprecatedPluginName(oldName = "io.kroxylicious.filters.sasl.inspection.OauthBearerSaslObserverFactory", since = "0.19.0")
 public class OauthBearerSaslObserverFactory implements SaslObserverFactory {
     @Override
     public SaslObserver createObserver() {
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserver.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserver.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserverFactory.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserverFactory.java
@@ -4,8 +4,9 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
+import io.kroxylicious.proxy.plugin.DeprecatedPluginName;
 import io.kroxylicious.proxy.plugin.Plugin;
 
 /**
@@ -16,6 +17,7 @@
  * Proxy.
  */
 @Plugin(configType = Void.class)
+@DeprecatedPluginName(oldName = "io.kroxylicious.filters.sasl.inspection.PlainSaslObserverFactory", since = "0.19.0")
 public class PlainSaslObserverFactory implements SaslObserverFactory {
     @Override
     public SaslObserver createObserver() {
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslInspection.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslInspection.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -27,6 +27,7 @@
 import io.kroxylicious.proxy.filter.Filter;
 import io.kroxylicious.proxy.filter.FilterFactory;
 import io.kroxylicious.proxy.filter.FilterFactoryContext;
+import io.kroxylicious.proxy.plugin.DeprecatedPluginName;
 import io.kroxylicious.proxy.plugin.Plugin;
 import io.kroxylicious.proxy.plugin.PluginConfigurationException;
 import io.kroxylicious.proxy.tag.VisibleForTesting;
@@ -38,6 +39,7 @@
  * Factory for {@link SaslInspectionFilter}.
  */
 @Plugin(configType = Config.class)
+@DeprecatedPluginName(oldName = "io.kroxylicious.filters.sasl.inspection.SaslInspection", since = "0.19.0")
 public class SaslInspection implements FilterFactory<Config, Void> {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(SaslInspection.class);
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionFilter.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionFilter.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.ArrayList;
 import java.util.Map;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslObserver.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslObserver.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import javax.security.sasl.SaslException;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslObserverFactory.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslObserverFactory.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 /**
  * Factory for {@link SaslObserver} instances.
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslUtils.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/SaslUtils.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 final class SaslUtils {
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSaslObserver.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSaslObserver.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSha256SaslObserverFactory.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSha256SaslObserverFactory.java
@@ -4,14 +4,16 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
+import io.kroxylicious.proxy.plugin.DeprecatedPluginName;
 import io.kroxylicious.proxy.plugin.Plugin;
 
 /**
  * Factory for the {@link ScramSaslObserver}.
  */
 @Plugin(configType = Void.class)
+@DeprecatedPluginName(oldName = "io.kroxylicious.filters.sasl.inspection.ScramSha256SaslObserverFactory", since = "0.19.0")
 public class ScramSha256SaslObserverFactory implements SaslObserverFactory {
     @Override
     public SaslObserver createObserver() {
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSha512SaslObserverFactory.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/ScramSha512SaslObserverFactory.java
@@ -4,15 +4,17 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
+import io.kroxylicious.proxy.plugin.DeprecatedPluginName;
 import io.kroxylicious.proxy.plugin.Plugin;
 
 /**
  /**
  * Factory for the {@link ScramSaslObserver}.
  */
 @Plugin(configType = Void.class)
+@DeprecatedPluginName(oldName = "io.kroxylicious.filters.sasl.inspection.ScramSha512SaslObserverFactory", since = "0.19.0")
 public class ScramSha512SaslObserverFactory implements SaslObserverFactory {
     @Override
     public SaslObserver createObserver() {
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/State.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/State.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 /**
  * State machine used that follows SASL handshaking and authentication exchange between client/server.
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/package-info.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/java/io/kroxylicious/filter/sasl/inspection/package-info.java
@@ -10,7 +10,7 @@
 @ReturnValuesAreNonnullByDefault
 @DefaultAnnotationForParameters(NonNull.class)
 @DefaultAnnotation(NonNull.class)
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import edu.umd.cs.findbugs.annotations.DefaultAnnotation;
 import edu.umd.cs.findbugs.annotations.DefaultAnnotationForParameters;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.filter.sasl.inspection.SaslObserverFactory b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.filter.sasl.inspection.SaslObserverFactory
@@ -0,0 +1,10 @@
+#
+# Copyright Kroxylicious Authors.
+#
+# Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+#
+
+io.kroxylicious.filter.sasl.inspection.OauthBearerSaslObserverFactory
+io.kroxylicious.filter.sasl.inspection.PlainSaslObserverFactory
+io.kroxylicious.filter.sasl.inspection.ScramSha256SaslObserverFactory
+io.kroxylicious.filter.sasl.inspection.ScramSha512SaslObserverFactory
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.filters.sasl.inspection.SaslObserverFactory b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.filters.sasl.inspection.SaslObserverFactory
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.proxy.filter.FilterFactory b/kroxylicious-filters/kroxylicious-sasl-inspection/src/main/resources/META-INF/services/io.kroxylicious.proxy.filter.FilterFactory
@@ -3,4 +3,4 @@
 #
 # Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 #
-io.kroxylicious.filters.sasl.inspection.SaslInspection
+io.kroxylicious.filter.sasl.inspection.SaslInspection
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/ConfigurationSerializationTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/ConfigurationSerializationTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.io.IOException;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/MockSubjectBuilderService.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/MockSubjectBuilderService.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import io.kroxylicious.proxy.authentication.SaslSubjectBuilder;
 import io.kroxylicious.proxy.authentication.SaslSubjectBuilderService;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserverTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/OauthBearerSaslObserverTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.stream.Stream;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserverTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/PlainSaslObserverTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.stream.Stream;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionFilterTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionFilterTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslInspectionTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.List;
 import java.util.Set;
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslUtilsTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/SaslUtilsTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.stream.Stream;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/ScramSaslObserverTest.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/ScramSaslObserverTest.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.stream.Stream;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/TestData.java b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/java/io/kroxylicious/filter/sasl/inspection/TestData.java
@@ -4,7 +4,7 @@
  * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
  */
 
-package io.kroxylicious.filters.sasl.inspection;
+package io.kroxylicious.filter.sasl.inspection;
 
 import java.util.Base64;
 
diff --git a/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/resources/META-INF/services/io.kroxylicious.proxy.authentication.SaslSubjectBuilderService b/kroxylicious-filters/kroxylicious-sasl-inspection/src/test/resources/META-INF/services/io.kroxylicious.proxy.authentication.SaslSubjectBuilderService
@@ -3,4 +3,4 @@
 #
 # Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 #
-io.kroxylicious.filters.sasl.inspection.MockSubjectBuilderService
+io.kroxylicious.filter.sasl.inspection.MockSubjectBuilderService
diff --git a/kroxylicious-integration-tests/src/test/java/io/kroxylicious/proxy/SaslInspectionIT.java b/kroxylicious-integration-tests/src/test/java/io/kroxylicious/proxy/SaslInspectionIT.java
@@ -34,7 +34,7 @@
 
 import io.github.nettyplus.leakdetector.junit.NettyLeakDetectorExtension;
 
-import io.kroxylicious.filters.sasl.inspection.SaslInspection;
+import io.kroxylicious.filter.sasl.inspection.SaslInspection;
 import io.kroxylicious.proxy.authentication.UserFactory;
 import io.kroxylicious.proxy.config.ConfigurationBuilder;
 import io.kroxylicious.proxy.config.NamedFilterDefinition;
diff --git a/kroxylicious-integration-tests/src/test/java/io/kroxylicious/proxy/SaslInspectionOauthBearerIT.java b/kroxylicious-integration-tests/src/test/java/io/kroxylicious/proxy/SaslInspectionOauthBearerIT.java
@@ -25,7 +25,7 @@
 import org.junit.jupiter.api.condition.EnabledIf;
 import org.junit.jupiter.api.io.TempDir;
 
-import io.kroxylicious.filters.sasl.inspection.SaslInspection;
+import io.kroxylicious.filter.sasl.inspection.SaslInspection;
 import io.kroxylicious.proxy.config.ConfigurationBuilder;
 import io.kroxylicious.proxy.config.NamedFilterDefinitionBuilder;
 import io.kroxylicious.proxy.testplugins.ClientAuthAwareLawyer;
diff --git a/kroxylicious-systemtests/src/main/java/io/kroxylicious/systemtests/templates/kroxylicious/KroxyliciousFilterTemplates.java b/kroxylicious-systemtests/src/main/java/io/kroxylicious/systemtests/templates/kroxylicious/KroxyliciousFilterTemplates.java
@@ -29,8 +29,8 @@
 import io.kroxylicious.filter.authorization.Authorization;
 import io.kroxylicious.filter.authorization.AuthorizationConfig;
 import io.kroxylicious.filter.encryption.RecordEncryption;
-import io.kroxylicious.filters.sasl.inspection.Config;
-import io.kroxylicious.filters.sasl.inspection.SaslInspection;
+import io.kroxylicious.filter.sasl.inspection.Config;
+import io.kroxylicious.filter.sasl.inspection.SaslInspection;
 import io.kroxylicious.kms.service.TestKmsFacade;
 import io.kroxylicious.kubernetes.api.v1alpha1.KafkaProtocolFilterBuilder;
 import io.kroxylicious.systemtests.Constants;
