APP-3073: Enhancements on MessageService

symphony-bdk-core/src/main/java/com/symphony/bdk/core/ServiceFactory.java

@@ -4,7 +4,7 @@
 import com.symphony.bdk.core.client.ApiClientFactory;
 import com.symphony.bdk.core.config.model.BdkConfig;
 import com.symphony.bdk.core.retry.RetryWithRecoveryBuilder;
-import com.symphony.bdk.core.service.MessageService;
+import com.symphony.bdk.core.service.message.MessageService;
 import com.symphony.bdk.core.service.SessionService;
 import com.symphony.bdk.core.service.datafeed.DatafeedService;
 import com.symphony.bdk.core.service.datafeed.DatafeedVersion;

symphony-bdk-core/src/main/java/com/symphony/bdk/core/SymphonyBdk.java

@@ -9,7 +9,7 @@
 import com.symphony.bdk.core.auth.exception.AuthUnauthorizedException;
 import com.symphony.bdk.core.client.ApiClientFactory;
 import com.symphony.bdk.core.config.model.BdkConfig;
-import com.symphony.bdk.core.service.MessageService;
+import com.symphony.bdk.core.service.message.MessageService;
 import com.symphony.bdk.core.service.SessionService;
 import com.symphony.bdk.core.service.datafeed.DatafeedService;
 import com.symphony.bdk.core.service.stream.StreamService;

symphony-bdk-core/src/main/java/com/symphony/bdk/core/auth/AuthenticatorFactory.java

@@ -147,7 +147,7 @@ private PrivateKey loadPrivateKeyFromAuthenticationConfig(BdkAuthenticationConfi
     try {
       String privateKey;
       if (isNotEmpty(config.getPrivateKeyContent())) {
-        privateKey = new String(config.getPrivateKeyContent());
+        privateKey = new String(config.getPrivateKeyContent(), StandardCharsets.UTF_8);
       } else {
         String privateKeyPath = config.getPrivateKeyPath();
         log.debug("Loading RSA privateKey from path : {}", privateKeyPath);

symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/MessageService.java → symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/message/MessageService.java

@@ -1,9 +1,13 @@
-package com.symphony.bdk.core.service;
+package com.symphony.bdk.core.service.message;
 
 
 import com.symphony.bdk.core.auth.AuthSession;
 import com.symphony.bdk.core.retry.RetryWithRecovery;
 import com.symphony.bdk.core.retry.RetryWithRecoveryBuilder;
+import com.symphony.bdk.core.service.message.exception.MessageCreationException;
+import com.symphony.bdk.core.service.message.model.Attachment;
+import com.symphony.bdk.core.service.message.model.Message;
+import com.symphony.bdk.core.service.message.model.MessageBuilder;
 import com.symphony.bdk.core.service.pagination.PaginatedApi;
 import com.symphony.bdk.core.service.pagination.PaginatedService;
 import com.symphony.bdk.core.service.stream.constant.AttachmentSort;
@@ -27,12 +31,14 @@
 import com.symphony.bdk.gen.api.model.V4Stream;
 import com.symphony.bdk.http.api.util.ApiUtils;
 import com.symphony.bdk.template.api.TemplateEngine;
-import com.symphony.bdk.template.api.TemplateException;
 import com.symphony.bdk.template.api.TemplateResolver;
 
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.FileUtils;
 import org.apiguardian.api.API;
 
+import java.io.File;
+import java.io.IOException;
 import java.time.Instant;
 import java.util.List;
 import java.util.stream.Stream;
@@ -93,6 +99,10 @@ public TemplateEngine templates() {
     return templateEngine;
   }
 
+  public MessageBuilder builder() {
+    return new MessageBuilder(this);
+  }
+
   /**
    * Get messages from an existing stream. Additionally returns any attachments associated with the message.
    *
@@ -164,60 +174,70 @@ public Stream<V4Message> getMessagesStream(@Nonnull String streamId, @Nonnull In
    * @param message the message payload in MessageML
    * @return a {@link V4Message} object containing the details of the sent message
    * @see <a href="https://developers.symphony.com/restapi/reference#create-message-v4">Create Message v4</a>
+   * @deprecated this method will be replaced by {@link MessageService#send(V4Stream, Message)}
    */
+  @Deprecated
   public V4Message send(@Nonnull V4Stream stream, @Nonnull String message) {
     return send(stream.getStreamId(), message);
   }
 
   /**
-   * Sends a templated to the stream ID of the passed {@link V4Stream} object.
+   * Sends a message to the stream ID passed in parameter.
    *
-   * @param stream     the stream to send the message to
-   * @param template   the template name to be used to produce the message
-   * @param parameters the parameters to pass to the template to produce the message to be sent
+   * @param streamId the ID of the stream to send the message to
+   * @param message  the message payload in MessageML
    * @return a {@link V4Message} object containing the details of the sent message
    * @see <a href="https://developers.symphony.com/restapi/reference#create-message-v4">Create Message v4</a>
+   * @deprecated this method will be replaced by {@link MessageService#send(String, Message)}
    */
-  public V4Message send(@Nonnull V4Stream stream, @Nonnull String template, Object parameters)
-      throws TemplateException {
-    return send(stream.getStreamId(), templateResolver.resolve(template).process(parameters));
-  }
-
-  /**
-   * Sends a templated to the stream ID passed in parameter.
-   *
-   * @param streamId   the ID of the stream to send the message to
-   * @param template   the template name to be used to produce the message
-   * @param parameters the parameters to pass to the template to produce the message to be sent
-   * @return a {@link V4Message} object containing the details of the sent message
-   * @throws TemplateException
-   */
-  public V4Message send(@Nonnull String streamId, @Nonnull String template, Object parameters)
-      throws TemplateException {
-    return send(streamId, templateResolver.resolve(template).process(parameters));
+  @Deprecated
+  public V4Message send(@Nonnull String streamId, @Nonnull String message) {
+    return executeAndRetry("send", () -> messagesApi.v4StreamSidMessageCreatePost(
+        streamId,
+        authSession.getSessionToken(),
+        authSession.getKeyManagerToken(),
+        message,
+        null,
+        null,
+        null,
+        null
+    ));
   }
 
   /**
    * Sends a message to the stream ID passed in parameter.
    *
-   * @param streamId the ID of the stream to send the message to
-   * @param message  the message payload in MessageML
+   * @param streamId    the ID of the stream to send the message to
+   * @param message     the message to send to the stream
    * @return a {@link V4Message} object containing the details of the sent message
    * @see <a href="https://developers.symphony.com/restapi/reference#create-message-v4">Create Message v4</a>
    */
-  public V4Message send(@Nonnull String streamId, @Nonnull String message) {
+  public V4Message send(@Nonnull String streamId, @Nonnull Message message) {
+    File tempFile = this.createTemporaryAttachmentFile(message.getAttachment());
     return executeAndRetry("send", () -> messagesApi.v4StreamSidMessageCreatePost(
         streamId,
         authSession.getSessionToken(),
         authSession.getKeyManagerToken(),
-        message,
-        null,
-        null,
+        message.getContent(),
+        message.getData(),
         null,
+        tempFile,
         null
     ));
   }
 
+  /**
+   * Sends a message to the stream ID passed in parameter.
+   *
+   * @param stream    the stream to send the message to
+   * @param message   the message to send to the stream
+   * @return a {@link V4Message} object containing the details of the sent message
+   * @see <a href="https://developers.symphony.com/restapi/reference#create-message-v4">Create Message v4</a>
+   */
+  public V4Message send(@Nonnull V4Stream stream, @Nonnull Message message) {
+    return send(stream.getStreamId(), message);
+  }
+
   /**
    * Downloads the attachment body by the stream ID, message ID and attachment ID.
    *
@@ -386,4 +406,22 @@ private static Long getEpochMillis(Instant instant) {
   private <T> T executeAndRetry(String name, SupplierWithApiException<T> supplier) {
     return RetryWithRecovery.executeAndRetry(retryBuilder, name, supplier);
   }
+
+  private File createTemporaryAttachmentFile(Attachment attachment) {
+    if (attachment == null) {
+      return null;
+    }
+    try {
+      String[] fileNameArrays = attachment.filename().split("\\.");
+      if (fileNameArrays.length < 2) {
+        throw new MessageCreationException("Invalid attachment's file name.");
+      }
+      File tempFile = File.createTempFile(fileNameArrays[0], "." + fileNameArrays[fileNameArrays.length - 1]);
+      tempFile.deleteOnExit();
+      FileUtils.copyInputStreamToFile(attachment.inputStream(), tempFile);
+      return tempFile;
+    } catch (IOException e) {
+      throw new MessageCreationException("Cannot create attachment.", e);
+    }
+  }
 }

symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/message/exception/MessageCreationException.java

@@ -0,0 +1,18 @@
+package com.symphony.bdk.core.service.message.exception;
+
+import org.apiguardian.api.API;
+
+/**
+ * Exception thrown when a {@link com.symphony.bdk.core.service.message.model.Message} is failed to create.
+ */
+@API(status = API.Status.STABLE)
+public class MessageCreationException extends RuntimeException {
+
+  public MessageCreationException(String message, Exception e) {
+    super(message, e);
+  }
+
+  public MessageCreationException(String message) {
+    super(message);
+  }
+}

symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/message/model/Attachment.java

@@ -0,0 +1,18 @@
+package com.symphony.bdk.core.service.message.model;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.apiguardian.api.API;
+
+import java.io.InputStream;
+
+@Getter
+@Setter
+@Accessors(fluent = true)
+@API(status = API.Status.EXPERIMENTAL)
+public class Attachment {
+
+  private InputStream inputStream;
+  private String filename;
+}

symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/message/model/Message.java

@@ -0,0 +1,30 @@
+package com.symphony.bdk.core.service.message.model;
+
+import com.symphony.bdk.gen.api.model.V4Stream;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.apiguardian.api.API;
+
+/**
+ * Message model to be used in {@link com.symphony.bdk.core.service.message.MessageService#send(V4Stream, Message)}
+ */
+@Getter
+@Setter
+@API(status = API.Status.EXPERIMENTAL)
+public class Message {
+
+  // The version of the MessageML format
+  private String version;
+  private String content;
+  private String data;
+  private Attachment attachment;
+
+  protected Message(MessageBuilder builder) {
+    this.version = builder.version();
+    this.content = builder.content();
+    this.data = builder.data();
+    this.attachment = builder.attachment();
+  }
+
+}

symphony-bdk-core/src/main/java/com/symphony/bdk/core/service/message/model/MessageBuilder.java

@@ -0,0 +1,139 @@
+package com.symphony.bdk.core.service.message.model;
+
+import static java.util.Collections.emptyMap;
+
+import com.symphony.bdk.core.service.message.MessageService;
+import com.symphony.bdk.core.service.message.exception.MessageCreationException;
+import com.symphony.bdk.gen.api.model.V4Message;
+import com.symphony.bdk.gen.api.model.V4Stream;
+import com.symphony.bdk.template.api.Template;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.apiguardian.api.API;
+
+import java.io.InputStream;
+
+/**
+ * Builder for {@link Message}.
+ * Allows configuring the field of the messages before constructing them with build()
+ */
+@Getter
+@Setter
+@Accessors(fluent = true)
+@API(status = API.Status.EXPERIMENTAL)
+public class MessageBuilder {
+
+  private static final ObjectMapper MAPPER = new JsonMapper();
+
+  private final MessageService messageService;
+  private String version = "2.0";
+  private String content;
+  private String data;
+  private Attachment attachment;
+
+  public MessageBuilder(MessageService messageService) {
+    this.messageService = messageService;
+  }
+
+  /**
+   * Add messageML content to the message.
+   *
+   * @param   message    messageML.
+   * @return  this builder with the content configured.
+   */
+  public MessageBuilder messageML(String message) {
+    this.content = message;
+    return this;
+  }
+
+  /**
+   * Add content from a template to the message.
+   *
+   * @param   template    a custom or built-in template.
+   * @param   parameters  parameters to be used in the template.
+   * @return  this builder with the content configured.
+   */
+  public MessageBuilder template(Template template, Object parameters) {
+    this.content = template.process(parameters);
+    return this;
+  }
+
+  /**
+   * Add content from a static template to the message.
+   *
+   * @param   template a custom or built-in template.
+   * @return  this builder with the content configured.
+   */
+  public MessageBuilder template(Template template) {
+    this.content = template.process(emptyMap());
+    return this;
+  }
+
+  /**
+   * Add data to the message.
+   * @param   data Serializable data object.
+   * @return  this builder with the data configured.
+   */
+  public MessageBuilder data(Object data) {
+    try {
+      this.data = MAPPER.writeValueAsString(data);
+      return this;
+    } catch (JsonProcessingException e) {
+      throw new MessageCreationException("Failed to parse data to Json string", e);
+    }
+  }
+
+  /**
+   * Add data to the message.
+   * @param   data Data json node.
+   * @return  this builder with the data configured.
+   */
+  public MessageBuilder data(JsonNode data) {
+    try {
+      this.data = MAPPER.writeValueAsString(data);
+      return this;
+    } catch (JsonProcessingException e) {
+      throw new MessageCreationException("Failed to parse data to Json string", e);
+    }
+  }
+
+  public MessageBuilder attachment(InputStream inputStream, String filename) {
+    this.attachment = new Attachment().inputStream(inputStream).filename(filename);
+    return this;
+  }
+
+  /**
+   * Create a {@link Message} using the configuration within the builder.
+   * @return  constructed {@link Message} using configuration within this builder.
+   */
+  public Message build() {
+    return new Message(this);
+  }
+
+  /**
+   * Build and send a {@link Message} using the {@link MessageService}.
+   *
+   * @param stream the stream where the message is sent to.
+   * @return a {@link V4Message} object containing the details of the sent message.
+   */
+  public V4Message send(V4Stream stream) {
+    return this.messageService.send(stream, this.build());
+  }
+
+  /**
+   * Build and send a {@link Message} using the {@link MessageService}.
+   *
+   * @param streamId the id of the stream where the message is sent to.
+   * @return a {@link V4Message} object containing the details of the sent message.
+   */
+  public V4Message send(String streamId) {
+    return this.messageService.send(streamId, this.build());
+  }
+
+}