org.apache.kafka.controller.ConfigurationValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kafka-metadata Show documentation

There is a newer version: 3.8.0

/*
 * 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.controller;

import org.apache.kafka.common.config.ConfigResource;

import java.util.Map;


public interface ConfigurationValidator {
    ConfigurationValidator NO_OP = new ConfigurationValidator() {
        @Override
        public void validate(ConfigResource resource) { }

        @Override
        public void validate(ConfigResource resource, Map config) { }
    };

    /**
     * Throws an ApiException if the given resource is invalid to describe.
     *
     * @param resource      The configuration resource.
     */
    void validate(ConfigResource resource);

    /**
     * Throws an ApiException if a configuration is invalid for the given resource.
     *
     * @param resource      The configuration resource.
     * @param config        The new configuration.
     */
    void validate(ConfigResource resource, Map config);
}