org.creekservice.api.kafka.extension.config.KafkaPropertyOverrides Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022-2023 Creek Contributors (https://github.com/creek-service)
 *
 * 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 org.creekservice.api.kafka.extension.config;

import java.util.Map;
import java.util.Set;

/** A provider of Kafka client properties overrides */
public interface KafkaPropertyOverrides {

    /**
     * Initialize the overrides provider
     *
     * @param clusterNames the set of known Kafka cluster names.
     */
    default void init(Set clusterNames) {}

    /**
     * Get Kafka client property overrides for a cluster.
     *
     * @param clusterName the name of the cluster to get the overrides for.
     * @return property overrides.
     */
    Map get(String clusterName);
}