KAFKA-19757: Interface stability and deprecation (#20916)

Mark KIP-932 and KIP-1043 interfaces as stable. Tighten up deprecation
annotations for interfaces whose removal is planned in AK 5.0.

Reviewers: Lianet Magrans <[email protected]>

Author: AndrewJSchofield

clients/src/main/java/org/apache/kafka/clients/admin/AlterShareGroupOffsetsOptions.java

@@ -14,19 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.kafka.clients.admin;
 
-import org.apache.kafka.common.annotation.InterfaceStability;
-
 import java.util.Map;
 
 /**
- * Options for the {@link Admin#alterShareGroupOffsets(String, Map, AlterShareGroupOffsetsOptions)} call.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
+ * Options for {@link Admin#alterShareGroupOffsets(String, Map, AlterShareGroupOffsetsOptions)}.
  */
-@InterfaceStability.Evolving
 public class AlterShareGroupOffsetsOptions extends AbstractOptions<AlterShareGroupOffsetsOptions> {
-
 }

clients/src/main/java/org/apache/kafka/clients/admin/AlterShareGroupOffsetsResult.java

@@ -19,7 +19,6 @@
 
 import org.apache.kafka.common.KafkaFuture;
 import org.apache.kafka.common.TopicPartition;
-import org.apache.kafka.common.annotation.InterfaceStability;
 import org.apache.kafka.common.errors.ApiException;
 import org.apache.kafka.common.internals.KafkaFutureImpl;
 import org.apache.kafka.common.protocol.Errors;
@@ -30,10 +29,7 @@
 
 /**
  * The result of the {@link Admin#alterShareGroupOffsets(String, Map, AlterShareGroupOffsetsOptions)} call.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
  */
-@InterfaceStability.Evolving
 public class AlterShareGroupOffsetsResult {
 
     private final KafkaFuture<Map<TopicPartition, ApiException>> future;

clients/src/main/java/org/apache/kafka/clients/admin/ClassicGroupDescription.java

@@ -137,7 +137,7 @@ public Node coordinator() {
     /**
      * authorizedOperations for this group, or null if that information is not known.
      */
-    public  Set<AclOperation> authorizedOperations() {
+    public Set<AclOperation> authorizedOperations() {
         return authorizedOperations;
     }
 

clients/src/main/java/org/apache/kafka/clients/admin/ConsumerGroupDescription.java

@@ -49,7 +49,8 @@ public class ConsumerGroupDescription {
     /**
      * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
      */
-    @Deprecated
+    @SuppressWarnings("removal")
+    @Deprecated(since = "4.0", forRemoval = true)
     public ConsumerGroupDescription(String groupId,
                                     boolean isSimpleConsumerGroup,
                                     Collection<MemberDescription> members,
@@ -62,7 +63,8 @@ public ConsumerGroupDescription(String groupId,
     /**
      * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
      */
-    @Deprecated
+    @SuppressWarnings("removal")
+    @Deprecated(since = "4.0", forRemoval = true)
     public ConsumerGroupDescription(String groupId,
                                     boolean isSimpleConsumerGroup,
                                     Collection<MemberDescription> members,
@@ -76,7 +78,8 @@ public ConsumerGroupDescription(String groupId,
     /**
      * @deprecated Since 4.0. Use {@link #ConsumerGroupDescription(String, boolean, Collection, String, GroupType, GroupState, Node, Set, Optional, Optional)} instead.
      */
-    @Deprecated
+    @SuppressWarnings("removal")
+    @Deprecated(since = "4.0", forRemoval = true)
     public ConsumerGroupDescription(String groupId,
                                     boolean isSimpleConsumerGroup,
                                     Collection<MemberDescription> members,
@@ -182,7 +185,8 @@ public GroupType type() {
      * The consumer group state, or UNKNOWN if the state is too new for us to parse.
      * @deprecated Since 4.0. Use {@link #groupState()} instead.
      */
-    @Deprecated
+    @SuppressWarnings("removal")
+    @Deprecated(since = "4.0", forRemoval = true)
     public ConsumerGroupState state() {
         return ConsumerGroupState.parse(groupState.toString());
     }
@@ -204,7 +208,7 @@ public Node coordinator() {
     /**
      * authorizedOperations for this group, or null if that information is not known.
      */
-    public  Set<AclOperation> authorizedOperations() {
+    public Set<AclOperation> authorizedOperations() {
         return authorizedOperations;
     }
 

clients/src/main/java/org/apache/kafka/clients/admin/ConsumerGroupListing.java

@@ -28,7 +28,8 @@
  * A listing of a consumer group in the cluster.
  * @deprecated Since 4.1. Use {@link Admin#listGroups(ListGroupsOptions)} and {@link GroupListing} instead.
  */
-@Deprecated(since = "4.1")
+@SuppressWarnings("removal")
+@Deprecated(since = "4.1", forRemoval = true)
 public class ConsumerGroupListing {
     private final String groupId;
     private final boolean isSimpleConsumerGroup;

clients/src/main/java/org/apache/kafka/clients/admin/DeleteShareGroupOffsetsOptions.java

@@ -14,18 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.kafka.clients.admin;
 
-import org.apache.kafka.common.annotation.InterfaceStability;
-
 import java.util.Set;
 
 /**
- * Options for the {@link Admin#deleteShareGroupOffsets(String, Set, DeleteShareGroupOffsetsOptions)} call.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
+ * Options for {@link Admin#deleteShareGroupOffsets(String, Set, DeleteShareGroupOffsetsOptions)}.
  */
-@InterfaceStability.Evolving
 public class DeleteShareGroupOffsetsOptions extends AbstractOptions<DeleteShareGroupOffsetsOptions> {
 }

clients/src/main/java/org/apache/kafka/clients/admin/DeleteShareGroupOffsetsResult.java

@@ -17,7 +17,6 @@
 package org.apache.kafka.clients.admin;
 
 import org.apache.kafka.common.KafkaFuture;
-import org.apache.kafka.common.annotation.InterfaceStability;
 import org.apache.kafka.common.errors.ApiException;
 import org.apache.kafka.common.internals.KafkaFutureImpl;
 
@@ -26,10 +25,7 @@
 
 /**
  * The result of the {@link Admin#deleteShareGroupOffsets(String, Set, DeleteShareGroupOffsetsOptions)} call.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
  */
-@InterfaceStability.Evolving
 public class DeleteShareGroupOffsetsResult {
 
     private final KafkaFuture<Map<String, ApiException>> future;

clients/src/main/java/org/apache/kafka/clients/admin/DeleteShareGroupsOptions.java

@@ -14,18 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.kafka.clients.admin;
 
-import org.apache.kafka.common.annotation.InterfaceStability;
-
 import java.util.Collection;
 
 /**
- * Options for the {@link Admin#deleteShareGroups(Collection, DeleteShareGroupsOptions)} call.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
+ * Options for {@link Admin#deleteShareGroups(Collection, DeleteShareGroupsOptions)}.
  */
-@InterfaceStability.Evolving
 public class DeleteShareGroupsOptions extends AbstractOptions<DeleteShareGroupsOptions> {
 }

clients/src/main/java/org/apache/kafka/clients/admin/DeleteShareGroupsResult.java

@@ -14,22 +14,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.kafka.clients.admin;
 
 import org.apache.kafka.common.KafkaFuture;
-import org.apache.kafka.common.annotation.InterfaceStability;
 
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 
 /**
  * The result of the {@link Admin#deleteShareGroups(Collection, DeleteShareGroupsOptions)} call.
- * <p></p>
- * The API of this class is evolving, see {@link Admin} for details.
  */
-@InterfaceStability.Evolving
 public class DeleteShareGroupsResult {
     private final Map<String, KafkaFuture<Void>> futures;
 

clients/src/main/java/org/apache/kafka/clients/admin/DescribeClassicGroupsOptions.java

@@ -17,16 +17,11 @@
 
 package org.apache.kafka.clients.admin;
 
-import org.apache.kafka.common.annotation.InterfaceStability;
-
 import java.util.Collection;
 
 /**
  * Options for {@link Admin#describeClassicGroups(Collection, DescribeClassicGroupsOptions)}.
- * <p>
- * The API of this class is evolving, see {@link Admin} for details.
  */
-@InterfaceStability.Evolving
 public class DescribeClassicGroupsOptions extends AbstractOptions<DescribeClassicGroupsOptions> {
     private boolean includeAuthorizedOperations;