Feature/asynchronous message sending

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/SendMessageService.java

@@ -1,14 +1,23 @@
 package com.dke.data.agrirouter.api.service.messaging;
 
 import com.dke.data.agrirouter.api.service.parameters.SendMessageParameters;
+import java.util.concurrent.CompletableFuture;
 
 /** Service for sending a message */
-public interface SendMessageService {
+public interface SendMessageService<T> {
 
   /**
    * Sending a message
    *
    * @param sendMessageParameters -
    */
   void send(SendMessageParameters sendMessageParameters);
+
+  /**
+   * Sending a message
+   *
+   * @param sendMessageParameters -
+   * @return -
+   */
+  CompletableFuture<T> sendAsync(SendMessageParameters sendMessageParameters);
 }

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/CloudOffboardingService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/CloudOffboardingService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.CloudOffboardingParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/CloudOnboardingService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/CloudOnboardingService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.CloudOnboardingParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/DeleteMessageService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/DeleteMessageService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.DeleteMessageParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/FetchMessageService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/FetchMessageService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.cancellation.CancellationToken;
 import com.dke.data.agrirouter.api.dto.messaging.FetchMessageResponse;

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/ListEndpointsService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/ListEndpointsService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.ListEndpointsParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/MessageConfirmationService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/MessageConfirmationService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.MessageConfirmationParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/MessageHeaderQueryService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/MessageHeaderQueryService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import agrirouter.feed.response.FeedResponse;
 import com.dke.data.agrirouter.api.service.messaging.encoding.MessageDecoder;

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/MessageQueryService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/MessageQueryService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import agrirouter.feed.response.FeedResponse;
 import com.dke.data.agrirouter.api.service.messaging.encoding.MessageDecoder;

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/MessagingService.java

@@ -0,0 +1,27 @@
+package com.dke.data.agrirouter.api.service.messaging.http;
+
+import com.dke.data.agrirouter.api.messaging.HttpAsyncMessageSendingResult;
+
+/**
+ * Centralized service interface.
+ *
+ * @param <T> The type of parameters needed to send messages.
+ */
+public interface MessagingService<T> {
+
+  /**
+   * Send a synchronous message.
+   *
+   * @param parameters -
+   * @return The ID of the message.
+   */
+  String send(T parameters);
+
+  /**
+   * Send an asynchronous message.
+   *
+   * @param parameters -
+   * @return The completable future containing the possible result.
+   */
+  HttpAsyncMessageSendingResult sendAsync(T parameters);
+}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/SetCapabilityService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/SetCapabilityService.java

@@ -1,5 +1,6 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.SetCapabilitiesParameters;
 
+/** Service interface set capabilities. */
 public interface SetCapabilityService extends MessagingService<SetCapabilitiesParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/SetSubscriptionService.java → agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/http/SetSubscriptionService.java

@@ -1,4 +1,4 @@
-package com.dke.data.agrirouter.api.service.messaging;
+package com.dke.data.agrirouter.api.service.messaging.http;
 
 import com.dke.data.agrirouter.api.service.parameters.SetSubscriptionParameters;
 

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/CloudOffboardingService.java

@@ -0,0 +1,5 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.CloudOffboardingParameters;
+
+public interface CloudOffboardingService extends MessagingService<CloudOffboardingParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/CloudOnboardingService.java

@@ -0,0 +1,5 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.CloudOnboardingParameters;
+
+public interface CloudOnboardingService extends MessagingService<CloudOnboardingParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/DeleteMessageService.java

@@ -0,0 +1,5 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.DeleteMessageParameters;
+
+public interface DeleteMessageService extends MessagingService<DeleteMessageParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/ListEndpointsService.java

@@ -0,0 +1,5 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.ListEndpointsParameters;
+
+public interface ListEndpointsService extends MessagingService<ListEndpointsParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/MessageConfirmationService.java

@@ -0,0 +1,6 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.MessageConfirmationParameters;
+
+public interface MessageConfirmationService
+    extends MessagingService<MessageConfirmationParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/MessageHeaderQueryService.java

@@ -0,0 +1,9 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import agrirouter.feed.response.FeedResponse;
+import com.dke.data.agrirouter.api.service.messaging.encoding.MessageDecoder;
+import com.dke.data.agrirouter.api.service.parameters.MessageQueryParameters;
+
+public interface MessageHeaderQueryService
+    extends MessagingService<MessageQueryParameters>,
+        MessageDecoder<FeedResponse.HeaderQueryResponse> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/MessageQueryService.java

@@ -0,0 +1,9 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import agrirouter.feed.response.FeedResponse;
+import com.dke.data.agrirouter.api.service.messaging.encoding.MessageDecoder;
+import com.dke.data.agrirouter.api.service.parameters.MessageQueryParameters;
+
+public interface MessageQueryService
+    extends MessagingService<MessageQueryParameters>,
+        MessageDecoder<FeedResponse.MessageQueryResponse> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/MessagingService.java

@@ -0,0 +1,27 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.messaging.MqttAsyncMessageSendingResult;
+
+/**
+ * Centralized service interface.
+ *
+ * @param <T> The type of parameters needed to send messages.
+ */
+public interface MessagingService<T> {
+
+  /**
+   * Send a synchronous message.
+   *
+   * @param parameters -
+   * @return The ID of the message.
+   */
+  String send(T parameters);
+
+  /**
+   * Send an asynchronous message.
+   *
+   * @param parameters -
+   * @return The completable future containing the possible result.
+   */
+  MqttAsyncMessageSendingResult sendAsync(T parameters);
+}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/SetCapabilityService.java

@@ -0,0 +1,6 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.SetCapabilitiesParameters;
+
+/** Service interface set capabilities. */
+public interface SetCapabilityService extends MessagingService<SetCapabilitiesParameters> {}

agrirouter-api-java-api/src/main/java/com/dke/data/agrirouter/api/service/messaging/mqtt/SetSubscriptionService.java

@@ -0,0 +1,6 @@
+package com.dke.data.agrirouter.api.service.messaging.mqtt;
+
+import com.dke.data.agrirouter.api.service.parameters.SetSubscriptionParameters;
+
+/** Service to set the subscriptions for an endpoint. */
+public interface SetSubscriptionService extends MessagingService<SetSubscriptionParameters> {}

agrirouter-api-java-api/src/main/kotlin/com/dke/data/agrirouter/api/messaging/AsyncMessageSendingResult.kt

@@ -0,0 +1,12 @@
+package com.dke.data.agrirouter.api.messaging
+
+import java.util.concurrent.CompletableFuture
+
+/**
+ * Marker interface.
+ */
+interface AsyncMessageSendingResult<T> {
+
+    fun accessResult(): CompletableFuture<T>
+
+}

agrirouter-api-java-api/src/main/kotlin/com/dke/data/agrirouter/api/messaging/HttpAsyncMessageSendingResult.kt

@@ -0,0 +1,13 @@
+package com.dke.data.agrirouter.api.messaging
+
+import java.util.concurrent.CompletableFuture
+
+class HttpAsyncMessageSendingResult(
+    val response: CompletableFuture<MessageSendingResponse>,
+    val messageId: String
+) : AsyncMessageSendingResult<MessageSendingResponse> {
+    override fun accessResult(): CompletableFuture<MessageSendingResponse> {
+        return response
+    }
+
+}

agrirouter-api-java-api/src/main/kotlin/com/dke/data/agrirouter/api/messaging/MessageSendingResponse.kt

@@ -0,0 +1,8 @@
+package com.dke.data.agrirouter.api.messaging
+
+import javax.ws.rs.core.Response
+
+/**
+ * Wrapper for the response from the server.
+ */
+class MessageSendingResponse(val nativeResponse: Response)

agrirouter-api-java-api/src/main/kotlin/com/dke/data/agrirouter/api/messaging/MessageSendingResult.kt

@@ -0,0 +1,3 @@
+package com.dke.data.agrirouter.api.messaging
+
+class MessageSendingResult(val messageSendingResponse: MessageSendingResponse, val messageId : String)

agrirouter-api-java-api/src/main/kotlin/com/dke/data/agrirouter/api/messaging/MqttAsyncMessageSendingResult.kt

@@ -0,0 +1,10 @@
+package com.dke.data.agrirouter.api.messaging
+
+import java.util.concurrent.CompletableFuture
+
+class MqttAsyncMessageSendingResult(private val result: CompletableFuture<String>) : AsyncMessageSendingResult<String> {
+    override fun accessResult(): CompletableFuture<String> {
+        return result
+    }
+
+}

agrirouter-api-java-convenience/src/main/java/com/dke/data/agrirouter/convenience/mqtt/service/messaging/ListEndpointsFunctionsService.java

@@ -3,7 +3,7 @@
 import agrirouter.request.payload.account.Endpoints;
 import com.dke.data.agrirouter.api.dto.onboard.OnboardingResponse;
 import com.dke.data.agrirouter.api.enums.TechnicalMessageType;
-import com.dke.data.agrirouter.api.service.messaging.ListEndpointsService;
+import com.dke.data.agrirouter.api.service.messaging.mqtt.ListEndpointsService;
 import com.dke.data.agrirouter.api.service.parameters.ListEndpointsParameters;
 import com.dke.data.agrirouter.impl.messaging.mqtt.ListEndpointsServiceImpl;
 import org.eclipse.paho.client.mqttv3.IMqttClient;

agrirouter-api-java-convenience/src/main/java/com/dke/data/agrirouter/convenience/rest/service/messaging/ListEndpointsFunctionsService.java

@@ -4,7 +4,7 @@
 import com.dke.data.agrirouter.api.dto.onboard.OnboardingResponse;
 import com.dke.data.agrirouter.api.enums.TechnicalMessageType;
 import com.dke.data.agrirouter.api.env.Environment;
-import com.dke.data.agrirouter.api.service.messaging.ListEndpointsService;
+import com.dke.data.agrirouter.api.service.messaging.http.ListEndpointsService;
 import com.dke.data.agrirouter.api.service.parameters.ListEndpointsParameters;
 import com.dke.data.agrirouter.impl.messaging.rest.ListEndpointsServiceImpl;
 

agrirouter-api-java-convenience/src/main/java/com/dke/data/agrirouter/convenience/rest/service/messaging/MessageConfirmationFunctionsService.java

@@ -10,10 +10,10 @@
 import com.dke.data.agrirouter.api.dto.encoding.DecodeMessageResponse;
 import com.dke.data.agrirouter.api.dto.messaging.FetchMessageResponse;
 import com.dke.data.agrirouter.api.env.Environment;
-import com.dke.data.agrirouter.api.service.messaging.FetchMessageService;
-import com.dke.data.agrirouter.api.service.messaging.MessageConfirmationService;
-import com.dke.data.agrirouter.api.service.messaging.MessageQueryService;
 import com.dke.data.agrirouter.api.service.messaging.encoding.DecodeMessageService;
+import com.dke.data.agrirouter.api.service.messaging.http.FetchMessageService;
+import com.dke.data.agrirouter.api.service.messaging.http.MessageConfirmationService;
+import com.dke.data.agrirouter.api.service.messaging.http.MessageQueryService;
 import com.dke.data.agrirouter.api.service.parameters.MessageConfirmationForAllPendingMessagesParameters;
 import com.dke.data.agrirouter.api.service.parameters.MessageConfirmationParameters;
 import com.dke.data.agrirouter.api.service.parameters.MessageQueryParameters;

agrirouter-api-java-impl/src/main/java/com/dke/data/agrirouter/impl/messaging/helper/MessageQueryHelperService.java

@@ -2,6 +2,8 @@
 
 import com.dke.data.agrirouter.api.dto.encoding.EncodedMessage;
 import com.dke.data.agrirouter.api.enums.TechnicalMessageType;
+import com.dke.data.agrirouter.api.messaging.HttpAsyncMessageSendingResult;
+import com.dke.data.agrirouter.api.messaging.MessageSendingResponse;
 import com.dke.data.agrirouter.api.service.messaging.encoding.EncodeMessageService;
 import com.dke.data.agrirouter.api.service.parameters.MessageQueryParameters;
 import com.dke.data.agrirouter.api.service.parameters.SendMessageParameters;
@@ -10,6 +12,7 @@
 import com.dke.data.agrirouter.impl.messaging.rest.MessageSender;
 import com.dke.data.agrirouter.impl.validation.ResponseValidator;
 import java.util.Collections;
+import java.util.concurrent.CompletableFuture;
 
 public class MessageQueryHelperService extends NonEnvironmentalService
     implements MessageSender, MessageEncoder, ResponseValidator {
@@ -41,7 +44,7 @@ public String send(MessageQueryParameters parameters) {
         Collections.singletonList(encodedMessageResponse.getEncodedMessage()));
 
     this.getNativeLogger().trace("Send and fetch message response.");
-    MessageSender.MessageSenderResponse response = this.sendMessage(sendMessageParameters);
+    MessageSendingResponse response = this.sendMessage(sendMessageParameters);
 
     this.getNativeLogger().trace("Validate message response.");
     this.assertStatusCodeIsOk(response.getNativeResponse().getStatus());
@@ -50,6 +53,30 @@ public String send(MessageQueryParameters parameters) {
     return encodedMessageResponse.getApplicationMessageID();
   }
 
+  public HttpAsyncMessageSendingResult sendAsync(MessageQueryParameters parameters) {
+    this.logMethodBegin(parameters);
+
+    this.getNativeLogger().trace("Validate parameters.");
+    parameters.validate();
+
+    this.getNativeLogger().trace("Encode message.");
+    EncodedMessage encodedMessageResponse = this.encode(this.technicalMessageType, parameters);
+
+    this.getNativeLogger().trace("Build message parameters.");
+    SendMessageParameters sendMessageParameters = new SendMessageParameters();
+    sendMessageParameters.setOnboardingResponse(parameters.getOnboardingResponse());
+    sendMessageParameters.setEncodedMessages(
+        Collections.singletonList(encodedMessageResponse.getEncodedMessage()));
+
+    this.getNativeLogger().trace("Send and fetch message response.");
+    CompletableFuture<MessageSendingResponse> response =
+        this.sendMessageAsync(sendMessageParameters);
+
+    this.logMethodEnd();
+    return new HttpAsyncMessageSendingResult(
+        response, encodedMessageResponse.getApplicationMessageID());
+  }
+
   @Override
   public EncodeMessageService getEncodeMessageService() {
     return this.encodeMessageService;