wayang-platforms/wayang-flink/src/main/java/org/apache/wayang/flink/execution/FlinkContextReference.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.wayang.flink.execution;

import org.apache.flink.api.common.ExecutionMode;
import org.apache.flink.api.java.ExecutionEnvironment;
import org.apache.flink.api.java.utils.ParameterTool;
import org.apache.wayang.core.api.Configuration;
import org.apache.wayang.core.platform.CrossPlatformExecutor;
import org.apache.wayang.core.platform.ExecutionResourceTemplate;

/**
 * Wraps and manages a Flink {@link ExecutionEnvironment} to avoid steady re-creation.
 */
public class FlinkContextReference extends ExecutionResourceTemplate {
    /**
     * The wrapped {@link ExecutionEnvironment}.
     */
    private ExecutionEnvironment flinkEnviroment;

    /**
     * Creates a new instance.
     *
     * @param flinkEnviroment the {@link ExecutionEnvironment} to be wrapped
     */
    public FlinkContextReference(CrossPlatformExecutor crossPlatformExecutor, ExecutionEnvironment flinkEnviroment, int parallelism) {
        super(null);
        if (crossPlatformExecutor != null) {
            crossPlatformExecutor.registerGlobal(this);
        }
        this.flinkEnviroment = flinkEnviroment;
        loadConfiguration( crossPlatformExecutor.getConfiguration(), parallelism );
    }


    /**
     * Provides the {@link ExecutionEnvironment}. This instance must not be disposed, yet.
     *
     * @return the wrapped {@link ExecutionEnvironment}
     */
    public ExecutionEnvironment get() {
        return this.flinkEnviroment;
    }

    @Override
    protected void doDispose() throws Throwable {

    }

    @Override
    public boolean isDisposed() {
        return false;
    }

    private void loadConfiguration(Configuration conf, int parallelism){
        ParameterTool tools = ParameterTool.fromSystemProperties();
        this.flinkEnviroment.getConfig().setGlobalJobParameters(tools);
        this.flinkEnviroment.setParallelism(parallelism);

        ExecutionMode mode = getExecutionMode(conf.getStringProperty("wayang.flink.mode.execution"));

        this.flinkEnviroment.getConfig().setExecutionMode(mode);
    }

    private ExecutionMode getExecutionMode(String name){
        ExecutionMode mode;
        switch (name){
            case "batch_forced":
                mode = ExecutionMode.BATCH_FORCED;
                break;
            case "batch":
                mode = ExecutionMode.BATCH;
                break;
            case "pipelined":
                mode = ExecutionMode.PIPELINED;
                break;
            case "pipelined_forced":
                mode = ExecutionMode.PIPELINED_FORCED;
                break;
            default:
                mode = ExecutionMode.BATCH_FORCED;
                break;
        }
        return mode;
    }
}