vid-app-common/src/main/java/org/onap/vid/job/Job.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.vid.job;
  22
  23 import com.fasterxml.jackson.annotation.JsonIgnore;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.UUID;
  27 import java.util.stream.Collectors;
  28 import java.util.stream.Stream;
  29 import org.onap.vid.job.impl.JobSharedData;
  30
  31 public interface Job {
  32
  33     UUID getUuid();
  34
  35     void setUuid(UUID uuid);
  36
  37     JobStatus getStatus();
  38
  39     void setStatus(JobStatus status);
  40
  41     @JsonIgnore
  42     Map<String, Object> getData();
  43
  44     JobSharedData getSharedData();
  45
  46     void setTypeAndData(JobType jobType, Map<String, Object> data);
  47
  48     UUID getTemplateId();
  49
  50     void setTemplateId(UUID templateId);
  51
  52     Integer getIndexInBulk();
  53
  54     void setIndexInBulk(Integer indexInBulk);
  55
  56     JobType getType();
  57
  58     enum JobStatus {
  59         COMPLETED(true, false),
  60         FAILED(true, true),
  61         IN_PROGRESS(false),
  62         RESOURCE_IN_PROGRESS(false),
  63         PAUSE(false),
  64         PENDING(false),
  65         STOPPED(true, true),
  66         COMPLETED_WITH_ERRORS(true, true),
  67         COMPLETED_WITH_NO_ACTION(true, false),
  68         CREATING(false),
  69         PENDING_RESOURCE(false),
  70         COMPLETED_AND_PAUSED(true, false),
  71         FAILED_AND_PAUSED(true, true),
  72         ;
  73
  74         private final Boolean finalStatus;
  75         public Boolean isFinal(){return finalStatus;}
  76
  77         private final Boolean failure;
  78         public Boolean isFailure() {
  79             return failure;
  80         }
  81
  82         JobStatus(Boolean finalStatus)
  83         {
  84             this(finalStatus, false);
  85         }
  86
  87         JobStatus(Boolean finalStatus, boolean failure) {
  88             this.finalStatus = finalStatus;
  89             this.failure = failure;
  90         }
  91
  92         public static final List<JobStatus> FINAL_STATUS = Stream.of(JobStatus.values()).filter(JobStatus::isFinal).collect(Collectors.toList());
  93
  94     }
  95 }