dcae-analytics-dmaap/src/main/java/org/openecomp/dcae/apod/analytics/dmaap/service/subscriber/DMaaPMRSubscriber.java

   1 /*\r
   2  * ===============================LICENSE_START======================================\r
   3  *  dcae-analytics\r
   4  * ================================================================================\r
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * ================================================================================\r
   7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
   8  *  you may not use this file except in compliance with the License.\r
   9  *   You may obtain a copy of the License at\r
  10  *\r
  11  *          http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  *  Unless required by applicable law or agreed to in writing, software\r
  14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  *  See the License for the specific language governing permissions and\r
  17  *  limitations under the License.\r
  18  *  ============================LICENSE_END===========================================\r
  19  */\r
  20 \r
  21 package org.openecomp.dcae.apod.analytics.dmaap.service.subscriber;\r
  22 \r
  23 import org.openecomp.dcae.apod.analytics.dmaap.domain.config.DMaaPMRPublisherConfig;\r
  24 import org.openecomp.dcae.apod.analytics.dmaap.domain.response.DMaaPMRSubscriberResponse;\r
  25 \r
  26 import java.util.Date;\r
  27 \r
  28 /**\r
  29  * <p>\r
  30  *     DMaaP MR Subscriber can be used to subscribe messages from DMaaP MR Topics.\r
  31  * <p>\r
  32  *\r
  33  * @author Rajiv Singla . Creation Date: 10/13/2016.\r
  34  */\r
  35 public interface DMaaPMRSubscriber extends AutoCloseable {\r
  36 \r
  37     /**\r
  38      * Fetches Messages from DMaaP MR Topic. {@link DMaaPMRPublisherConfig} settings parameters\r
  39      * for messageLimit and message timeout are used\r
  40      *\r
  41      * @return DMaaP Message Router Subscriber Response\r
  42      */\r
  43     DMaaPMRSubscriberResponse fetchMessages();\r
  44 \r
  45 \r
  46     /**\r
  47      * Returns the Subscriber instance creation time\r
  48      * <p>\r
  49      * NOTE: Due to DMaaP API Design - Subscribers can only fetch messages which\r
  50      * are published to the topic after the creation of the Subscriber.\r
  51      *\r
  52      * @return creation time of Subscriber instance\r
  53      */\r
  54     Date getSubscriberCreationTime();\r
  55 \r
  56 \r
  57 }\r