org.apache.kafka.common.protocol.Protocol Maven / Gradle / Ivy
/*
* 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.protocol;
import org.apache.kafka.common.message.RequestHeaderData;
import org.apache.kafka.common.message.ResponseHeaderData;
import org.apache.kafka.common.protocol.types.BoundField;
import org.apache.kafka.common.protocol.types.Schema;
import org.apache.kafka.common.protocol.types.TaggedFields;
import org.apache.kafka.common.protocol.types.Type;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
public class Protocol {
private static String indentString(int size) {
StringBuilder b = new StringBuilder(size);
for (int i = 0; i < size; i++)
b.append(" ");
return b.toString();
}
private static void schemaToBnfHtml(Schema schema, StringBuilder b, int indentSize) {
final String indentStr = indentString(indentSize);
final Map subTypes = new LinkedHashMap<>();
// Top level fields
for (BoundField field: schema.fields()) {
Type type = field.def.type;
if (type.isArray()) {
b.append("[");
b.append(field.def.name);
b.append("] ");
if (!subTypes.containsKey(field.def.name)) {
subTypes.put(field.def.name, type.arrayElementType().get());
}
} else if (type instanceof TaggedFields) {
b.append("TAG_BUFFER ");
} else {
b.append(field.def.name);
b.append(" ");
if (!subTypes.containsKey(field.def.name))
subTypes.put(field.def.name, type);
}
}
b.append("\n");
// Sub Types/Schemas
for (Map.Entry entry: subTypes.entrySet()) {
if (entry.getValue() instanceof Schema) {
// Complex Schema Type
b.append(indentStr);
b.append(entry.getKey());
b.append(" => ");
schemaToBnfHtml((Schema) entry.getValue(), b, indentSize + 2);
} else {
// Standard Field Type
b.append(indentStr);
b.append(entry.getKey());
b.append(" => ");
b.append(entry.getValue());
b.append("\n");
}
}
}
private static void populateSchemaFields(Schema schema, Set fields) {
for (BoundField field: schema.fields()) {
fields.add(field);
if (field.def.type.isArray()) {
Type innerType = field.def.type.arrayElementType().get();
if (innerType instanceof Schema)
populateSchemaFields((Schema) innerType, fields);
} else if (field.def.type instanceof Schema)
populateSchemaFields((Schema) field.def.type, fields);
}
}
private static void schemaToFieldTableHtml(Schema schema, StringBuilder b) {
Set fields = new LinkedHashSet<>();
populateSchemaFields(schema, fields);
b.append("\n");
b.append("");
b.append("Field \n");
b.append("Description \n");
b.append(" ");
for (BoundField field : fields) {
b.append("\n");
b.append("");
b.append(field.def.name);
b.append(" ");
b.append("");
b.append(field.def.docString);
b.append(" ");
b.append(" \n");
}
b.append("
\n");
}
public static String toHtml() {
final StringBuilder b = new StringBuilder();
b.append("Headers:
\n");
for (int i = 0; i < RequestHeaderData.SCHEMAS.length; i++) {
b.append("");
b.append("Request Header v").append(i).append(" => ");
schemaToBnfHtml(RequestHeaderData.SCHEMAS[i], b, 2);
b.append("\n");
schemaToFieldTableHtml(RequestHeaderData.SCHEMAS[i], b);
}
for (int i = 0; i < ResponseHeaderData.SCHEMAS.length; i++) {
b.append("");
b.append("Response Header v").append(i).append(" => ");
schemaToBnfHtml(ResponseHeaderData.SCHEMAS[i], b, 2);
b.append("\n");
schemaToFieldTableHtml(ResponseHeaderData.SCHEMAS[i], b);
}
for (ApiKeys key : ApiKeys.clientApis()) {
// Key
b.append("");
b.append("");
b.append(key.name);
b.append(" API (Key: ");
b.append(key.id);
b.append("):
\n\n");
// Requests
b.append("Requests:
\n");
Schema[] requests = key.messageType.requestSchemas();
for (int i = 0; i < requests.length; i++) {
Schema schema = requests[i];
// Schema
if (schema != null) {
b.append("");
// Version header
b.append("");
b.append(key.name);
b.append(" Request (Version: ");
b.append(i);
b.append(") => ");
schemaToBnfHtml(requests[i], b, 2);
b.append("");
schemaToFieldTableHtml(requests[i], b);
}
b.append("\n");
}
// Responses
b.append("Responses:
\n");
Schema[] responses = key.messageType.responseSchemas();
for (int i = 0; i < responses.length; i++) {
Schema schema = responses[i];
// Schema
if (schema != null) {
b.append("");
// Version header
b.append("");
b.append(key.name);
b.append(" Response (Version: ");
b.append(i);
b.append(") => ");
schemaToBnfHtml(responses[i], b, 2);
b.append("");
schemaToFieldTableHtml(responses[i], b);
}
b.append("\n");
}
}
return b.toString();
}
public static void main(String[] args) {
System.out.println(toHtml());
}
}