This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • KIP-367 Introduce close(Duration) to Producer and AdminClient instead of close(long, TimeUnit)
Skip to end of metadata
Go to start of metadata

KIP-367 Introduce close(Duration) to Producer and AdminClient instead of close(long, TimeUnit)

This page is meant as a template for writing a KIP. To create a KIP choose Tools->Copy on this page and modify with your content and replace the heading with the next KIP number and a description of your issue. Replace anything in italics with your own description.

Status

Current state: Accepted

Discussion threadthread

JIRAKAFKA-7391

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

KIP-266 have replaced the (long, TimeUnit) by Duration for KafkaConsumer. For consistency, we should do the same APIs migration for KafkaProducer and KafkaAdminClient. 

Public Interfaces

KafkaProducer

KafkaProducer
@Deprecated
@Override
public void close(long timeout, TimeUnit timeUnit)


@Override
public void close(Duration timeout)

Producer

Producer
@Deprecated
void close(long timeout, TimeUnit unit);


void close(Duration timeout);


KafkaAdminClient

KafkaAdminClient
@Override
public void close(Duration timeout)


@Deprecated
public void close(long duration, TimeUnit unit)

Noted: the implementation of close(long, TimeUnit) will be placed at AdminClient.

AdminClient

AdminClient
@Deprecated
public abstract void close(long duration, TimeUnit unit)


public abstract void close(Duration timeout);

Noted: there is a default implementation of close(long, TimeUnit).


Proposed Changes

New Public methods are proposed. see Public Interfaces

In short, this KIP is going to deprecate close(long, TimeUnit) of KafkaProducer and KafkaAdminClient and add a replacement method - close(Duration)

Compatibility, Deprecation, and Migration Plan

No compatibility issues foreseen.

Rejected Alternatives

If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.


  • No labels