org.apache.druid.indexing.common.task.AbstractTask.java Source code

Introduction

Here is the source code for org.apache.druid.indexing.common.task.AbstractTask.java

Source

/*
 * 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.druid.indexing.common.task;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import org.apache.druid.indexer.TaskStatus;
import org.apache.druid.indexing.common.TaskLock;
import org.apache.druid.indexing.common.actions.LockListAction;
import org.apache.druid.indexing.common.actions.TaskActionClient;
import org.apache.druid.java.util.common.DateTimes;
import org.apache.druid.query.Query;
import org.apache.druid.query.QueryRunner;
import org.joda.time.Interval;

import javax.annotation.Nullable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public abstract class AbstractTask implements Task {
    private static final Joiner ID_JOINER = Joiner.on("_");

    @JsonIgnore
    private final String id;

    @JsonIgnore
    private final String groupId;

    @JsonIgnore
    private final TaskResource taskResource;

    @JsonIgnore
    private final String dataSource;

    private final Map<String, Object> context;

    protected AbstractTask(String id, String dataSource, Map<String, Object> context) {
        this(id, null, null, dataSource, context);
    }

    protected AbstractTask(String id, @Nullable String groupId, @Nullable TaskResource taskResource,
            String dataSource, @Nullable Map<String, Object> context) {
        this.id = Preconditions.checkNotNull(id, "id");
        this.groupId = groupId == null ? id : groupId;
        this.taskResource = taskResource == null ? new TaskResource(id, 1) : taskResource;
        this.dataSource = Preconditions.checkNotNull(dataSource, "dataSource");
        this.context = context == null ? new HashMap<>() : context;
    }

    public static String getOrMakeId(String id, final String typeName, String dataSource) {
        return getOrMakeId(id, typeName, dataSource, null);
    }

    static String getOrMakeId(String id, final String typeName, String dataSource, @Nullable Interval interval) {
        if (id != null) {
            return id;
        }

        final List<Object> objects = new ArrayList<>();
        objects.add(typeName);
        objects.add(dataSource);
        if (interval != null) {
            objects.add(interval.getStart());
            objects.add(interval.getEnd());
        }
        objects.add(DateTimes.nowUtc().toString());

        return joinId(objects);
    }

    @JsonProperty
    @Override
    public String getId() {
        return id;
    }

    @JsonProperty
    @Override
    public String getGroupId() {
        return groupId;
    }

    @JsonProperty("resource")
    @Override
    public TaskResource getTaskResource() {
        return taskResource;
    }

    @Override
    public String getNodeType() {
        return null;
    }

    @JsonProperty
    @Override
    public String getDataSource() {
        return dataSource;
    }

    @Override
    public <T> QueryRunner<T> getQueryRunner(Query<T> query) {
        return null;
    }

    @Override
    public String getClasspathPrefix() {
        return null;
    }

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

    @Override
    public String toString() {
        return "AbstractTask{" + "id='" + id + '\'' + ", groupId='" + groupId + '\'' + ", taskResource="
                + taskResource + ", dataSource='" + dataSource + '\'' + ", context=" + context + '}';
    }

    /**
     * Start helper methods
     *
     * @param objects objects to join
     *
     * @return string of joined objects
     */
    static String joinId(List<Object> objects) {
        return ID_JOINER.join(objects);
    }

    static String joinId(Object... objects) {
        return ID_JOINER.join(objects);
    }

    public TaskStatus success() {
        return TaskStatus.success(getId());
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        AbstractTask that = (AbstractTask) o;

        if (!id.equals(that.id)) {
            return false;
        }

        if (!groupId.equals(that.groupId)) {
            return false;
        }

        if (!dataSource.equals(that.dataSource)) {
            return false;
        }

        return context.equals(that.context);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(id, groupId, dataSource, context);
    }

    public static List<TaskLock> getTaskLocks(TaskActionClient client) throws IOException {
        return client.submit(new LockListAction());
    }

    @Override
    @JsonProperty
    public Map<String, Object> getContext() {
        return context;
    }
}