From b6fa15f5da2312ac580ce329f569fd4b3a826f24 Mon Sep 17 00:00:00 2001
From: Kai Reinhard <K.Reinhard@micromata.de>
Date: Wed, 19 Dec 2018 06:56:02 +0000
Subject: [PATCH] ...
---
borgbutler-core/src/main/java/de/micromata/borgbutler/BorgCommand.java | 80 ++++++++++++++++++++++++++++++++++++---
1 files changed, 73 insertions(+), 7 deletions(-)
diff --git a/borgbutler-core/src/main/java/de/micromata/borgbutler/BorgCommand.java b/borgbutler-core/src/main/java/de/micromata/borgbutler/BorgCommand.java
index eb21ff3..3f24fd9 100644
--- a/borgbutler-core/src/main/java/de/micromata/borgbutler/BorgCommand.java
+++ b/borgbutler-core/src/main/java/de/micromata/borgbutler/BorgCommand.java
@@ -1,26 +1,84 @@
package de.micromata.borgbutler;
import de.micromata.borgbutler.config.BorgRepoConfig;
+import lombok.AccessLevel;
+import lombok.Getter;
import lombok.Setter;
+import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import javax.naming.Context;
import java.io.File;
+/**
+ * Represents a command to be queued for executing.
+ */
public class BorgCommand {
private Logger log = LoggerFactory.getLogger(BorgCommand.class);
+ /**
+ * The current Thread assigned to this command sets the state and reads for the state {@link State#TERMINATE_SIGNAL_RECEIVED}.
+ * If received, the thread will be terminated without executing the borg command.
+ */
+ public enum State {
+ /**
+ * This command is waiting in the queue.
+ */
+ WAITING_IN_QUEUE,
+ /**
+ * This command is running (beeing executed).
+ */
+ RUNNING,
+ /**
+ * This command should not be terminated before starting.
+ */
+ TERMINATE_SIGNAL_RECEIVED}
+
+ public enum ResultStatus {
+ OK, ERROR
+ }
+
+ @Getter
@Setter
- File workingDir;
- String[] args;
- String[] params;
+ private File workingDir;
+ @Getter
+ private String[] args;
+ @Getter
+ private String[] params;
+ @Getter
@Setter
- BorgRepoConfig repoConfig;
+ private BorgRepoConfig repoConfig;
+ @Getter
@Setter
- String command;
+ private String command;
+ @Getter
@Setter
- String archive;
+ private String archive;
+ @Getter
+ private State state;
+ /**
+ * For displaying and information purposes for the user only, when browsing the current command queue.
+ */
+ @Setter
+ @Getter
+ private String description;
+ /**
+ * The result of the call will be written to this String.
+ */
+ @Getter
+ @Setter(AccessLevel.PACKAGE)
+ private String response;
+
+ @Getter
+ @Setter(AccessLevel.PACKAGE)
+ private ResultStatus resultStatus;
+
+ /**
+ * Requests the thread handling this command to terminate / cancel this action.
+ */
+ public void terminate() {
+ this.state = State.TERMINATE_SIGNAL_RECEIVED;
+ }
BorgCommand setArgs(String... args) {
this.args = args;
@@ -38,4 +96,12 @@
}
return repoConfig.getRepo() + "::" + archive;
}
+
+ /**
+ *
+ * @return Abbreviated response e. g. for logging an error.
+ */
+ public String getAbbreviatedResponse() {
+ return StringUtils.abbreviate(response, 1000);
+ }
}
--
Gitblit v1.10.0