seatunnel-core/seatunnel-core-starter/src/main/java/org/apache/seatunnel/core/starter/config/ConfigChecker.java

/*
 * 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.seatunnel.core.starter.config;

import org.apache.seatunnel.apis.base.env.RuntimeEnv;
import org.apache.seatunnel.core.starter.exception.ConfigCheckException;

import org.apache.seatunnel.shade.com.typesafe.config.Config;

/**
 * Check the config is valid.
 *
 * @param <ENVIRONMENT> the environment type.
 */
public interface ConfigChecker<ENVIRONMENT extends RuntimeEnv> {

    /**
     * Check if the config is validated, if check fails, throw exception.
     *
     * @param config given config.
     */
    void checkConfig(Config config) throws ConfigCheckException;

}