InstancesResult.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.falcon.resource;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.Date;

/**
 * Pojo for JAXB marshalling / unmarshalling.
 */
//SUSPEND CHECKSTYLE CHECK VisibilityModifierCheck
@XmlRootElement
@edu.umd.cs.findbugs.annotations.SuppressWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
public class InstancesResult extends APIResult {

    /**
     * Workflow status as being set in result object.
     */
    public static enum WorkflowStatus {
        WAITING, RUNNING, SUSPENDED, KILLED, FAILED, SUCCEEDED, ERROR, SKIPPED, UNDEFINED, READY, KILLED_OR_IGNORED,
        TIMEDOUT
    }

    /**
     * RestAPI supports filterBy these fields of instance.
     */
    public static enum InstanceFilterFields {
        STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER
    }

    @XmlElement
    private Instance[] instances;

    private InstancesResult() { // for jaxb
        super();
    }

    public InstancesResult(Status status, String message) {
        super(status, message);
    }


    public Instance[] getInstances() {
        return instances;
    }

    public void setInstances(Instance[] instances) {
        this.instances = instances;
    }

    @Override
    public Object[] getCollection() {
        return getInstances();
    }

    @Override
    public void setCollection(Object[] items) {
        if (items == null) {
            setInstances(new Instance[0]);
        } else {
            Instance[] newInstances = new Instance[items.length];
            for (int index = 0; index < items.length; index++) {
                newInstances[index] = (Instance)items[index];
            }
            setInstances(newInstances);
        }
    }

    /**
     * A single instance object inside instance result.
     */
    @XmlRootElement(name = "instance")
    public static class Instance {
        @XmlElement
        public String instance;

        @XmlElement
        public WorkflowStatus status;

        @XmlElement
        public String logFile;

        @XmlElement
        public String cluster;

        @XmlElement
        public String sourceCluster;

        @XmlElement
        public Date startTime;

        @XmlElement
        public Date endTime;

        @XmlElement
        public int runId;

        @XmlElement
        public String details;

        @XmlElement
        public InstanceAction[] actions;

        @XmlElement(name="wfParams")
        public KeyValuePair[] wfParams;

        public Instance() {
        }

        public Instance(String cluster, String instance, WorkflowStatus status) {
            this.cluster = cluster;
            this.instance = instance;
            this.status = status;
        }

        public String getInstance() {
            return instance;
        }

        public WorkflowStatus getStatus() {
            return status;
        }

        public String getLogFile() {
            return logFile;
        }

        public String getCluster() {
            return cluster;
        }

        public String getSourceCluster() {
            return sourceCluster;
        }

        public Date getStartTime() {
            return startTime;
        }

        public Date getEndTime() {
            return endTime;
        }

        public int getRunId() {
            return runId;
        }

        public InstanceAction[] getActions() {
            return actions;
        }

        public String getDetails() {
            return details;
        }

        public KeyValuePair[] getWfParams() { return wfParams; }

        @Override
        public String toString() {
            return "{instance:"
                    + this.instance
                    + ", status:"
                    + this.status
                    + (this.logFile == null ? "" : ", log:" + this.logFile)
                    + (this.sourceCluster == null ? "" : ", source-cluster:"
                    + this.sourceCluster)
                    + (this.cluster == null ? "" : ", cluster:"
                    + this.cluster) + "}\n";
        }
    }

    /**
     * Instance action inside an instance object.
     */
    @XmlRootElement(name = "actions")
    public static class InstanceAction {
        @XmlElement
        public String action;
        @XmlElement
        public String status;
        @XmlElement
        public String logFile;

        public InstanceAction() {
        }

        public InstanceAction(String action, String status, String logFile) {
            this.action = action;
            this.status = status;
            this.logFile = logFile;
        }

        public String getAction() {
            return action;
        }

        public String getStatus() {
            return status;
        }

        public String getLogFile() {
            return logFile;
        }

        @Override
        public String toString() {
            return "{action:" + this.action + ", status:" + this.status
                    + (this.logFile == null ? "" : ", log:" + this.logFile)
                    + "}";
        }
    }

    /**
     * POJO for key value parameters.
     */
    @XmlRootElement(name = "params")
    public static class KeyValuePair {
        @XmlElement
        public String key;
        @XmlElement
        public String value;

        public KeyValuePair(String key, String value) {
            this.key = key;
            this.value = value;
        }

        public KeyValuePair() { }

        public String getKey() {
            return key;
        }

        public String getValue() {
            return value;
        }

        @Override
        public String toString() {
            return "{key:" + this.key + ", value:" + this.value + "}";
        }
    }
}
//RESUME CHECKSTYLE CHECK VisibilityModifierCheck