org.apache.flink.cdc.common.source.FlinkSourceFunctionProvider Maven / Gradle / Ivy

Go to download
/*
 * 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.cdc.common.source;

import org.apache.flink.cdc.common.annotation.PublicEvolving;
import org.apache.flink.cdc.common.event.Event;
import org.apache.flink.streaming.api.functions.source.SourceFunction;

/**
 * {@code FlinkSourceFunctionProvider} is used to provide a Flink {@link SourceFunction} for reading
 * events from external systems.
 */
@PublicEvolving
public interface FlinkSourceFunctionProvider extends EventSourceProvider {

    /** Get the {@link SourceFunction} for reading events from external systems. */
    SourceFunction getSourceFunction();

    /** Create a {@link FlinkSourceFunctionProvider} from a {@link SourceFunction}. */
    static FlinkSourceFunctionProvider of(SourceFunction sourceFunction) {
        return () -> sourceFunction;
    }
}