flink-table/flink-table-api-java-bridge/src/main/java/org/apache/flink/table/factories/StreamTableSourceFactory.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.flink.table.factories;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.connector.source.DynamicTableSource;
import org.apache.flink.table.sources.StreamTableSource;
import org.apache.flink.table.sources.TableSource;

import java.util.Map;

/**
 * A factory to create configured table source instances in a streaming environment based on
 * string-based properties. See also {@link TableSourceFactory} for more information.
 *
 * @param <T> type of records that the factory produces
 * @deprecated This interface has been replaced by {@link DynamicTableSourceFactory}. The new
 *     interface creates instances of {@link DynamicTableSource} and only works with the Blink
 *     planner. See FLIP-95 for more information.
 */
@Deprecated
@PublicEvolving
public interface StreamTableSourceFactory<T> extends TableSourceFactory<T> {

    /**
     * Creates and configures a {@link StreamTableSource} using the given properties.
     *
     * @param properties normalized properties describing a stream table source.
     * @return the configured stream table source.
     * @deprecated {@link Context} contains more information, and already contains table schema too.
     *     Please use {@link #createTableSource(Context)} instead.
     */
    @Deprecated
    default StreamTableSource<T> createStreamTableSource(Map<String, String> properties) {
        return null;
    }

    /** Only create a stream table source. */
    @Override
    default TableSource<T> createTableSource(Map<String, String> properties) {
        StreamTableSource<T> source = createStreamTableSource(properties);
        if (source == null) {
            throw new ValidationException("Please override 'createTableSource(Context)' method.");
        }
        return source;
    }
}