appc-adapters/appc-dmaap-adapter/appc-dmaap-adapter-bundle/src/main/java/org/openecomp/appc/adapter/dmaap/Consumer.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.appc.adapter.dmaap;
  23
  24 import java.util.List;
  25
  26 public interface Consumer {
  27
  28     /**
  29      * Gets a batch of messages from the topic. Defaults to 1000 messages with 15s wait for messages if empty.
  30      *
  31      * @return A list of strings representing the messages pulled from the topic.
  32      */
  33     public List<String> fetch();
  34
  35     /**
  36      * Gets a batch of messages from the topic.
  37      *
  38      * @param waitMs
  39      *            The amount of time to wait in milliseconds if the topic is empty for data to be written. Should be no
  40      *            less than 15000ms to prevent too many requests
  41      * @param limit
  42      *            The amount of messages to fetch
  43      * @return A list of strings representing the messages pulled from the topic.
  44      */
  45     public List<String> fetch(int waitMs, int limit);
  46
  47     /**
  48      * Updates the api credentials for making authenticated requests
  49      *
  50      * @param apiKey
  51      *            The public key to authenticate with
  52      * @param apiSecret
  53      *            The secret key to authenticate with
  54      */
  55     public void updateCredentials(String apiKey, String apiSecret);
  56
  57     // TODO - Implement once Cambria allows you to set outside of constructor
  58     // public void setFilter(String filter);
  59
  60     /**
  61      * Creates a dmaap client using a https connection
  62      *
  63      * @param yes
  64      *            True if https should be used, false otherwise
  65      */
  66     public void useHttps(boolean yes);
  67
  68 }