AbstractKafkaSchemaSerDeConfig.java

/*
 * Copyright 2018 Confluent Inc.
 *
 * Licensed 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 io.confluent.kafka.serializers;

import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;

import io.confluent.kafka.serializers.context.NullContextNameStrategy;
import io.confluent.kafka.serializers.context.strategy.ContextNameStrategy;
import org.apache.kafka.common.config.AbstractConfig;
import org.apache.kafka.common.config.ConfigDef;
import org.apache.kafka.common.config.ConfigDef.Importance;
import org.apache.kafka.common.config.ConfigDef.Range;
import  org.apache.kafka.common.config.ConfigDef.Type;
import io.confluent.kafka.schemaregistry.client.SchemaRegistryClientConfig;
import io.confluent.kafka.serializers.subject.TopicNameStrategy;
import io.confluent.kafka.serializers.subject.strategy.SubjectNameStrategy;

/**
 * Base class for configs for serializers and deserializers, defining a few common configs and
 * defaults.
 */
public class AbstractKafkaSchemaSerDeConfig extends AbstractConfig {

  /**
   * Configurations beginning with this prefix can be used to specify headers to include in requests
   * made to Schema Registry. For example, to include an {@code Authorization} header with a value
   * of {@code Bearer NjksNDIw}, use the following configuration:
   * 
   * <p>{@code request.header.Authorization=Bearer NjksNDIw}
   */
  public static final String REQUEST_HEADER_PREFIX = "request.header.";

  public static final String SCHEMA_REGISTRY_URL_CONFIG = "schema.registry.url";
  public static final String
      SCHEMA_REGISTRY_URL_DOC =
      "Comma-separated list of URLs for schema registry instances that can be used to register "
      + "or look up schemas. "
      + "If you wish to get a connection to a mocked schema registry for testing, "
      + "you can specify a scope using the 'mock://' pseudo-protocol. For example, "
      + "'mock://my-scope-name' corresponds to "
      + "'MockSchemaRegistry.getClientForScope(\"my-scope-name\")'.";

  public static final String MAX_SCHEMAS_PER_SUBJECT_CONFIG = "max.schemas.per.subject";
  public static final int MAX_SCHEMAS_PER_SUBJECT_DEFAULT = 1000;
  public static final String MAX_SCHEMAS_PER_SUBJECT_DOC =
      "Maximum number of schemas to create or cache locally.";

  public static final String NORMALIZE_SCHEMAS = "normalize.schemas";
  public static final boolean NORMALIZE_SCHEMAS_DEFAULT = false;
  public static final String NORMALIZE_SCHEMAS_DOC =
      "Whether to normalize schemas, which generally ignores ordering when it is not significant";

  public static final String AUTO_REGISTER_SCHEMAS = "auto.register.schemas";
  public static final boolean AUTO_REGISTER_SCHEMAS_DEFAULT = true;
  public static final String AUTO_REGISTER_SCHEMAS_DOC =
      "Specify if the Serializer should attempt to register the Schema with Schema Registry";

  public static final String USE_SCHEMA_ID = "use.schema.id";
  public static final int USE_SCHEMA_ID_DEFAULT = -1;
  public static final String USE_SCHEMA_ID_DOC = "Schema ID to use for serialization";

  public static final String ID_COMPATIBILITY_STRICT = "id.compatibility.strict";
  public static final boolean ID_COMPATIBILITY_STRICT_DEFAULT = true;
  public static final String ID_COMPATIBILITY_STRICT_DOC =
      "Whether to check for backward compatibility between the schema with the given ID and "
      + " the schema of the object to be serialized";

  public static final String USE_LATEST_VERSION = "use.latest.version";
  public static final boolean USE_LATEST_VERSION_DEFAULT = false;
  public static final String USE_LATEST_VERSION_DOC =
      "Specify if the Serializer should use the latest subject version for serialization";

  public static final String LATEST_COMPATIBILITY_STRICT = "latest.compatibility.strict";
  public static final boolean LATEST_COMPATIBILITY_STRICT_DEFAULT = true;
  public static final String LATEST_COMPATIBILITY_STRICT_DOC =
      "Whether to check for backward compatibility between the latest subject version and "
      + " the schema of the object to be serialized";

  public static final String SCHEMA_FORMAT = "schema.format";
  public static final String SCHEMA_FORMAT_DOC =
      "The schema format to use when registering or looking up schemas.";

  public static final String BASIC_AUTH_CREDENTIALS_SOURCE = SchemaRegistryClientConfig
      .BASIC_AUTH_CREDENTIALS_SOURCE;
  public static final String BASIC_AUTH_CREDENTIALS_SOURCE_DEFAULT = "URL";
  public static final String BASIC_AUTH_CREDENTIALS_SOURCE_DOC =
      "Specify how to pick the credentials for Basic Auth header. "
      + "The supported values are URL, USER_INFO and SASL_INHERIT";

  public static final String BEARER_AUTH_CREDENTIALS_SOURCE = SchemaRegistryClientConfig
          .BEARER_AUTH_CREDENTIALS_SOURCE;
  public static final String BEARER_AUTH_CREDENTIALS_SOURCE_DEFAULT = "STATIC_TOKEN";
  public static final String BEARER_AUTH_CREDENTIALS_SOURCE_DOC =
          "Specify how to pick the credentials for Bearer Auth header. ";

  /**
   * @deprecated use {@link #USER_INFO_CONFIG} instead
   */
  @Deprecated
  public static final String SCHEMA_REGISTRY_USER_INFO_CONFIG =
      SchemaRegistryClientConfig.SCHEMA_REGISTRY_USER_INFO_CONFIG;
  public static final String SCHEMA_REGISTRY_USER_INFO_DEFAULT = "";
  public static final String SCHEMA_REGISTRY_USER_INFO_DOC =
      "Specify the user info for Basic Auth in the form of {username}:{password}";

  public static final String USER_INFO_CONFIG =
      SchemaRegistryClientConfig.USER_INFO_CONFIG;
  public static final String USER_INFO_DEFAULT = "";

  public static final String BEARER_AUTH_TOKEN_CONFIG = SchemaRegistryClientConfig
          .BEARER_AUTH_TOKEN_CONFIG;
  public static final String BEARER_AUTH_TOKEN_DEFAULT = "";
  public static final String BEARER_AUTH_TOKEN_DOC =
      "Specify the Bearer token to be used for authentication";
  public static final String BEARER_AUTH_ISSUER_ENDPOINT_URL = SchemaRegistryClientConfig
      .BEARER_AUTH_ISSUER_ENDPOINT_URL;
  public static final String BEARER_AUTH_ISSUER_ENDPOINT_URL_DOC = "The HTTP(S)-based URL for the "
      + "OAuth/OIDC identity provider which issues access token";
  public static final String BEARER_AUTH_CLIENT_ID = SchemaRegistryClientConfig
      .BEARER_AUTH_CLIENT_ID;
  public static final String BEARER_AUTH_CLIENT_ID_DOC = "Client Id used to obtain Client "
      + "Credentials Grant from OAuth/OIDC identity provider"
      + " <a href=\"rfc-editor.org/rfc/rfc6749.html#section-4.4\"> ";
  public static final String BEARER_AUTH_CLIENT_SECRET = SchemaRegistryClientConfig
      .BEARER_AUTH_CLIENT_SECRET;
  public static final String BEARER_AUTH_CLIENT_SECRET_DOC = "Client secret used to obtain Client "
      + "Credentials Grant from OAuth/OIDC identity provider "
      + "<a href=\"rfc-editor.org/rfc/rfc6749.html#section-4.4\"> ";
  public static final String BEARER_AUTH_SCOPE = SchemaRegistryClientConfig.BEARER_AUTH_SCOPE;
  public static final String BEARER_AUTH_SCOPE_DOC = "Access Token Scope used to obtain Client "
      + "Credentials Grant OAuth/OIDC identity provider "
      + "<a href=\"rfc-editor.org/rfc/rfc6749.html#section-3.3\"> ";
  public static final String BEARER_AUTH_SCOPE_CLAIM_NAME =
      SchemaRegistryClientConfig.BEARER_AUTH_SCOPE_CLAIM_NAME;
  public static final String DEFAULT_BEARER_AUTH_SCOPE_CLAIM_NAME =
      SchemaRegistryClientConfig.BEARER_AUTH_SCOPE_CLAIM_NAME_DEFAULT;
  public static final String BEARER_AUTH_SCOPE_CLAIM_NAME_DOC = "The OAuth claim for the scope "
      + "is often named \"" + DEFAULT_BEARER_AUTH_SCOPE_CLAIM_NAME + "\", but this (optional)"
      + " setting can provide a different name to use for the scope included in the JWT payload's"
      + " claims if the OAuth/OIDC provider uses a different"
      + " name for that claim.";
  public static final String BEARER_AUTH_SUB_CLAIM_NAME =
      SchemaRegistryClientConfig.BEARER_AUTH_SUB_CLAIM_NAME;
  public static final String DEFAULT_BEARER_AUTH_SUB_CLAIM_NAME =
      SchemaRegistryClientConfig.BEARER_AUTH_SUB_CLAIM_NAME_DEFAULT;
  public static final String BEARER_AUTH_SUB_CLAIM_NAME_DOC = "The OAuth claim for the subject is "
      + "often named \"" + DEFAULT_BEARER_AUTH_SUB_CLAIM_NAME + "\", but this (optional)"
      + " setting can provide a different name to use for the subject included in the JWT payload's"
      + " claims if the OAuth/OIDC provider uses a different name for that claim.";


  public static final String BEARER_AUTH_LOGICAL_CLUSTER = SchemaRegistryClientConfig
      .BEARER_AUTH_LOGICAL_CLUSTER;
  public static final String BEARER_AUTH_LOGICAL_CLUSTER_DOC = "Additional property which "
      + "can added in Request header to Schema Registry";
  public static final String BEARER_AUTH_IDENTITY_POOL_ID = SchemaRegistryClientConfig
      .BEARER_AUTH_IDENTITY_POOL_ID;
  public static final String BEARER_AUTH_IDENTITY_POOL_ID_DOC = "Additional property which "
      + "can added in Request header to Schema Registry. This maybe used as Principal Id for "
      + "Authorization";

  public static final String BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS =
      SchemaRegistryClientConfig.BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS;
  public static final Short BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DEFAULT =
      SchemaRegistryClientConfig.BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DEFAULT;
  public static final String BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DOC = "The amount of buffer "
      + "time between expiration times of the OAuth Token and corresponding cache which hold the "
      + "token. Ideally we would want to get a new token before the current one expires. Legal "
      + "values are between 0 and 3600 (1 hour); a default value of  300 (5 minutes) is used "
      + "if no value is specified. This value is ignored if it exceeds the remaining lifetime "
      + "of a token from the moment it is retrieved into schema registry.";

  public static final String BEARER_AUTH_CUSTOM_PROVIDER_CLASS = SchemaRegistryClientConfig
      .BEARER_AUTH_CUSTOM_PROVIDER_CLASS;
  public static final String BEARER_AUTH_CUSTOM_PROVIDER_CLASS_D0C =
      "Custom class which will provide the token credential. Needs to implement io.confluent.kafka"
          + ".schemaregistry.client.security.bearerauth.BearerAuthCredentialProvider interface";

  public static final String CONTEXT_NAME_STRATEGY = "context.name.strategy";
  public static final String CONTEXT_NAME_STRATEGY_DEFAULT =
      NullContextNameStrategy.class.getName();
  public static final String CONTEXT_NAME_STRATEGY_DOC =
      "A class used to determine the schema registry context.";

  public static final String KEY_SUBJECT_NAME_STRATEGY = "key.subject.name.strategy";
  public static final String KEY_SUBJECT_NAME_STRATEGY_DEFAULT =
      TopicNameStrategy.class.getName();
  public static final String KEY_SUBJECT_NAME_STRATEGY_DOC =
      "Determines how to construct the subject name under which the key schema is registered "
      + "with the schema registry. By default, <topic>-key is used as subject.";

  public static final String VALUE_SUBJECT_NAME_STRATEGY = "value.subject.name.strategy";
  public static final String VALUE_SUBJECT_NAME_STRATEGY_DEFAULT =
      TopicNameStrategy.class.getName();
  public static final String VALUE_SUBJECT_NAME_STRATEGY_DOC =
      "Determines how to construct the subject name under which the value schema is registered "
      + "with the schema registry. By default, <topic>-value is used as subject.";

  public static final String SCHEMA_REFLECTION_CONFIG = "schema.reflection";
  public static final boolean SCHEMA_REFLECTION_DEFAULT = false;
  public static final String SCHEMA_REFLECTION_DOC =
      "If true, uses the reflection API when serializing/deserializing ";

  public static final String PROXY_HOST = SchemaRegistryClientConfig.PROXY_HOST;
  public static final String PROXY_HOST_DEFAULT = "";
  public static final String PROXY_HOST_DOC =
      "The hostname, or address, of the proxy server that will be used to connect to the schema "
          + "registry instances.";

  public static final String PROXY_PORT = SchemaRegistryClientConfig.PROXY_PORT;
  public static final int PROXY_PORT_DEFAULT = -1;
  public static final String PROXY_PORT_DOC =
      "The port number of the proxy server that will be used to connect to the schema registry "
          + "instances.";

  public static ConfigDef baseConfigDef() {
    ConfigDef configDef = new ConfigDef()
        .define(SCHEMA_REGISTRY_URL_CONFIG, Type.LIST,
                Importance.HIGH, SCHEMA_REGISTRY_URL_DOC)
        .define(MAX_SCHEMAS_PER_SUBJECT_CONFIG, Type.INT, MAX_SCHEMAS_PER_SUBJECT_DEFAULT,
                Importance.LOW, MAX_SCHEMAS_PER_SUBJECT_DOC)
        .define(NORMALIZE_SCHEMAS, Type.BOOLEAN, NORMALIZE_SCHEMAS_DEFAULT,
                Importance.MEDIUM, NORMALIZE_SCHEMAS_DOC)
        .define(AUTO_REGISTER_SCHEMAS, Type.BOOLEAN, AUTO_REGISTER_SCHEMAS_DEFAULT,
                Importance.MEDIUM, AUTO_REGISTER_SCHEMAS_DOC)
        .define(USE_SCHEMA_ID, Type.INT, USE_SCHEMA_ID_DEFAULT,
                Importance.LOW, USE_SCHEMA_ID_DOC)
        .define(ID_COMPATIBILITY_STRICT, Type.BOOLEAN, ID_COMPATIBILITY_STRICT_DEFAULT,
                Importance.LOW, ID_COMPATIBILITY_STRICT_DOC)
        .define(USE_LATEST_VERSION, Type.BOOLEAN, USE_LATEST_VERSION_DEFAULT,
                Importance.LOW, USE_LATEST_VERSION_DOC)
        .define(LATEST_COMPATIBILITY_STRICT, Type.BOOLEAN, LATEST_COMPATIBILITY_STRICT_DEFAULT,
                Importance.LOW, LATEST_COMPATIBILITY_STRICT_DOC)
        .define(SCHEMA_FORMAT, Type.STRING, null,
                Importance.LOW, SCHEMA_FORMAT_DOC)
        .define(BASIC_AUTH_CREDENTIALS_SOURCE, Type.STRING, BASIC_AUTH_CREDENTIALS_SOURCE_DEFAULT,
                Importance.MEDIUM, BASIC_AUTH_CREDENTIALS_SOURCE_DOC)
        .define(BEARER_AUTH_CREDENTIALS_SOURCE, Type.STRING, BEARER_AUTH_CREDENTIALS_SOURCE_DEFAULT,
                Importance.MEDIUM, BEARER_AUTH_CREDENTIALS_SOURCE_DOC)
        .define(SCHEMA_REGISTRY_USER_INFO_CONFIG, Type.PASSWORD, SCHEMA_REGISTRY_USER_INFO_DEFAULT,
                Importance.MEDIUM, SCHEMA_REGISTRY_USER_INFO_DOC)
        .define(USER_INFO_CONFIG, Type.PASSWORD, USER_INFO_DEFAULT,
                Importance.MEDIUM, SCHEMA_REGISTRY_USER_INFO_DOC)
        .define(BEARER_AUTH_TOKEN_CONFIG, Type.PASSWORD, BEARER_AUTH_TOKEN_DEFAULT,
                Importance.MEDIUM, BEARER_AUTH_TOKEN_DOC)
        .define(BEARER_AUTH_ISSUER_ENDPOINT_URL, Type.STRING,null, Importance.MEDIUM,
                BEARER_AUTH_ISSUER_ENDPOINT_URL_DOC)
        .define(BEARER_AUTH_CLIENT_ID, Type.STRING,null, Importance.MEDIUM,
                BEARER_AUTH_CLIENT_ID_DOC)
        .define(BEARER_AUTH_CLIENT_SECRET, Type.STRING, null, Importance.MEDIUM,
                BEARER_AUTH_CLIENT_SECRET_DOC)
        .define(BEARER_AUTH_SCOPE, Type.STRING,null, Importance.MEDIUM ,
                BEARER_AUTH_SCOPE_DOC)
        .define(BEARER_AUTH_SCOPE_CLAIM_NAME, Type.STRING, DEFAULT_BEARER_AUTH_SCOPE_CLAIM_NAME,
                Importance.LOW, BEARER_AUTH_SCOPE_CLAIM_NAME_DOC)
        .define(BEARER_AUTH_SUB_CLAIM_NAME, Type.STRING, DEFAULT_BEARER_AUTH_SUB_CLAIM_NAME,
                Importance.LOW, BEARER_AUTH_SUB_CLAIM_NAME_DOC)
        .define(BEARER_AUTH_IDENTITY_POOL_ID, Type.STRING,null, Importance.MEDIUM,
                BEARER_AUTH_IDENTITY_POOL_ID_DOC)
        .define(BEARER_AUTH_LOGICAL_CLUSTER, Type.STRING,null, Importance.MEDIUM,
                BEARER_AUTH_LOGICAL_CLUSTER_DOC)
        .define(BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS,
                Type.SHORT, BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DEFAULT, Range.between(0, 3600),
                Importance.LOW,
                BEARER_AUTH_CACHE_EXPIRY_BUFFER_SECONDS_DOC)
        .define(BEARER_AUTH_CUSTOM_PROVIDER_CLASS, Type.STRING,null, Importance.MEDIUM,
            BEARER_AUTH_CUSTOM_PROVIDER_CLASS_D0C)
        .define(CONTEXT_NAME_STRATEGY, Type.CLASS, CONTEXT_NAME_STRATEGY_DEFAULT,
                Importance.MEDIUM, CONTEXT_NAME_STRATEGY_DOC)
        .define(KEY_SUBJECT_NAME_STRATEGY, Type.CLASS, KEY_SUBJECT_NAME_STRATEGY_DEFAULT,
                Importance.MEDIUM, KEY_SUBJECT_NAME_STRATEGY_DOC)
        .define(VALUE_SUBJECT_NAME_STRATEGY, Type.CLASS, VALUE_SUBJECT_NAME_STRATEGY_DEFAULT,
                Importance.MEDIUM, VALUE_SUBJECT_NAME_STRATEGY_DOC)
        .define(SCHEMA_REFLECTION_CONFIG, Type.BOOLEAN, SCHEMA_REFLECTION_DEFAULT,
                Importance.LOW, SCHEMA_REFLECTION_DOC)
        .define(PROXY_HOST, Type.STRING, PROXY_HOST_DEFAULT,
                Importance.LOW, PROXY_HOST_DOC)
        .define(PROXY_PORT, Type.INT, PROXY_PORT_DEFAULT,
                Importance.LOW, PROXY_PORT_DOC);
    SchemaRegistryClientConfig.withClientSslSupport(
        configDef, SchemaRegistryClientConfig.CLIENT_NAMESPACE);
    return configDef;
  }

  public AbstractKafkaSchemaSerDeConfig(ConfigDef config, Map<?, ?> props) {
    super(config, props);
  }

  public AbstractKafkaSchemaSerDeConfig(ConfigDef definition, Map<?, ?> originals, boolean doLog) {
    super(definition, originals, doLog);
  }

  public int getMaxSchemasPerSubject() {
    return this.getInt(MAX_SCHEMAS_PER_SUBJECT_CONFIG);
  }

  public List<String> getSchemaRegistryUrls() {
    return this.getList(SCHEMA_REGISTRY_URL_CONFIG);
  }

  public boolean normalizeSchema() {
    return this.getBoolean(NORMALIZE_SCHEMAS);
  }

  public boolean autoRegisterSchema() {
    return this.getBoolean(AUTO_REGISTER_SCHEMAS);
  }

  public int useSchemaId() {
    return this.getInt(USE_SCHEMA_ID);
  }

  public boolean getIdCompatibilityStrict() {
    return this.getBoolean(ID_COMPATIBILITY_STRICT);
  }

  public boolean useLatestVersion() {
    return this.getBoolean(USE_LATEST_VERSION);
  }

  public boolean getLatestCompatibilityStrict() {
    return this.getBoolean(LATEST_COMPATIBILITY_STRICT);
  }

  public String getSchemaFormat() {
    return this.getString(SCHEMA_FORMAT);
  }

  public ContextNameStrategy contextNameStrategy() {
    return this.getConfiguredInstance(CONTEXT_NAME_STRATEGY, ContextNameStrategy.class);
  }

  public Object keySubjectNameStrategy() {
    return subjectNameStrategyInstance(KEY_SUBJECT_NAME_STRATEGY);
  }

  public Object valueSubjectNameStrategy() {
    return subjectNameStrategyInstance(VALUE_SUBJECT_NAME_STRATEGY);
  }

  public boolean useSchemaReflection() {
    return this.getBoolean(SCHEMA_REFLECTION_CONFIG);
  }

  public Map<String, String> requestHeaders() {
    return originalsWithPrefix(REQUEST_HEADER_PREFIX).entrySet().stream()
        .collect(Collectors.toMap(Map.Entry::getKey, entry -> Objects.toString(entry.getValue())));
  }

  private Object subjectNameStrategyInstance(String config) {
    Class subjectNameStrategyClass = this.getClass(config);
    Class deprecatedClass = io.confluent.kafka.serializers.subject.SubjectNameStrategy.class;
    if (deprecatedClass.isAssignableFrom(subjectNameStrategyClass)) {
      return this.getConfiguredInstance(config, deprecatedClass);
    }
    return this.getConfiguredInstance(config, SubjectNameStrategy.class);
  }

  public String basicAuthUserInfo() {
    String deprecatedValue = getString(SCHEMA_REGISTRY_USER_INFO_CONFIG);
    if (deprecatedValue != null && !deprecatedValue.isEmpty()) {
      return deprecatedValue;
    }
    return getString(USER_INFO_CONFIG);
  }
}