summaryrefslogtreecommitdiffstats
path: root/vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java
diff options
context:
space:
mode:
Diffstat (limited to 'vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java')
-rw-r--r--vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java41
1 files changed, 41 insertions, 0 deletions
diff --git a/vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java b/vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java
new file mode 100644
index 00000000..c32645ca
--- /dev/null
+++ b/vid-app-common/src/main/java/org/onap/vid/job/JobCommand.java
@@ -0,0 +1,41 @@
+package org.onap.vid.job;
+
+import java.util.Map;
+import java.util.UUID;
+
+
+/**
+ * A callable instance, with serializable characteristics.
+ * Represents a step in a chain of steps, which eventualy
+ * resides into a packing Job.
+ */
+public interface JobCommand {
+
+ /**
+ * Initialize the command state
+ * @param jobUuid Parent job's uuid
+ * @param data An input to be set into the command. Each implementation may expect different keys in the map.
+ * @return Returns itself
+ */
+ default JobCommand init(UUID jobUuid, Map<String, Object> data) {
+ return this;
+ }
+
+ /**
+ * @return Returns the inner state of the command. This state, once passed into init(), should
+ * bring the command back to it's state.
+ */
+ Map<String, Object> getData();
+
+ /**
+ * Execute the command represented by this instance. Assumes the instance is already init().
+ * @return A NextCommand containing the next command in chain of commands, or null if chain
+ * should be terminated. Might return itself (packed in a NextCommand).
+ */
+ NextCommand call();
+
+ default JobType getType() {
+ return JobType.jobTypeOf(this.getClass());
+ }
+
+}