Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Exceptions
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
org.apache.kafka.common.serialization.ExtendedDeserializer This class has been deprecated and will be removed in a future release. Please use Deserializer instead.
org.apache.kafka.common.serialization.ExtendedSerializer This class has been deprecated and will be removed in a future release. Please use Serializer instead.
org.apache.kafka.common.security.auth.PrincipalBuilder As of Kafka 1.0.0, use KafkaPrincipalBuilder instead. This will be removed in a future major release.

Deprecated Classes

Class and Description
org.apache.kafka.common.metrics.stats.Count since 2.4 . Use WindowedCount instead
org.apache.kafka.common.security.auth.DefaultPrincipalBuilder As of Kafka 1.0.0. This will be removed in a future major release.
org.apache.kafka.clients.admin.ElectPreferredLeadersOptions Since 2.4.0. Use Admin.electLeaders(ElectionType, Set, ElectLeadersOptions).
org.apache.kafka.clients.admin.ElectPreferredLeadersResult Since 2.4.0. Use Admin.electLeaders(ElectionType, Set, ElectLeadersOptions).
org.apache.kafka.common.metrics.stats.Rate.SampledTotal since 2.4 Use WindowedSum instead.
org.apache.kafka.common.metrics.stats.Sum since 2.4 . Use WindowedSum instead
org.apache.kafka.common.metrics.stats.Total since 2.4 . Use CumulativeSum instead.

Deprecated Enums

Enum and Description
org.apache.kafka.clients.admin.BrokerRemovalDescription.BrokerShutdownStatus - use #BrokerShutdownStatus
org.apache.kafka.clients.admin.BrokerRemovalDescription.PartitionReassignmentsStatus - use #PartitionReassignmentsStatus

Deprecated Exceptions

Exceptions and Description
org.apache.kafka.common.errors.NotLeaderForPartitionException since 2.6. Use NotLeaderOrFollowerException.

Deprecated Fields

Field and Description
org.apache.kafka.common.config.SslConfigs.DEFAULT_PRINCIPAL_BUILDER_CLASS As of 1.0.0. This field will be removed in a future major release. In recent versions, the config is optional and there is no default.
org.apache.kafka.common.config.SaslConfigs.DEFAULT_SASL_ENABLED_MECHANISMS As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SaslConfigs.DEFAULT_SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SslConfigs.PRINCIPAL_BUILDER_CLASS_CONFIG As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SslConfigs.PRINCIPAL_BUILDER_CLASS_DOC As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SaslConfigs.SASL_ENABLED_MECHANISMS As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SaslConfigs.SASL_ENABLED_MECHANISMS_DOC As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SaslConfigs.SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SaslConfigs.SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SslConfigs.SSL_CLIENT_AUTH_CONFIG As of 1.0.0. This field will be removed in a future major release.
org.apache.kafka.common.config.SslConfigs.SSL_CLIENT_AUTH_DOC As of 1.0.0. This field will be removed in a future major release.

Deprecated Methods

Method and Description
org.apache.kafka.clients.consumer.ConsumerConfig.addDeserializerToConfig(Map<String, Object>, Deserializer<?>, Deserializer<?>) Since 2.7.0. This will be removed in a future major release.
org.apache.kafka.clients.consumer.ConsumerConfig.addDeserializerToConfig(Properties, Deserializer<?>, Deserializer<?>) Since 2.7.0. This will be removed in a future major release.
org.apache.kafka.clients.producer.ProducerConfig.addSerializerToConfig(Map<String, Object>, Serializer<?>, Serializer<?>) Since 2.7.0. This will be removed in a future major release.
org.apache.kafka.clients.producer.ProducerConfig.addSerializerToConfig(Properties, Serializer<?>, Serializer<?>) Since 2.7.0. This will be removed in a future major release.
org.apache.kafka.clients.admin.DescribeLogDirsResult.all() Deprecated Since Kafka 2.7. Use DescribeLogDirsResult.allDescriptions().
org.apache.kafka.clients.admin.Admin.alterConfigs(Map<ConfigResource, Config>) Since 2.3. Use Admin.incrementalAlterConfigs(Map).
org.apache.kafka.clients.admin.Admin.alterConfigs(Map<ConfigResource, Config>, AlterConfigsOptions) Since 2.3. Use Admin.incrementalAlterConfigs(Map, AlterConfigsOptions).
org.apache.kafka.clients.admin.KafkaAdminClient.alterConfigs(Map<ConfigResource, Config>, AlterConfigsOptions)
org.apache.kafka.clients.admin.BrokerRemovalDescription.brokerShutdownStatus() Since 6.1. Use #BrokerRemovalDescription.shutdownStatus()
org.apache.kafka.clients.consumer.ConsumerRecord.checksum() As of Kafka 0.11.0. Because of the potential for message format conversion on the broker, the checksum returned by the broker may not match what was computed by the producer. It is therefore unsafe to depend on this checksum for end-to-end delivery guarantees. Additionally, message format v2 does not include a record-level checksum (for performance, the record checksum was replaced with a batch checksum). To maintain compatibility, a partial checksum computed from the record timestamp, serialized key size, and serialized value size is returned instead, but this should not be depended on for end-to-end reliability.
org.apache.kafka.clients.producer.RecordMetadata.checksum() As of Kafka 0.11.0. Because of the potential for message format conversion on the broker, the computed checksum may not match what was stored on the broker, or what will be returned to the consumer. It is therefore unsafe to depend on this checksum for end-to-end delivery guarantees. Additionally, message format v2 does not include a record-level checksum (for performance, the record checksum was replaced with a batch checksum). To maintain compatibility, a partial checksum computed from the record timestamp, serialized key size, and serialized value size is returned instead, but this should not be depended on for end-to-end reliability.
org.apache.kafka.clients.admin.Admin.close(long, TimeUnit) Since 2.2. Use Admin.close(Duration) or Admin.close().
org.apache.kafka.clients.consumer.MockConsumer.close(long, TimeUnit)
org.apache.kafka.clients.consumer.Consumer.close(long, TimeUnit)
org.apache.kafka.clients.consumer.KafkaConsumer.close(long, TimeUnit) Since 2.0. Use KafkaConsumer.close(Duration) or KafkaConsumer.close().
org.apache.kafka.clients.producer.Producer.close(long, TimeUnit)
org.apache.kafka.clients.consumer.MockConsumer.committed(TopicPartition)
org.apache.kafka.clients.consumer.Consumer.committed(TopicPartition)
org.apache.kafka.clients.consumer.KafkaConsumer.committed(TopicPartition) since 2.4 Use KafkaConsumer.committed(Set) instead
org.apache.kafka.clients.consumer.MockConsumer.committed(TopicPartition, Duration)
org.apache.kafka.clients.consumer.Consumer.committed(TopicPartition, Duration)
org.apache.kafka.clients.consumer.KafkaConsumer.committed(TopicPartition, Duration) since 2.4 Use KafkaConsumer.committed(Set, Duration) instead
org.apache.kafka.clients.admin.Admin.electPreferredLeaders(Collection<TopicPartition>) Since 2.4.0. Use Admin.electLeaders(ElectionType, Set).
org.apache.kafka.clients.admin.Admin.electPreferredLeaders(Collection<TopicPartition>, ElectPreferredLeadersOptions) Since 2.4.0. Use Admin.electLeaders(ElectionType, Set, ElectLeadersOptions).
org.apache.kafka.common.security.auth.KafkaPrincipal.fromString(String) As of 1.0.0. This method will be removed in a future major release.
org.apache.kafka.common.MessageFormatter.init(Properties) Use MessageFormatter.configure(Map) instead, this method is for backward compatibility with the older Formatter interface
org.apache.kafka.clients.consumer.NoOffsetForPartitionException.partition() please use NoOffsetForPartitionException.partitions
org.apache.kafka.clients.admin.BrokerRemovalDescription.partitionReassignmentsStatus() Since 6.1. Use #BrokerRemovalDescription.reassignmentsStatus()
org.apache.kafka.clients.consumer.MockConsumer.poll(long)
org.apache.kafka.clients.consumer.Consumer.poll(long)
org.apache.kafka.clients.consumer.KafkaConsumer.poll(long) Since 2.0. Use KafkaConsumer.poll(Duration), which does not block beyond the timeout awaiting partition assignment. See KIP-266 for more information.
org.apache.kafka.clients.consumer.MockConsumer.setException(KafkaException) Use MockConsumer.setPollException(KafkaException) instead
org.apache.kafka.common.Metric.value() As of 1.0.0, use Metric.metricValue() instead. This will be removed in a future major release.
org.apache.kafka.common.metrics.KafkaMetric.value()
org.apache.kafka.clients.admin.DescribeLogDirsResult.values() Deprecated Since Kafka 2.7. Use DescribeLogDirsResult.descriptions().

Deprecated Constructors

Constructor and Description
org.apache.kafka.common.acl.AclBinding(Resource, AccessControlEntry) Since 2.0. Use AclBinding(ResourcePattern, AccessControlEntry)
org.apache.kafka.common.acl.AclBindingFilter(ResourceFilter, AccessControlEntryFilter) Since 2.0. Use AclBindingFilter(ResourcePatternFilter, AccessControlEntryFilter)
org.apache.kafka.clients.admin.BrokerRemovalDescription(Integer, BrokerRemovalDescription.BrokerShutdownStatus, BrokerRemovalDescription.PartitionReassignmentsStatus, Optional<BrokerRemovalError>)
org.apache.kafka.clients.admin.ConfigEntry(String, String, boolean, boolean, boolean) since 1.1.0. This constructor will be removed in a future release.
org.apache.kafka.common.metrics.JmxReporter(String) Since 2.6.0. Use JmxReporter() Initialize JmxReporter with JmxReporter.contextChange(MetricsContext) Populate prefix by adding _namespace/prefix key value pair to MetricsContext