Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.kafka.common.requests.DescribeConfigsResponse 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.requests;
import org.apache.kafka.common.config.ConfigResource;
import org.apache.kafka.common.protocol.ApiKeys;
import org.apache.kafka.common.protocol.Errors;
import org.apache.kafka.common.protocol.types.ArrayOf;
import org.apache.kafka.common.protocol.types.Field;
import org.apache.kafka.common.protocol.types.Schema;
import org.apache.kafka.common.protocol.types.Struct;
import java.nio.ByteBuffer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import static org.apache.kafka.common.protocol.CommonFields.ERROR_CODE;
import static org.apache.kafka.common.protocol.CommonFields.ERROR_MESSAGE;
import static org.apache.kafka.common.protocol.CommonFields.THROTTLE_TIME_MS;
import static org.apache.kafka.common.protocol.types.Type.BOOLEAN;
import static org.apache.kafka.common.protocol.types.Type.INT8;
import static org.apache.kafka.common.protocol.types.Type.NULLABLE_STRING;
import static org.apache.kafka.common.protocol.types.Type.STRING;
public class DescribeConfigsResponse extends AbstractResponse {
private static final String RESOURCES_KEY_NAME = "resources";
private static final String RESOURCE_TYPE_KEY_NAME = "resource_type";
private static final String RESOURCE_NAME_KEY_NAME = "resource_name";
private static final String CONFIG_ENTRIES_KEY_NAME = "config_entries";
private static final String CONFIG_NAME_KEY_NAME = "config_name";
private static final String CONFIG_VALUE_KEY_NAME = "config_value";
private static final String IS_SENSITIVE_KEY_NAME = "is_sensitive";
private static final String IS_DEFAULT_KEY_NAME = "is_default";
private static final String READ_ONLY_KEY_NAME = "read_only";
private static final String CONFIG_SYNONYMS_KEY_NAME = "config_synonyms";
private static final String CONFIG_SOURCE_KEY_NAME = "config_source";
private static final Schema DESCRIBE_CONFIGS_RESPONSE_ENTRY_V0 = new Schema(
new Field(CONFIG_NAME_KEY_NAME, STRING),
new Field(CONFIG_VALUE_KEY_NAME, NULLABLE_STRING),
new Field(READ_ONLY_KEY_NAME, BOOLEAN),
new Field(IS_DEFAULT_KEY_NAME, BOOLEAN),
new Field(IS_SENSITIVE_KEY_NAME, BOOLEAN));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_SYNONYM_V1 = new Schema(
new Field(CONFIG_NAME_KEY_NAME, STRING),
new Field(CONFIG_VALUE_KEY_NAME, NULLABLE_STRING),
new Field(CONFIG_SOURCE_KEY_NAME, INT8));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_ENTRY_V1 = new Schema(
new Field(CONFIG_NAME_KEY_NAME, STRING),
new Field(CONFIG_VALUE_KEY_NAME, NULLABLE_STRING),
new Field(READ_ONLY_KEY_NAME, BOOLEAN),
new Field(CONFIG_SOURCE_KEY_NAME, INT8),
new Field(IS_SENSITIVE_KEY_NAME, BOOLEAN),
new Field(CONFIG_SYNONYMS_KEY_NAME, new ArrayOf(DESCRIBE_CONFIGS_RESPONSE_SYNONYM_V1)));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_ENTITY_V0 = new Schema(
ERROR_CODE,
ERROR_MESSAGE,
new Field(RESOURCE_TYPE_KEY_NAME, INT8),
new Field(RESOURCE_NAME_KEY_NAME, STRING),
new Field(CONFIG_ENTRIES_KEY_NAME, new ArrayOf(DESCRIBE_CONFIGS_RESPONSE_ENTRY_V0)));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_ENTITY_V1 = new Schema(
ERROR_CODE,
ERROR_MESSAGE,
new Field(RESOURCE_TYPE_KEY_NAME, INT8),
new Field(RESOURCE_NAME_KEY_NAME, STRING),
new Field(CONFIG_ENTRIES_KEY_NAME, new ArrayOf(DESCRIBE_CONFIGS_RESPONSE_ENTRY_V1)));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_V0 = new Schema(
THROTTLE_TIME_MS,
new Field(RESOURCES_KEY_NAME, new ArrayOf(DESCRIBE_CONFIGS_RESPONSE_ENTITY_V0)));
private static final Schema DESCRIBE_CONFIGS_RESPONSE_V1 = new Schema(
THROTTLE_TIME_MS,
new Field(RESOURCES_KEY_NAME, new ArrayOf(DESCRIBE_CONFIGS_RESPONSE_ENTITY_V1)));
/**
* The version number is bumped to indicate that on quota violation brokers send out responses before throttling.
*/
private static final Schema DESCRIBE_CONFIGS_RESPONSE_V2 = DESCRIBE_CONFIGS_RESPONSE_V1;
public static Schema[] schemaVersions() {
return new Schema[]{DESCRIBE_CONFIGS_RESPONSE_V0, DESCRIBE_CONFIGS_RESPONSE_V1, DESCRIBE_CONFIGS_RESPONSE_V2};
}
public static class Config {
private final ApiError error;
private final Collection entries;
public Config(ApiError error, Collection entries) {
this.error = Objects.requireNonNull(error, "error");
this.entries = Objects.requireNonNull(entries, "entries");
}
public ApiError error() {
return error;
}
public Collection entries() {
return entries;
}
}
public static class ConfigEntry {
private final String name;
private final String value;
private final boolean isSensitive;
private final ConfigSource source;
private final boolean readOnly;
private final Collection synonyms;
public ConfigEntry(String name, String value, ConfigSource source, boolean isSensitive, boolean readOnly,
Collection synonyms) {
this.name = Objects.requireNonNull(name, "name");
this.value = value;
this.source = Objects.requireNonNull(source, "source");
this.isSensitive = isSensitive;
this.readOnly = readOnly;
this.synonyms = Objects.requireNonNull(synonyms, "synonyms");
}
public String name() {
return name;
}
public String value() {
return value;
}
public boolean isSensitive() {
return isSensitive;
}
public ConfigSource source() {
return source;
}
public boolean isReadOnly() {
return readOnly;
}
public Collection synonyms() {
return synonyms;
}
}
public enum ConfigSource {
UNKNOWN_CONFIG((byte) 0),
TOPIC_CONFIG((byte) 1),
DYNAMIC_BROKER_CONFIG((byte) 2),
DYNAMIC_DEFAULT_BROKER_CONFIG((byte) 3),
STATIC_BROKER_CONFIG((byte) 4),
DEFAULT_CONFIG((byte) 5),
DYNAMIC_BROKER_LOGGER_CONFIG((byte) 6);
final byte id;
private static final ConfigSource[] VALUES = values();
ConfigSource(byte id) {
this.id = id;
}
public static ConfigSource forId(byte id) {
if (id < 0)
throw new IllegalArgumentException("id should be positive, id: " + id);
if (id >= VALUES.length)
return UNKNOWN_CONFIG;
return VALUES[id];
}
}
public static class ConfigSynonym {
private final String name;
private final String value;
private final ConfigSource source;
public ConfigSynonym(String name, String value, ConfigSource source) {
this.name = Objects.requireNonNull(name, "name");
this.value = value;
this.source = Objects.requireNonNull(source, "source");
}
public String name() {
return name;
}
public String value() {
return value;
}
public ConfigSource source() {
return source;
}
}
private final int throttleTimeMs;
private final Map configs;
public DescribeConfigsResponse(int throttleTimeMs, Map configs) {
this.throttleTimeMs = throttleTimeMs;
this.configs = Objects.requireNonNull(configs, "configs");
}
public DescribeConfigsResponse(Struct struct) {
throttleTimeMs = struct.get(THROTTLE_TIME_MS);
Object[] resourcesArray = struct.getArray(RESOURCES_KEY_NAME);
configs = new HashMap<>(resourcesArray.length);
for (Object resourceObj : resourcesArray) {
Struct resourceStruct = (Struct) resourceObj;
ApiError error = new ApiError(resourceStruct);
ConfigResource.Type resourceType = ConfigResource.Type.forId(resourceStruct.getByte(RESOURCE_TYPE_KEY_NAME));
String resourceName = resourceStruct.getString(RESOURCE_NAME_KEY_NAME);
ConfigResource resource = new ConfigResource(resourceType, resourceName);
Object[] configEntriesArray = resourceStruct.getArray(CONFIG_ENTRIES_KEY_NAME);
List configEntries = new ArrayList<>(configEntriesArray.length);
for (Object configEntriesObj: configEntriesArray) {
Struct configEntriesStruct = (Struct) configEntriesObj;
String configName = configEntriesStruct.getString(CONFIG_NAME_KEY_NAME);
String configValue = configEntriesStruct.getString(CONFIG_VALUE_KEY_NAME);
boolean isSensitive = configEntriesStruct.getBoolean(IS_SENSITIVE_KEY_NAME);
ConfigSource configSource;
if (configEntriesStruct.hasField(CONFIG_SOURCE_KEY_NAME))
configSource = ConfigSource.forId(configEntriesStruct.getByte(CONFIG_SOURCE_KEY_NAME));
else if (configEntriesStruct.hasField(IS_DEFAULT_KEY_NAME)) {
if (configEntriesStruct.getBoolean(IS_DEFAULT_KEY_NAME))
configSource = ConfigSource.DEFAULT_CONFIG;
else {
switch (resourceType) {
case BROKER:
configSource = ConfigSource.STATIC_BROKER_CONFIG;
break;
case TOPIC:
configSource = ConfigSource.TOPIC_CONFIG;
break;
default:
configSource = ConfigSource.UNKNOWN_CONFIG;
break;
}
}
} else
throw new IllegalStateException("Config entry should contain either is_default or config_source");
boolean readOnly = configEntriesStruct.getBoolean(READ_ONLY_KEY_NAME);
Collection synonyms;
if (configEntriesStruct.hasField(CONFIG_SYNONYMS_KEY_NAME)) {
Object[] synonymsArray = configEntriesStruct.getArray(CONFIG_SYNONYMS_KEY_NAME);
synonyms = new ArrayList<>(synonymsArray.length);
for (Object synonymObj: synonymsArray) {
Struct synonymStruct = (Struct) synonymObj;
String synonymConfigName = synonymStruct.getString(CONFIG_NAME_KEY_NAME);
String synonymConfigValue = synonymStruct.getString(CONFIG_VALUE_KEY_NAME);
ConfigSource source = ConfigSource.forId(synonymStruct.getByte(CONFIG_SOURCE_KEY_NAME));
synonyms.add(new ConfigSynonym(synonymConfigName, synonymConfigValue, source));
}
} else
synonyms = Collections.emptyList();
configEntries.add(new ConfigEntry(configName, configValue, configSource, isSensitive, readOnly, synonyms));
}
Config config = new Config(error, configEntries);
configs.put(resource, config);
}
}
public Map configs() {
return configs;
}
public Config config(ConfigResource resource) {
return configs.get(resource);
}
@Override
public int throttleTimeMs() {
return throttleTimeMs;
}
@Override
public Map errorCounts() {
Map errorCounts = new HashMap<>();
for (Config response : configs.values())
updateErrorCounts(errorCounts, response.error.error());
return errorCounts;
}
@Override
protected Struct toStruct(short version) {
Struct struct = new Struct(ApiKeys.DESCRIBE_CONFIGS.responseSchema(version));
struct.set(THROTTLE_TIME_MS, throttleTimeMs);
List resourceStructs = new ArrayList<>(configs.size());
for (Map.Entry entry : configs.entrySet()) {
Struct resourceStruct = struct.instance(RESOURCES_KEY_NAME);
ConfigResource resource = entry.getKey();
resourceStruct.set(RESOURCE_TYPE_KEY_NAME, resource.type().id());
resourceStruct.set(RESOURCE_NAME_KEY_NAME, resource.name());
Config config = entry.getValue();
config.error.write(resourceStruct);
List configEntryStructs = new ArrayList<>(config.entries.size());
for (ConfigEntry configEntry : config.entries) {
Struct configEntriesStruct = resourceStruct.instance(CONFIG_ENTRIES_KEY_NAME);
configEntriesStruct.set(CONFIG_NAME_KEY_NAME, configEntry.name);
configEntriesStruct.set(CONFIG_VALUE_KEY_NAME, configEntry.value);
configEntriesStruct.set(IS_SENSITIVE_KEY_NAME, configEntry.isSensitive);
configEntriesStruct.setIfExists(CONFIG_SOURCE_KEY_NAME, configEntry.source.id);
configEntriesStruct.setIfExists(IS_DEFAULT_KEY_NAME, configEntry.source == ConfigSource.DEFAULT_CONFIG);
configEntriesStruct.set(READ_ONLY_KEY_NAME, configEntry.readOnly);
configEntryStructs.add(configEntriesStruct);
if (configEntriesStruct.hasField(CONFIG_SYNONYMS_KEY_NAME)) {
List configSynonymStructs = new ArrayList<>(configEntry.synonyms.size());
for (ConfigSynonym synonym : configEntry.synonyms) {
Struct configSynonymStruct = configEntriesStruct.instance(CONFIG_SYNONYMS_KEY_NAME);
configSynonymStruct.set(CONFIG_NAME_KEY_NAME, synonym.name);
configSynonymStruct.set(CONFIG_VALUE_KEY_NAME, synonym.value);
configSynonymStruct.set(CONFIG_SOURCE_KEY_NAME, synonym.source.id);
configSynonymStructs.add(configSynonymStruct);
}
configEntriesStruct.set(CONFIG_SYNONYMS_KEY_NAME, configSynonymStructs.toArray(new Struct[0]));
}
}
resourceStruct.set(CONFIG_ENTRIES_KEY_NAME, configEntryStructs.toArray(new Struct[0]));
resourceStructs.add(resourceStruct);
}
struct.set(RESOURCES_KEY_NAME, resourceStructs.toArray(new Struct[0]));
return struct;
}
public static DescribeConfigsResponse parse(ByteBuffer buffer, short version) {
return new DescribeConfigsResponse(ApiKeys.DESCRIBE_CONFIGS.parseResponse(version, buffer));
}
@Override
public boolean shouldClientThrottle(short version) {
return version >= 2;
}
}
