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

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