Package org.apache.kafka.clients.admin.internals

Class DescribeConsumerGroupsHandler

java.lang.Object

org.apache.kafka.clients.admin.internals.AdminApiHandler.Batched<CoordinatorKey,ConsumerGroupDescription>

org.apache.kafka.clients.admin.internals.DescribeConsumerGroupsHandler

All Implemented Interfaces:

AdminApiHandler<CoordinatorKey,ConsumerGroupDescription>

public class DescribeConsumerGroupsHandler
extends AdminApiHandler.Batched<CoordinatorKey,ConsumerGroupDescription>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.clients.admin.internals.AdminApiHandler

AdminApiHandler.ApiResult<K,V>, AdminApiHandler.Batched<K,V>, AdminApiHandler.RequestAndKeys<K>, AdminApiHandler.Unbatched<K,V>

Constructor Summary

Constructors

Constructor	Description
DescribeConsumerGroupsHandler(boolean includeAuthorizedOperations, org.apache.kafka.common.utils.LogContext logContext)

Method Summary

Modifier and Type	Method	Description
String	apiName()	Get a user-friendly name for the API this handler is implementing.
org.apache.kafka.common.requests.DescribeGroupsRequest.Builder	buildBatchedRequest(int coordinatorId, Set<CoordinatorKey> keys)
AdminApiHandler.ApiResult<CoordinatorKey,ConsumerGroupDescription>	handleResponse(org.apache.kafka.common.Node coordinator, Set<CoordinatorKey> groupIds, org.apache.kafka.common.requests.AbstractResponse abstractResponse)	Callback that is invoked when a request returns successfully.
AdminApiLookupStrategy<CoordinatorKey>	lookupStrategy()	Get the lookup strategy that is responsible for finding the brokerId which will handle each respective key.
static AdminApiFuture.SimpleAdminApiFuture<CoordinatorKey,ConsumerGroupDescription>	newFuture(Collection<String> groupIds)

Methods inherited from class org.apache.kafka.clients.admin.internals.AdminApiHandler.Batched

buildRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.kafka.clients.admin.internals.AdminApiHandler

handleUnsupportedVersionException

Constructor Details

DescribeConsumerGroupsHandler

public DescribeConsumerGroupsHandler(boolean includeAuthorizedOperations,
 org.apache.kafka.common.utils.LogContext logContext)

Method Details

newFuture

public static AdminApiFuture.SimpleAdminApiFuture<CoordinatorKey,ConsumerGroupDescription> newFuture(Collection<String> groupIds)

apiName

public String apiName()

Description copied from interface: AdminApiHandler

Get a user-friendly name for the API this handler is implementing.

lookupStrategy

public AdminApiLookupStrategy<CoordinatorKey> lookupStrategy()

Description copied from interface: AdminApiHandler

Get the lookup strategy that is responsible for finding the brokerId which will handle each respective key.

Returns:

non-null lookup strategy

buildBatchedRequest

public org.apache.kafka.common.requests.DescribeGroupsRequest.Builder buildBatchedRequest(int coordinatorId,
 Set<CoordinatorKey> keys)

handleResponse

public AdminApiHandler.ApiResult<CoordinatorKey,ConsumerGroupDescription> handleResponse(org.apache.kafka.common.Node coordinator,
 Set<CoordinatorKey> groupIds,
 org.apache.kafka.common.requests.AbstractResponse abstractResponse)

Description copied from interface: AdminApiHandler

Callback that is invoked when a request returns successfully. The handler should parse the response, check for errors, and return a result which indicates which keys (if any) have either been completed or failed with an unrecoverable error. It is also possible that the response indicates an incorrect target brokerId (e.g. in the case of a NotLeader error when the request is bound for a partition leader). In this case the key will be "unmapped" from the target brokerId and lookup will be retried. Note that keys which received a retriable error should be left out of the result. They will be retried automatically.

Parameters:

coordinator - the broker that the associated request was sent to

groupIds - the set of keys from the associated request

abstractResponse - the response received from the broker

Returns:

result indicating key completion, failure, and unmapping