From 7005452a8cfa247325e992e214a4c5f6c3efae23 Mon Sep 17 00:00:00 2001
From: Robert von Burg <eitch@eitchnet.ch>
Date: Tue, 24 Aug 2021 17:39:19 +0200
Subject: [PATCH] [New] Added new UserMessageException to use in Services

---
 .../strolch/service/api/AbstractService.java  |  5 +++
 .../li/strolch/service/api/ServiceResult.java | 33 ++++++++++++++++---
 .../strolch/model/UserMessageException.java   | 18 ++++++++++
 3 files changed, 52 insertions(+), 4 deletions(-)
 create mode 100644 li.strolch.model/src/main/java/li/strolch/model/UserMessageException.java

diff --git a/li.strolch.agent/src/main/java/li/strolch/service/api/AbstractService.java b/li.strolch.agent/src/main/java/li/strolch/service/api/AbstractService.java
index 1b996793a..715592945 100644
--- a/li.strolch.agent/src/main/java/li/strolch/service/api/AbstractService.java
+++ b/li.strolch.agent/src/main/java/li/strolch/service/api/AbstractService.java
@@ -25,6 +25,7 @@ import li.strolch.agent.api.StrolchAgent;
 import li.strolch.agent.api.StrolchComponent;
 import li.strolch.agent.api.StrolchRealm;
 import li.strolch.exception.StrolchException;
+import li.strolch.model.UserMessageException;
 import li.strolch.persistence.api.StrolchTransaction;
 import li.strolch.privilege.base.PrivilegeException;
 import li.strolch.privilege.handler.SystemAction;
@@ -572,6 +573,10 @@ public abstract class AbstractService<T extends ServiceArgument, U extends Servi
 			result.setState(ServiceResultState.EXCEPTION);
 			result.setMessage(e.getMessage());
 			result.setThrowable(e);
+
+			if (e instanceof UserMessageException)
+				result.setI18nMessage(((UserMessageException) e).getI18nMsg());
+
 			return result;
 		}
 	}
diff --git a/li.strolch.agent/src/main/java/li/strolch/service/api/ServiceResult.java b/li.strolch.agent/src/main/java/li/strolch/service/api/ServiceResult.java
index 1f0ff9eba..859bda517 100644
--- a/li.strolch.agent/src/main/java/li/strolch/service/api/ServiceResult.java
+++ b/li.strolch.agent/src/main/java/li/strolch/service/api/ServiceResult.java
@@ -19,6 +19,7 @@ import static li.strolch.utils.helper.ExceptionHelper.formatException;
 import static li.strolch.utils.helper.ExceptionHelper.getExceptionMessageWithCauses;
 import static li.strolch.utils.helper.StringHelper.isEmpty;
 
+import java.util.Locale;
 import java.util.ResourceBundle;
 
 import com.google.gson.JsonObject;
@@ -56,6 +57,18 @@ public class ServiceResult {
 		this.throwable = throwable;
 	}
 
+	public ServiceResult(ServiceResultState state, I18nMessage i18nMessage) {
+		this.state = state;
+		this.message = i18nMessage.getMessage(Locale.getDefault());
+		this.i18nMessage = i18nMessage;
+	}
+
+	public ServiceResult(ServiceResultState state, String message, I18nMessage i18nMessage) {
+		this.state = state;
+		this.message = message;
+		this.i18nMessage = i18nMessage;
+	}
+
 	/**
 	 * @return true if the state is {@link ServiceResultState#SUCCESS}
 	 */
@@ -116,15 +129,15 @@ public class ServiceResult {
 	}
 
 	public static ServiceResult success() {
-		return new ServiceResult(ServiceResultState.SUCCESS, null, null);
+		return new ServiceResult(ServiceResultState.SUCCESS);
 	}
 
 	public static ServiceResult success(String msg) {
-		return new ServiceResult(ServiceResultState.SUCCESS, msg, null);
+		return new ServiceResult(ServiceResultState.SUCCESS, msg);
 	}
 
 	public static ServiceResult warning(String warning) {
-		return new ServiceResult(ServiceResultState.WARNING, warning, null);
+		return new ServiceResult(ServiceResultState.WARNING, warning);
 	}
 
 	public static ServiceResult warning(String warning, Throwable t) {
@@ -132,7 +145,15 @@ public class ServiceResult {
 	}
 
 	public static ServiceResult error(String error) {
-		return new ServiceResult(ServiceResultState.FAILED, error, null);
+		return new ServiceResult(ServiceResultState.FAILED, error);
+	}
+
+	public static ServiceResult error(I18nMessage i18nMessage) {
+		return new ServiceResult(ServiceResultState.FAILED, i18nMessage);
+	}
+
+	public static ServiceResult error(String message, I18nMessage i18nMessage) {
+		return new ServiceResult(ServiceResultState.FAILED, message, i18nMessage);
 	}
 
 	public static ServiceResult failed(String error, Throwable t) {
@@ -192,6 +213,10 @@ public class ServiceResult {
 		return this.i18nMessage;
 	}
 
+	public void setI18nMessage(I18nMessage i18nMessage) {
+		this.i18nMessage = i18nMessage;
+	}
+
 	public JsonObject toJson() {
 		JsonObject json = new JsonObject();
 
diff --git a/li.strolch.model/src/main/java/li/strolch/model/UserMessageException.java b/li.strolch.model/src/main/java/li/strolch/model/UserMessageException.java
new file mode 100644
index 000000000..68449ae85
--- /dev/null
+++ b/li.strolch.model/src/main/java/li/strolch/model/UserMessageException.java
@@ -0,0 +1,18 @@
+package li.strolch.model;
+
+import li.strolch.utils.I18nMessage;
+import li.strolch.utils.dbc.DBC;
+
+public class UserMessageException extends Exception {
+
+	private final I18nMessage i18nMsg;
+
+	public UserMessageException(I18nMessage i18nMsg) {
+		DBC.PRE.assertNotNull("i18nMsg must not be null!", i18nMsg);
+		this.i18nMsg = i18nMsg;
+	}
+
+	public I18nMessage getI18nMsg() {
+		return this.i18nMsg;
+	}
+}