vid-app-common/src/main/java/org/onap/vid/job/JobCommand.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 org.onap.vid.job.impl.JobSharedData;
  24
  25 import java.util.Map;
  26
  27
  28 /**
  29  * A callable instance, with serializable characteristics.
  30  * Represents a step in a chain of steps, which eventualy
  31  * resides into a packing Job.
  32  */
  33 public interface JobCommand {
  34
  35     /**
  36      * Initialize the command state
  37      * @param sharedData shared data cross all job commands
  38      * @param commandData An input to be set into the command. Each implementation may expect different keys in the map.
  39      * @return Returns itself
  40      */
  41     default JobCommand init(JobSharedData sharedData, Map<String, Object> commandData) {
  42         return this;
  43     }
  44
  45     /**
  46      * @return Returns the inner state of the command. This state, once passed into init(), should
  47      *         bring the command back to it's state.
  48      */
  49     Map<String, Object> getData();
  50
  51     /**
  52      * Execute the command represented by this instance. Assumes the instance is already init().
  53      * @return A NextCommand containing the next command in chain of commands, or null if chain
  54      *         should be terminated. Might return itself (packed in a NextCommand).
  55      */
  56     NextCommand call();
  57
  58     default JobType getType() {
  59         return JobType.jobTypeOf(this.getClass());
  60     }
  61
  62 }