wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/monitor/Monitor.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.core.monitor;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.wayang.core.api.Configuration;

public abstract class Monitor {

    protected HashMap<String, Integer> progress = new HashMap<>();
    protected List<Map> initialExecutionPlan;
    protected String exPlanUrl;
    protected String progressUrl;
    protected String runId;

    public static Boolean isEnabled(Configuration config) {
        return config.getBooleanProperty(MONITOR_ENABLED_PROPERTY_KEY, false);
    }
    public abstract void initialize(Configuration config, String runId, List<Map> initialExecutionPlan) throws IOException;

    public abstract void updateProgress(HashMap<String, Integer> partialProgress) throws IOException;

    public static final String DEFAULT_MONITOR_BASE_URL = "file:///var/tmp/wayang/runs";
    public static final String DEFAULT_MONITOR_BASE_URL_PROPERTY_KEY = "wayang.core.monitor.baseurl";
    public static final String MONITOR_ENABLED_PROPERTY_KEY = "wayang.core.monitor.enabled";
}