kafka-common-requests-AbstractRequest.adoc

AbstractRequest Contract

AbstractRequest is the extension of the AbstractRequestResponse contract for message requests.

AbstractRequest takes the following to be created:

• ApiKeys

• Version

Note	AbstractRequest is a Java abstract class and cannot be created directly. It is created indirectly for the concrete AbstractRequests.

Table 1. AbstractRequest Contract

Method	Description
getErrorResponse	AbstractResponse getErrorResponse( int throttleTimeMs, Throwable e) Used when…​FIXME
toStruct	Struct toStruct() Used when…​FIXME

Table 2. AbstractRequests (Direct Implementations and Extensions Only)

AbstractRequest	Description
AbstractControlRequest	Base of controller requests that KafkaController uses to propage broker and partition state changes to brokers
AddOffsetsToTxnRequest
AddPartitionsToTxnRequest
AlterConfigsRequest
AlterReplicaLogDirsRequest
ApiVersionsRequest
ControlledShutdownRequest
CreateAclsRequest
CreateDelegationTokenRequest
CreatePartitionsRequest
CreateTopicsRequest
DeleteAclsRequest
DeleteGroupsRequest
DeleteRecordsRequest
DeleteTopicsRequest
DescribeAclsRequest
DescribeConfigsRequest
DescribeDelegationTokenRequest
DescribeGroupsRequest
DescribeLogDirsRequest
ElectPreferredLeadersRequest
EndTxnRequest
ExpireDelegationTokenRequest
FetchRequest
FindCoordinatorRequest
HeartbeatRequest
IncrementalAlterConfigsRequest
InitProducerIdRequest
JoinGroupRequest
LeaderAndIsrRequest
LeaveGroupRequest
ListGroupsRequest
ListOffsetRequest
MetadataRequest
OffsetCommitRequest
OffsetFetchRequest
OffsetsForLeaderEpochRequest
ProduceRequest
RenewDelegationTokenRequest
SaslAuthenticateRequest
SaslHandshakeRequest
SyncGroupRequest
TxnOffsetCommitRequest
WriteTxnMarkersRequest

Creating AbstractRequest For API Key — parseRequest Factory Method

AbstractRequest parseRequest(
  ApiKeys apiKey,
  short apiVersion,
  Struct struct)

parseRequest simply creates a concrete AbstractRequest for the given ApiKeys.

Note	parseRequest is used exclusively when RequestContext is requested to parse a request.