gerrit.onap Code Review - appc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (C) 2017 Amdocs
   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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22
  23 package org.openecomp.appc.adapter.message;
  24
  25 import java.util.List;
  26
  27 public interface Consumer {
  28
  29     /**
  30      * Gets a batch of messages from the topic. Defaults to 1000 messages with 15s wait for messages if empty.
  31      *
  32      * @return A list of strings representing the messages pulled from the topic.
  33      */
  34     public List<String> fetch();
  35
  36     /**
  37      * Gets a batch of messages from the topic.
  38      *
  39      * @param waitMs
  40      *            The amount of time to wait in milliseconds if the topic is empty for data to be written. Should be no
  41      *            less than 15000ms to prevent too many requests
  42      * @param limit
  43      *            The amount of messages to fetch
  44      * @return A list of strings representing the messages pulled from the topic.
  45      */
  46     public List<String> fetch(int waitMs, int limit);
  47
  48     /**
  49      * Updates the api credentials for making authenticated requests
  50      *
  51      * @param apiKey
  52      *            The public key to authenticate with
  53      * @param apiSecret
  54      *            The secret key to authenticate with
  55      */
  56     public void updateCredentials(String apiKey, String apiSecret);
  57
  58     /**
  59      * Creates a dmaap client using a https connection
  60      *
  61      * @param yes
  62      *            True if https should be used, false otherwise
  63      */
  64     public void useHttps(boolean yes);
  65
  66     /**
  67      * Closes the dmaap client https connection
  68      */
  69     void close();
  70
  71 }