TCA: Support for VES/A&AI enrichment
[dcaegen2/analytics/tca.git] / dcae-analytics-cdap-common / src / main / java / org / openecomp / dcae / apod / analytics / cdap / common / utils / DMaaPMRUtils.java
index 37acf9c..950f8c8 100644 (file)
-/*
- * ===============================LICENSE_START======================================
- *  dcae-analytics
- * ================================================================================
- *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- *  Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *          http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- *  ============================LICENSE_END===========================================
- */
-
-package org.openecomp.dcae.apod.analytics.cdap.common.utils;
-
-import co.cask.cdap.api.metrics.Metrics;
-import com.google.common.base.Optional;
-import com.google.common.base.Stopwatch;
-import org.openecomp.dcae.apod.analytics.cdap.common.CDAPMetricsConstants;
-import org.openecomp.dcae.apod.analytics.common.exception.DCAEAnalyticsRuntimeException;
-import org.openecomp.dcae.apod.analytics.common.utils.HTTPUtils;
-import org.openecomp.dcae.apod.analytics.dmaap.domain.response.DMaaPMRSubscriberResponse;
-import org.openecomp.dcae.apod.analytics.dmaap.service.subscriber.DMaaPMRSubscriber;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.util.List;
-
-/**
- * Utility common methods for DMaaP MR functionality
- *
- * @author Rajiv Singla . Creation Date: 2/6/2017.
- */
-public abstract class DMaaPMRUtils {
-
-    private static final Logger LOG = LoggerFactory.getLogger(DMaaPMRUtils.class);
-
-    private DMaaPMRUtils() {
-        // private constructor
-    }
-
-
-    /**
-     * Returns messages fetched from DMaaP MR Subscriber.
-     *
-     * @param subscriber DMaaP MR Subscriber instance
-     * @param metrics CDAP metrics
-     *
-     * @return messages fetched from DMaaP MR topic
-     */
-    public static Optional<List<String>> getSubscriberMessages(final DMaaPMRSubscriber subscriber,
-                                                               final Metrics metrics) {
-
-        final Optional<DMaaPMRSubscriberResponse> subscriberResponseOptional =
-                getSubscriberResponse(subscriber, metrics);
-
-        // If response is not present, unable to proceed
-        if (!subscriberResponseOptional.isPresent()) {
-            return Optional.absent();
-        }
-
-        final DMaaPMRSubscriberResponse subscriberResponse = subscriberResponseOptional.get();
-
-        // If response code return by the subscriber call is not successful, unable to do proceed
-        if (!HTTPUtils.isSuccessfulResponseCode(subscriberResponse.getResponseCode())) {
-            LOG.error("Subscriber was unable to fetch messages properly.Subscriber Response Code: {} " +
-                    "Unable to proceed further....", subscriberResponse.getResponseCode());
-            metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_UNSUCCESSFUL_RESPONSES_METRIC, 1);
-            return Optional.absent();
-        }
-
-        LOG.debug("Subscriber HTTP Response Status Code match successful:  {}", subscriberResponse,
-                HTTPUtils.HTTP_SUCCESS_STATUS_CODE);
-
-        final List<String> actualMessages = subscriberResponse.getFetchedMessages();
-
-        // If there are no message returned during from Subscriber, nothing to write to CDAP Stream
-        if (actualMessages.isEmpty()) {
-            LOG.debug("Subscriber Response has no messages. Nothing to write....");
-            metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_RESPONSES_WITH_NO_MESSAGES_METRIC, 1);
-            return Optional.absent();
-        }
-
-        LOG.debug("DMaaP MR Subscriber found new messages in DMaaP Topic. Message count: {}", actualMessages.size());
-        metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_TOTAL_MESSAGES_PROCESSED_METRIC, actualMessages.size());
-
-        return Optional.of(actualMessages);
-
-    }
-
-
-    /**
-     * Get Subscriber response and records time taken to fetch messages. Returns Optional.None if Subscriber response
-     * is null or response status code is not present
-     *
-     * @param subscriber - DMaaP Subscriber
-     * @param metrics - CDAP Metrics collector
-     *
-     * @return - Optional of Subscriber Response
-     */
-    public static Optional<DMaaPMRSubscriberResponse> getSubscriberResponse(final DMaaPMRSubscriber subscriber,
-                                                                            final Metrics metrics) {
-
-        // Record all response count from subscriber
-        metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_ALL_RESPONSES_COUNT_METRIC, 1);
-
-        // Check how long it took for subscriber to respond
-        final Stopwatch stopwatch = new Stopwatch();
-        stopwatch.start();
-
-        // Fetch messages from DMaaP MR Topic
-        DMaaPMRSubscriberResponse subscriberResponse = null;
-        try {
-            subscriberResponse = subscriber.fetchMessages();
-        } catch (DCAEAnalyticsRuntimeException e) {
-            LOG.error("Error while fetching messages for DMaaP MR Topic: {}", e);
-        }
-
-        stopwatch.stop();
-        final long subscriberResponseTimeMS = stopwatch.elapsedMillis();
-
-        // If response is null is null or response code is null, unable to proceed nothing to do
-        if (subscriberResponse == null || subscriberResponse.getResponseCode() == null) {
-            LOG.error("Subscriber Response is null or subscriber Response code is null. Unable to proceed further...");
-            return Optional.absent();
-        }
-
-        LOG.debug("Subscriber Response:{}, Subscriber HTTP Response Status Code {}, Subscriber Response Time(ms): {}",
-                subscriberResponse, subscriberResponse.getResponseCode(), subscriberResponseTimeMS);
-
-        // Record subscriber response time
-        metrics.gauge(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_RESPONSE_TIME_MS_METRIC, subscriberResponseTimeMS);
-
-        return Optional.of(subscriberResponse);
-    }
-
-}
+/*\r
+ * ===============================LICENSE_START======================================\r
+ *  dcae-analytics\r
+ * ================================================================================\r
+ *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * ================================================================================\r
+ *  Licensed under the Apache License, Version 2.0 (the "License");\r
+ *  you may not use this file except in compliance with the License.\r
+ *   You may obtain a copy of the License at\r
+ *\r
+ *          http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ *  Unless required by applicable law or agreed to in writing, software\r
+ *  distributed under the License is distributed on an "AS IS" BASIS,\r
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ *  See the License for the specific language governing permissions and\r
+ *  limitations under the License.\r
+ *  ============================LICENSE_END===========================================\r
+ */\r
+\r
+package org.openecomp.dcae.apod.analytics.cdap.common.utils;\r
+\r
+import co.cask.cdap.api.metrics.Metrics;\r
+import com.google.common.base.Optional;\r
+import com.google.common.base.Stopwatch;\r
+import org.openecomp.dcae.apod.analytics.cdap.common.CDAPMetricsConstants;\r
+import org.openecomp.dcae.apod.analytics.common.exception.DCAEAnalyticsRuntimeException;\r
+import org.openecomp.dcae.apod.analytics.common.utils.HTTPUtils;\r
+import org.openecomp.dcae.apod.analytics.dmaap.domain.response.DMaaPMRSubscriberResponse;\r
+import org.openecomp.dcae.apod.analytics.dmaap.service.subscriber.DMaaPMRSubscriber;\r
+import org.slf4j.Logger;\r
+import org.slf4j.LoggerFactory;\r
+\r
+import java.util.List;\r
+\r
+/**\r
+ * Utility common methods for DMaaP MR functionality\r
+ *\r
+ * @author Rajiv Singla . Creation Date: 2/6/2017.\r
+ */\r
+public abstract class DMaaPMRUtils {\r
+\r
+    private static final Logger LOG = LoggerFactory.getLogger(DMaaPMRUtils.class);\r
+\r
+    private DMaaPMRUtils() {\r
+        // private constructor\r
+    }\r
+\r
+\r
+    /**\r
+     * Returns messages fetched from DMaaP MR Subscriber.\r
+     *\r
+     * @param subscriber DMaaP MR Subscriber instance\r
+     * @param metrics CDAP metrics\r
+     *\r
+     * @return messages fetched from DMaaP MR topic\r
+     */\r
+    public static Optional<List<String>> getSubscriberMessages(final DMaaPMRSubscriber subscriber,\r
+                                                               final Metrics metrics) {\r
+\r
+        final Optional<DMaaPMRSubscriberResponse> subscriberResponseOptional =\r
+                getSubscriberResponse(subscriber, metrics);\r
+\r
+        // If response is not present, unable to proceed\r
+        if (!subscriberResponseOptional.isPresent()) {\r
+            return Optional.absent();\r
+        }\r
+\r
+        final DMaaPMRSubscriberResponse subscriberResponse = subscriberResponseOptional.get();\r
+\r
+        // If response code return by the subscriber call is not successful, unable to do proceed\r
+        if (!HTTPUtils.isSuccessfulResponseCode(subscriberResponse.getResponseCode())) {\r
+            LOG.error("Subscriber was unable to fetch messages properly.Subscriber Response Code: {} " +\r
+                    "Unable to proceed further....", subscriberResponse.getResponseCode());\r
+            metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_UNSUCCESSFUL_RESPONSES_METRIC, 1);\r
+            return Optional.absent();\r
+        }\r
+\r
+        LOG.debug("Subscriber HTTP Response Status Code match successful:  {}", subscriberResponse,\r
+                HTTPUtils.HTTP_SUCCESS_STATUS_CODE);\r
+\r
+        final List<String> actualMessages = subscriberResponse.getFetchedMessages();\r
+\r
+        // If there are no message returned during from Subscriber, nothing to write to CDAP Stream\r
+        if (actualMessages.isEmpty()) {\r
+            LOG.debug("Subscriber Response has no messages. Nothing to write....");\r
+            metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_RESPONSES_WITH_NO_MESSAGES_METRIC, 1);\r
+            return Optional.absent();\r
+        }\r
+\r
+        LOG.debug("DMaaP MR Subscriber found new messages in DMaaP Topic. Message count: {}", actualMessages.size());\r
+        metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_TOTAL_MESSAGES_PROCESSED_METRIC, actualMessages.size());\r
+\r
+        return Optional.of(actualMessages);\r
+\r
+    }\r
+\r
+\r
+    /**\r
+     * Get Subscriber response and records time taken to fetch messages. Returns Optional.None if Subscriber response\r
+     * is null or response status code is not present\r
+     *\r
+     * @param subscriber - DMaaP Subscriber\r
+     * @param metrics - CDAP Metrics collector\r
+     *\r
+     * @return - Optional of Subscriber Response\r
+     */\r
+    public static Optional<DMaaPMRSubscriberResponse> getSubscriberResponse(final DMaaPMRSubscriber subscriber,\r
+                                                                            final Metrics metrics) {\r
+\r
+        // Record all response count from subscriber\r
+        metrics.count(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_ALL_RESPONSES_COUNT_METRIC, 1);\r
+\r
+        // Check how long it took for subscriber to respond\r
+        final Stopwatch stopwatch = new Stopwatch();\r
+        stopwatch.start();\r
+\r
+        // Fetch messages from DMaaP MR Topic\r
+        DMaaPMRSubscriberResponse subscriberResponse = null;\r
+        try {\r
+            subscriberResponse = subscriber.fetchMessages();\r
+        } catch (DCAEAnalyticsRuntimeException e) {\r
+            LOG.error("Error while fetching messages for DMaaP MR Topic: {}", e);\r
+        }\r
+\r
+        stopwatch.stop();\r
+        final long subscriberResponseTimeMS = stopwatch.elapsedMillis();\r
+\r
+        // If response is null is null or response code is null, unable to proceed nothing to do\r
+        if (subscriberResponse == null || subscriberResponse.getResponseCode() == null) {\r
+            LOG.error("Subscriber Response is null or subscriber Response code is null. Unable to proceed further...");\r
+            return Optional.absent();\r
+        }\r
+\r
+        LOG.debug("Subscriber Response:{}, Subscriber HTTP Response Status Code {}, Subscriber Response Time(ms): {}",\r
+                subscriberResponse, subscriberResponse.getResponseCode(), subscriberResponseTimeMS);\r
+\r
+        // Record subscriber response time\r
+        metrics.gauge(CDAPMetricsConstants.DMAAP_MR_SUBSCRIBER_RESPONSE_TIME_MS_METRIC, subscriberResponseTimeMS);\r
+\r
+        return Optional.of(subscriberResponse);\r
+    }\r
+\r
+}\r