/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.kafka.common.requests;
import org.apache.kafka.common.network.NetworkSend;
import org.apache.kafka.common.network.Send;
import org.apache.kafka.common.protocol.ApiKeys;
import org.apache.kafka.common.protocol.types.Struct;
import java.nio.ByteBuffer;
public abstract class AbstractRequest extends AbstractRequestResponse {
public static abstract class Builder<T extends AbstractRequest> {
private final ApiKeys apiKey;
private final Short desiredVersion;
public Builder(ApiKeys apiKey) {
this(apiKey, null);
}
public Builder(ApiKeys apiKey, Short desiredVersion) {
this.apiKey = apiKey;
this.desiredVersion = desiredVersion;
}
public ApiKeys apiKey() {
return apiKey;
}
public short desiredOrLatestVersion() {
return desiredVersion == null ? apiKey.latestVersion() : desiredVersion;
}
public Short desiredVersion() {
return desiredVersion;
}
public T build() {
return build(desiredOrLatestVersion());
}
public abstract T build(short version);
}
private final short version;
public AbstractRequest(short version) {
this.version = version;
}
/**
* Get the version of this AbstractRequest object.
*/
public short version() {
return version;
}
public Send toSend(String destination, RequestHeader header) {
return new NetworkSend(destination, serialize(header));
}
/**
* Use with care, typically {@link #toSend(String, RequestHeader)} should be used instead.
*/
public ByteBuffer serialize(RequestHeader header) {
return serialize(header.toStruct(), toStruct());
}
protected abstract Struct toStruct();
public String toString(boolean verbose) {
return toStruct().toString();
}
@Override
public final String toString() {
return toString(true);
}
/**
* Get an error response for a request
*/
public AbstractResponse getErrorResponse(Throwable e) {
return getErrorResponse(AbstractResponse.DEFAULT_THROTTLE_TIME, e);
}
/**
* Get an error response for a request with specified throttle time in the response if applicable
*/
public abstract AbstractResponse getErrorResponse(int throttleTimeMs, Throwable e);
/**
* Factory method for getting a request object based on ApiKey ID and a buffer
*/
public static RequestAndSize getRequest(int requestId, short version, ByteBuffer buffer) {
ApiKeys apiKey = ApiKeys.forId(requestId);
Struct struct = apiKey.parseRequest(version, buffer);
AbstractRequest request;
switch (apiKey) {
case PRODUCE:
request = new ProduceRequest(struct, version);
break;
case FETCH:
request = new FetchRequest(struct, version);
break;
case LIST_OFFSETS:
request = new ListOffsetRequest(struct, version);
break;
case METADATA:
request = new MetadataRequest(struct, version);
break;
case OFFSET_COMMIT:
request = new OffsetCommitRequest(struct, version);
break;
case OFFSET_FETCH:
request = new OffsetFetchRequest(struct, version);
break;
case FIND_COORDINATOR:
request = new FindCoordinatorRequest(struct, version);
break;
case JOIN_GROUP:
request = new JoinGroupRequest(struct, version);
break;
case HEARTBEAT:
request = new HeartbeatRequest(struct, version);
break;
case LEAVE_GROUP:
request = new LeaveGroupRequest(struct, version);
break;
case SYNC_GROUP:
request = new SyncGroupRequest(struct, version);
break;
case STOP_REPLICA:
request = new StopReplicaRequest(struct, version);
break;
case CONTROLLED_SHUTDOWN_KEY:
request = new ControlledShutdownRequest(struct, version);
break;
case UPDATE_METADATA_KEY:
request = new UpdateMetadataRequest(struct, version);
break;
case LEADER_AND_ISR:
request = new LeaderAndIsrRequest(struct, version);
break;
case DESCRIBE_GROUPS:
request = new DescribeGroupsRequest(struct, version);
break;
case LIST_GROUPS:
request = new ListGroupsRequest(struct, version);
break;
case SASL_HANDSHAKE:
request = new SaslHandshakeRequest(struct, version);
break;
case API_VERSIONS:
request = new ApiVersionsRequest(struct, version);
break;
case CREATE_TOPICS:
request = new CreateTopicsRequest(struct, version);
break;
case DELETE_TOPICS:
request = new DeleteTopicsRequest(struct, version);
break;
case DELETE_RECORDS:
request = new DeleteRecordsRequest(struct, version);
break;
case INIT_PRODUCER_ID:
request = new InitProducerIdRequest(struct, version);
break;
case OFFSET_FOR_LEADER_EPOCH:
request = new OffsetsForLeaderEpochRequest(struct, version);
break;
case ADD_PARTITIONS_TO_TXN:
request = new AddPartitionsToTxnRequest(struct, version);
break;
case ADD_OFFSETS_TO_TXN:
request = new AddOffsetsToTxnRequest(struct, version);
break;
case END_TXN:
request = new EndTxnRequest(struct, version);
break;
case WRITE_TXN_MARKERS:
request = new WriteTxnMarkersRequest(struct, version);
break;
case TXN_OFFSET_COMMIT:
request = new TxnOffsetCommitRequest(struct, version);
break;
case DESCRIBE_ACLS:
request = new DescribeAclsRequest(struct, version);
break;
case CREATE_ACLS:
request = new CreateAclsRequest(struct, version);
break;
case DELETE_ACLS:
request = new DeleteAclsRequest(struct, version);
break;
case DESCRIBE_CONFIGS:
request = new DescribeConfigsRequest(struct, version);
break;
case ALTER_CONFIGS:
request = new AlterConfigsRequest(struct, version);
break;
default:
throw new AssertionError(String.format("ApiKey %s is not currently handled in `getRequest`, the " +
"code should be updated to do so.", apiKey));
}
return new RequestAndSize(request, struct.sizeOf());
}
}