appc-adapters/appc-dmaap-adapter/appc-message-adapter-api/src/main/java/org/onap/appc/adapter/message/Consumer.java

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