Improved java class documentation

[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / dmaap / DmaapMessageConsumer.java

diff --git a/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java b/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java
index 46dd2ee..f03aa58 100644 (file)
--- a/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java
+++ b/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java
@@ -39,13 +39,16 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
+/**
+ * The class fetches incoming requests from DMAAP on regular intervals. Each
+ * received request is proceesed by DmaapMessageHandler.
+ */
 @Component
 public class DmaapMessageConsumer implements Runnable {
 
     private static final Logger logger = LoggerFactory.getLogger(DmaapMessageConsumer.class);
 
-    @SuppressWarnings("squid:S00116") // To avoid warning about DMAAP abbreviation.
-    final Duration TIME_BETWEEN_DMAAP_POLLS = Duration.ofSeconds(10);
+    private static final Duration TIME_BETWEEN_DMAAP_POLLS = Duration.ofSeconds(10);
 
     private final ApplicationConfig applicationConfig;
 
@@ -78,7 +81,7 @@ public class DmaapMessageConsumer implements Runnable {
                     }
                 }
             } catch (Exception e) {
-                logger.warn("{}: cannot fetch because of ", this, e.getMessage(), e);
+                logger.warn("{}: cannot fetch because of {}", this, e.getMessage());
                 sleep(TIME_BETWEEN_DMAAP_POLLS);
             }
         }
@@ -86,10 +89,15 @@ public class DmaapMessageConsumer implements Runnable {
 
     private Iterable<String> fetchAllMessages() throws ServiceException, IOException {
         Properties dmaapConsumerProperties = this.applicationConfig.getDmaapConsumerConfig();
-        MRConsumer consumer = MRClientFactory.createConsumer(dmaapConsumerProperties);
+        MRConsumer consumer = getMessageRouterConsumer(dmaapConsumerProperties);
         MRConsumerResponse response = consumer.fetchWithReturnConsumerResponse();
         if (response == null || !"200".equals(response.getResponseCode())) {
-            throw new ServiceException("DMaaP NULL response received");
+            String errorMessage = "DMaaP NULL response received";
+            if (response != null) {
+                errorMessage = "Error respons " + response.getResponseCode() + " " + response.getResponseMessage()
+                    + " from DMaaP.";
+            }
+            throw new ServiceException(errorMessage);
         } else {
             logger.debug("DMaaP consumer received {} : {}", response.getResponseCode(), response.getResponseMessage());
             return response.getActualMessages();
@@ -98,19 +106,19 @@ public class DmaapMessageConsumer implements Runnable {
 
     private void processMsg(String msg) throws IOException {
         logger.debug("Message Reveived from DMAAP : {}", msg);
-        createDmaapMessageHandler().handleDmaapMsg(msg);
+        getDmaapMessageHandler().handleDmaapMsg(msg);
     }
 
-    private DmaapMessageHandler createDmaapMessageHandler() throws IOException {
+    private DmaapMessageHandler getDmaapMessageHandler() throws IOException {
         String agentBaseUrl = "http://localhost:" + this.localServerPort;
-        AsyncRestClient agentClient = new AsyncRestClient(agentBaseUrl);
+        AsyncRestClient agentClient = createRestClient(agentBaseUrl);
         Properties dmaapPublisherProperties = applicationConfig.getDmaapPublisherConfig();
-        MRBatchingPublisher producer = MRClientFactory.createBatchingPublisher(dmaapPublisherProperties);
+        MRBatchingPublisher producer = getMessageRouterPublisher(dmaapPublisherProperties);
 
-        return new DmaapMessageHandler(producer, agentClient);
+        return createDmaapMessageHandler(agentClient, producer);
     }
 
-    private boolean sleep(Duration duration) {
+    boolean sleep(Duration duration) {
         try {
             Thread.sleep(duration.toMillis());
             return true;
@@ -119,4 +127,20 @@ public class DmaapMessageConsumer implements Runnable {
             return false;
         }
     }
+
+    MRConsumer getMessageRouterConsumer(Properties dmaapConsumerProperties) throws IOException {
+        return MRClientFactory.createConsumer(dmaapConsumerProperties);
+    }
+
+    DmaapMessageHandler createDmaapMessageHandler(AsyncRestClient agentClient, MRBatchingPublisher producer) {
+        return new DmaapMessageHandler(producer, agentClient);
+    }
+
+    AsyncRestClient createRestClient(String agentBaseUrl) {
+        return new AsyncRestClient(agentBaseUrl);
+    }
+
+    MRBatchingPublisher getMessageRouterPublisher(Properties dmaapPublisherProperties) throws IOException {
+        return MRClientFactory.createBatchingPublisher(dmaapPublisherProperties);
+    }
 }