com.aliyun.odps.Task Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odps-sdk-core Show documentation
There is a newer version: 0.51.5-public
/*
 * 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 com.aliyun.odps;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import com.aliyun.odps.commons.util.OSUtils;
import com.aliyun.odps.commons.util.SvnRevisionUtils;
import com.aliyun.odps.rest.SimpleXmlUtils;
import com.aliyun.odps.simpleframework.xml.Element;
import com.aliyun.odps.simpleframework.xml.ElementList;
import com.aliyun.odps.simpleframework.xml.Order;
import com.aliyun.odps.simpleframework.xml.Root;
import com.aliyun.odps.simpleframework.xml.convert.Convert;
import com.aliyun.odps.simpleframework.xml.convert.Converter;
import com.aliyun.odps.simpleframework.xml.stream.InputNode;
import com.aliyun.odps.simpleframework.xml.stream.OutputNode;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;


/**
 * ODPS的Task定义
 *
 * @author [email protected]
 */
public abstract class Task {
  /**
   * Global settings set by users, will be applied to every single task. The priority of global
   * settings is the lowest and will not overwrite any other settings.
   */
  private static Map GLOBAL_SETTINGS = new HashMap<>();
  /**
   * System settings, must not be modified by users
   */
  private static final Map SYSTEM_SETTINGS = new HashMap<>();
  static {
    SYSTEM_SETTINGS.put(
        "odps.idata.userenv",
        "JavaSDK Revision:" + SvnRevisionUtils.getSvnRevision() +
        ",Version:" + SvnRevisionUtils.getMavenVersion() +
        ",JavaVersion:" + SvnRevisionUtils.getJavaVersion() +
        ",IP:" + OSUtils.getIpAddress() +
        ",MAC:" + OSUtils.getMacAddress());
  }

  /**
   * Task property
   */
  @Root(name = "Property", strict = false)
  @Order(elements = {"Name", "Value"})
  public static class Property {

    @Element(name = "Name")
    @Convert(SimpleXmlUtils.EmptyStringConverter.class)
    private String name;

    @Element(name = "Value")
    @Convert(SimpleXmlUtils.EmptyStringConverter.class)
    private String value;

    Property() {
    }

    /**
     * 构造一个新的{@link Property}实例。
     *
     * @param name
     *     属性名，不能为null。
     * @param value
     *     属性值。
     */
    public Property(String name, String value) {
      setName(name);
      setValue(value);
    }

    /**
     * 返回属性名。
     *
     * @return 属性名。
     */
    public String getName() {
      return name;
    }

    /**
     * 设置属性值。
     *
     * @param name
     *     属性名。不能为null。
     */
    public void setName(String name) {
      this.name = name;
    }

    /**
     * 返回属性值。
     *
     * @return 属性值。
     */
    public String getValue() {
      return value;
    }

    /**
     * 设置属性值。
     *
     * @param value
     *     属性值。
     */
    public void setValue(String value) {
      this.value = value;
    }
  }

  /**
   * Task properties
   */
  @Root(name = "Config", strict = false)
  public static class Properties {

    Set properties = new LinkedHashSet<>();

    @ElementList(entry = "Property", inline = true, required = false)
    private List getPropertyList() {
      return new ArrayList<>(properties);
    }

    @ElementList(entry = "Property", inline = true, required = false)
    private void setPropertyList(List propertyList) {
      properties = new LinkedHashSet<>(propertyList);
    }

    public void addProperty(Property property) {
      properties.add(property);
    }

    public void removeProperty(Property property) {
      properties.remove(property);
    }
  }

  static class PropertyConverter implements Converter> {
    @Override
    public void write(OutputNode outputNode, LinkedHashMap properties) throws Exception {
      for (Entry entry : properties.entrySet()) {
        String name = entry.getKey();
        String value = entry.getValue();
        SimpleXmlUtils.marshal(new Project.Property(name, value), outputNode);
      }

      outputNode.commit();
    }

    @Override
    public LinkedHashMap read(InputNode inputNode) throws Exception {
      LinkedHashMap properties = new LinkedHashMap();
      Project.Properties props = SimpleXmlUtils.unmarshal(inputNode, Project.Properties.class);
      for (Project.Property entry : props.entries) {
        properties.put(entry.name, entry.value);
      }
      return properties;
    }
  }

  @Element(name = "Name", required = false)
  @Convert(SimpleXmlUtils.EmptyStringConverter.class)
  private String name;

  @Element(name = "Comment", required = false)
  @Convert(SimpleXmlUtils.EmptyStringConverter.class)
  private String comment;

  @Element(name = "Config", required = false)
  @Convert(PropertyConverter.class)
  private LinkedHashMap properties = new LinkedHashMap();

  /**
   * 获取{@link Task}的名称
   *
   * @return Task名称
   */
  public String getName() {
    return name;
  }

  /**
   * 设置{@link Task}的名称
   *
   * @param name
   *     Task名称
   */
  public void setName(String name) {
    this.name = name;
  }

  /**
   * 获取注释信息
   *
   * @return 注释信息
   */
  public String getComment() {
    return comment;
  }

  /**
   * 设置注释信息
   *
   * @param comment
   *     注释信息
   */
  public void setComment(String comment) {
    this.comment = comment;
  }

  /**
   * 获取所有配置信息
   *
   * @return 配置信息
   */
  public final Map getProperties() {
    LinkedHashMap map = new LinkedHashMap();
    map.putAll(properties);
    return map;
  }

  /**
   * 设置所有配置信息
   *
   * @param properties
   *     配置项名称
   */
  public final void setProperties(Map properties) {
    this.properties = new LinkedHashMap<>();
    this.properties.putAll(properties);
  }

  /**
   * 设置配置
   *
   * @param name
   *     配置项名称
   * @param value
   *     配置项的值
   */
  public void setProperty(String name, String value) {
    properties.put(name, value);
  }

  /**
   * 获取 Task 命令信息
   *
   * @return Task 命令信息
   */
  public String getCommandText() {
    return getProperties().getOrDefault("commandText", "");
  }

  static Map getGlobalSettings() {
    return new HashMap<>(GLOBAL_SETTINGS);
  }

  static void setGlobalSettings(Map globalSettings) {
    GLOBAL_SETTINGS = globalSettings;
  }

  void loadSystemSettings() {
    JsonObject settings;
    if (properties.containsKey("settings")) {
      JsonParser parser = new JsonParser();
      settings = parser.parse(properties.get("settings")).getAsJsonObject();
    } else {
      settings = new JsonObject();
    }
    for (Entry setting : SYSTEM_SETTINGS.entrySet()) {
      settings.addProperty(setting.getKey(), setting.getValue());
    }

    properties.put("settings", settings.toString());
  }

  void loadGlobalSettings() {
    JsonObject settings;
    if (properties.containsKey("settings")) {
      JsonParser parser = new JsonParser();
      settings = parser.parse(properties.get("settings")).getAsJsonObject();
    } else {
      settings = new JsonObject();
    }
    for (Entry setting : GLOBAL_SETTINGS.entrySet()) {
      if (!settings.has(setting.getKey())) {
        settings.addProperty(setting.getKey(), setting.getValue());
      }
    }

    properties.put("settings", settings.toString());
  }
}