Split the classes from the io.strimzi.api.kafka.model package to mult…

…iple sub-packages (strimzi#9207) Signed-off-by: ShubhamRwt <[email protected]>
PaulRMellor · Jan 8, 2024 · 5b7a7d7 · 5b7a7d7
1 parent 58e8ba9
commit 5b7a7d7
Show file tree

Hide file tree

Showing 874 changed files with 3,753 additions and 3,557 deletions.
diff --git a/.checkstyle/checkstyle.xml b/.checkstyle/checkstyle.xml
@@ -35,6 +35,15 @@
         <module name="UnnecessaryParentheses" />
         <module name="SimplifyBooleanReturn"/>
 
+        <module name="CustomImportOrder">
+            <property name="customImportOrderRules"
+                      value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC"/>
+            <property name="specialImportsRegExp" value="^javax\."/>
+            <property name="standardPackageRegExp" value="^java\."/>
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="separateLineBetweenGroups" value="false"/>
+        </module>
+
         <!-- style -->
         <module name="DefaultComesLast"/>
         <module name="EmptyStatement"/>

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
   Kubernetes 1.21 and 1.22 are not supported anymore.
 * Support for the JmxTrans component is now completely removed.
   If you are upgrading from Strimzi 0.34 or earlier and have JmxTrans enabled in `.spec.jmxTrans` of the `Kafka` custom resource, you should disable it before the upgrade or delete it manually after the upgrade is complete.
+* The `api` module was refactored and classes were moved to new packages.
 
 ## 0.39.0
 
@@ -74,7 +75,7 @@
     config.providers.env.class: org.apache.kafka.common.config.provider.EnvVarConfigProvider
     # ...
   ```
-
+  
 ## 0.37.0
 
 * The `StableConnectIdentites` feature gate moves to beta stage.

diff --git a/api/pom.xml b/api/pom.xml
@@ -188,14 +188,14 @@
                                 <argument>--api-versions</argument><argument>v1beta2</argument>
                                 <argument>--storage-version</argument><argument>v1beta2</argument>
                                 <argument>--yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.Kafka=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}040-Crd-kafka.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaConnect=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}041-Crd-kafkaconnect.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaMirrorMaker=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}045-Crd-kafkamirrormaker.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaBridge=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}046-Crd-kafkabridge.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaConnector=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}047-Crd-kafkaconnector.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaMirrorMaker2=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}048-Crd-kafkamirrormaker2.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaRebalance=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}049-Crd-kafkarebalance.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.StrimziPodSet=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}042-Crd-strimzipodset.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.kafka.Kafka=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}040-Crd-kafka.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.connect.KafkaConnect=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}041-Crd-kafkaconnect.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.mirrormaker.KafkaMirrorMaker=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}045-Crd-kafkamirrormaker.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.bridge.KafkaBridge=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}046-Crd-kafkabridge.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.connector.KafkaConnector=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}047-Crd-kafkaconnector.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.mirrormaker2.KafkaMirrorMaker2=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}048-Crd-kafkamirrormaker2.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.rebalance.KafkaRebalance=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}049-Crd-kafkarebalance.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.podset.StrimziPodSet=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}042-Crd-strimzipodset.yaml</argument>
                                 <argument>io.strimzi.api.kafka.model.nodepool.KafkaNodePool=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}04A-Crd-kafkanodepool.yaml</argument>
                             </arguments>
                         </configuration>
@@ -224,8 +224,8 @@
                                 <argument>--api-versions</argument><argument>v1alpha1,v1beta1,v1beta2</argument>
                                 <argument>--storage-version</argument><argument>v1beta2</argument>
                                 <argument>--yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaTopic=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}043-Crd-kafkatopic.yaml</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaUser=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}044-Crd-kafkauser.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.topic.KafkaTopic=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}043-Crd-kafkatopic.yaml</argument>
+                                <argument>io.strimzi.api.kafka.model.user.KafkaUser=${project.basedir}${file.separator}..${file.separator}packaging${file.separator}install${file.separator}cluster-operator${file.separator}044-Crd-kafkauser.yaml</argument>
                             </arguments>
                         </configuration>
                     </execution>
@@ -245,17 +245,17 @@
                                 <argument>io.strimzi.crdgenerator.KubeLinker</argument>
                                 <argument>https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/</argument>
                                 <argument>modules/appendix_crds.adoc</argument>
-                                <argument>io.strimzi.api.kafka.model.Kafka</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaConnect</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaTopic</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaUser</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaMirrorMaker</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaBridge</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaConnector</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaMirrorMaker2</argument>
-                                <argument>io.strimzi.api.kafka.model.KafkaRebalance</argument>
+                                <argument>io.strimzi.api.kafka.model.kafka.Kafka</argument>
+                                <argument>io.strimzi.api.kafka.model.connect.KafkaConnect</argument>
+                                <argument>io.strimzi.api.kafka.model.topic.KafkaTopic</argument>
+                                <argument>io.strimzi.api.kafka.model.user.KafkaUser</argument>
+                                <argument>io.strimzi.api.kafka.model.mirrormaker.KafkaMirrorMaker</argument>
+                                <argument>io.strimzi.api.kafka.model.bridge.KafkaBridge</argument>
+                                <argument>io.strimzi.api.kafka.model.connector.KafkaConnector</argument>
+                                <argument>io.strimzi.api.kafka.model.mirrormaker2.KafkaMirrorMaker2</argument>
+                                <argument>io.strimzi.api.kafka.model.rebalance.KafkaRebalance</argument>
                                 <argument>io.strimzi.api.kafka.model.nodepool.KafkaNodePool</argument>
-                                <argument>io.strimzi.api.kafka.model.StrimziPodSet</argument>
+                                <argument>io.strimzi.api.kafka.model.podset.StrimziPodSet</argument>
                             </arguments>
                             <workingDirectory>${project.basedir}${file.separator}..${file.separator}documentation</workingDirectory>
                         </configuration>

diff --git a/api/src/main/java/io/strimzi/api/kafka/Crds.java b/api/src/main/java/io/strimzi/api/kafka/Crds.java
@@ -14,17 +14,28 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.Resource;
-import io.strimzi.api.kafka.model.Kafka;
-import io.strimzi.api.kafka.model.KafkaBridge;
-import io.strimzi.api.kafka.model.KafkaConnect;
-import io.strimzi.api.kafka.model.KafkaConnector;
-import io.strimzi.api.kafka.model.KafkaMirrorMaker;
-import io.strimzi.api.kafka.model.KafkaMirrorMaker2;
-import io.strimzi.api.kafka.model.StrimziPodSet;
-import io.strimzi.api.kafka.model.KafkaRebalance;
-import io.strimzi.api.kafka.model.KafkaTopic;
-import io.strimzi.api.kafka.model.KafkaUser;
+import io.strimzi.api.kafka.model.bridge.KafkaBridge;
+import io.strimzi.api.kafka.model.bridge.KafkaBridgeList;
+import io.strimzi.api.kafka.model.connect.KafkaConnect;
+import io.strimzi.api.kafka.model.connect.KafkaConnectList;
+import io.strimzi.api.kafka.model.connector.KafkaConnector;
+import io.strimzi.api.kafka.model.connector.KafkaConnectorList;
+import io.strimzi.api.kafka.model.kafka.Kafka;
+import io.strimzi.api.kafka.model.kafka.KafkaList;
+import io.strimzi.api.kafka.model.mirrormaker.KafkaMirrorMaker;
+import io.strimzi.api.kafka.model.mirrormaker.KafkaMirrorMakerList;
+import io.strimzi.api.kafka.model.mirrormaker2.KafkaMirrorMaker2;
+import io.strimzi.api.kafka.model.mirrormaker2.KafkaMirrorMaker2List;
 import io.strimzi.api.kafka.model.nodepool.KafkaNodePool;
+import io.strimzi.api.kafka.model.nodepool.KafkaNodePoolList;
+import io.strimzi.api.kafka.model.podset.StrimziPodSet;
+import io.strimzi.api.kafka.model.podset.StrimziPodSetList;
+import io.strimzi.api.kafka.model.rebalance.KafkaRebalance;
+import io.strimzi.api.kafka.model.rebalance.KafkaRebalanceList;
+import io.strimzi.api.kafka.model.topic.KafkaTopic;
+import io.strimzi.api.kafka.model.topic.KafkaTopicList;
+import io.strimzi.api.kafka.model.user.KafkaUser;
+import io.strimzi.api.kafka.model.user.KafkaUserList;
 
 import java.util.ArrayList;
 import java.util.List;

diff --git a/.../strimzi/api/kafka/model/KafkaBridge.java → ...i/api/kafka/model/bridge/KafkaBridge.java b/.../strimzi/api/kafka/model/KafkaBridge.java → ...i/api/kafka/model/bridge/KafkaBridge.java
@@ -2,7 +2,7 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
@@ -13,7 +13,9 @@
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
-import io.strimzi.api.kafka.model.status.KafkaBridgeStatus;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.CustomResourceConditions;
+import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
 import io.strimzi.crdgenerator.annotations.Crd;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.sundr.builder.annotations.Buildable;

diff --git a/...fka/model/KafkaBridgeAdminClientSpec.java → ...el/bridge/KafkaBridgeAdminClientSpec.java b/...fka/model/KafkaBridgeAdminClientSpec.java → ...el/bridge/KafkaBridgeAdminClientSpec.java
@@ -2,9 +2,10 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.strimzi.api.kafka.model.common.Constants;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.sundr.builder.annotations.Buildable;
 import lombok.EqualsAndHashCode;

diff --git a/...pi/kafka/model/KafkaBridgeClientSpec.java → ...a/model/bridge/KafkaBridgeClientSpec.java b/...pi/kafka/model/KafkaBridgeClientSpec.java → ...a/model/bridge/KafkaBridgeClientSpec.java
@@ -2,9 +2,11 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
 import io.sundr.builder.annotations.Buildable;
 import lombok.EqualsAndHashCode;
 

diff --git a/.../kafka/model/KafkaBridgeConsumerSpec.java → ...model/bridge/KafkaBridgeConsumerSpec.java b/.../kafka/model/KafkaBridgeConsumerSpec.java → ...model/bridge/KafkaBridgeConsumerSpec.java
@@ -2,9 +2,10 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.strimzi.api.kafka.model.common.Constants;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.strimzi.crdgenerator.annotations.DescriptionFile;
 import io.sundr.builder.annotations.Buildable;

diff --git a/...pi/kafka/model/KafkaBridgeHttpConfig.java → ...a/model/bridge/KafkaBridgeHttpConfig.java b/...pi/kafka/model/KafkaBridgeHttpConfig.java → ...a/model/bridge/KafkaBridgeHttpConfig.java
@@ -2,11 +2,13 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.strimzi.crdgenerator.annotations.DescriptionFile;
 import io.strimzi.crdgenerator.annotations.Minimum;

diff --git a/.../api/kafka/model/KafkaBridgeHttpCors.java → ...fka/model/bridge/KafkaBridgeHttpCors.java b/.../api/kafka/model/KafkaBridgeHttpCors.java → ...fka/model/bridge/KafkaBridgeHttpCors.java
@@ -2,11 +2,13 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.UnknownPropertyPreserving;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.sundr.builder.annotations.Buildable;
 import lombok.EqualsAndHashCode;

diff --git a/...io/strimzi/api/kafka/KafkaBridgeList.java → ...i/kafka/model/bridge/KafkaBridgeList.java b/...io/strimzi/api/kafka/KafkaBridgeList.java → ...i/kafka/model/bridge/KafkaBridgeList.java
@@ -2,10 +2,9 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka;
+package io.strimzi.api.kafka.model.bridge;
 
 import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList;
-import io.strimzi.api.kafka.model.KafkaBridge;
 
 /**
  * A {@code DefaultKubernetesResourceList<KafkaBridge>} required for using Fabric8 CRD support.

diff --git a/.../kafka/model/KafkaBridgeProducerSpec.java → ...model/bridge/KafkaBridgeProducerSpec.java b/.../kafka/model/KafkaBridgeProducerSpec.java → ...model/bridge/KafkaBridgeProducerSpec.java
@@ -2,9 +2,10 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import io.strimzi.api.kafka.model.common.Constants;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.strimzi.crdgenerator.annotations.DescriptionFile;
 import io.sundr.builder.annotations.Buildable;

diff --git a/...api/kafka/model/KafkaBridgeResources.java → ...ka/model/bridge/KafkaBridgeResources.java b/...api/kafka/model/KafkaBridgeResources.java → ...ka/model/bridge/KafkaBridgeResources.java
@@ -2,7 +2,7 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 /**
  * Encapsulates the naming scheme used for the resources which the Cluster Operator manages for a

diff --git a/...imzi/api/kafka/model/KafkaBridgeSpec.java → ...i/kafka/model/bridge/KafkaBridgeSpec.java b/...imzi/api/kafka/model/KafkaBridgeSpec.java → ...i/kafka/model/bridge/KafkaBridgeSpec.java
@@ -2,15 +2,24 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import io.fabric8.kubernetes.api.model.ResourceRequirements;
-import io.strimzi.api.kafka.model.authentication.KafkaClientAuthentication;
-import io.strimzi.api.kafka.model.template.KafkaBridgeTemplate;
-import io.strimzi.api.kafka.model.tracing.Tracing;
+import io.strimzi.api.kafka.model.common.ClientTls;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.common.HasConfigurableLogging;
+import io.strimzi.api.kafka.model.common.HasLivenessProbe;
+import io.strimzi.api.kafka.model.common.HasReadinessProbe;
+import io.strimzi.api.kafka.model.common.JvmOptions;
+import io.strimzi.api.kafka.model.common.Logging;
+import io.strimzi.api.kafka.model.common.Probe;
+import io.strimzi.api.kafka.model.common.Rack;
+import io.strimzi.api.kafka.model.common.Spec;
+import io.strimzi.api.kafka.model.common.authentication.KafkaClientAuthentication;
+import io.strimzi.api.kafka.model.common.tracing.Tracing;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.strimzi.crdgenerator.annotations.DescriptionFile;
 import io.strimzi.crdgenerator.annotations.KubeLink;

diff --git a/...kafka/model/status/KafkaBridgeStatus.java → ...kafka/model/bridge/KafkaBridgeStatus.java b/...kafka/model/status/KafkaBridgeStatus.java → ...kafka/model/bridge/KafkaBridgeStatus.java
@@ -2,11 +2,12 @@
  * Copyright Strimzi authors.
  * License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
  */
-package io.strimzi.api.kafka.model.status;
+package io.strimzi.api.kafka.model.bridge;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import io.strimzi.api.kafka.model.Constants;
+import io.strimzi.api.kafka.model.common.Constants;
+import io.strimzi.api.kafka.model.kafka.Status;
 import io.strimzi.crdgenerator.annotations.Description;
 import io.sundr.builder.annotations.Buildable;
 import lombok.EqualsAndHashCode;