appc-client/client-lib/src/main/java/org/openecomp/appc/client/impl/protocol/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.client.impl.protocol;
  26
  27 import java.io.IOException;
  28 import java.util.List;
  29
  30 interface Consumer {
  31
  32         /**
  33          * Gets a batch of messages from the topic. Defaults to 1000 messages with 15s wait for messages if empty.
  34          *
  35          * @return A list of strings representing the messages pulled from the topic.
  36          * @throws IOException
  37          */
  38         List<String> fetch() throws IOException;
  39
  40         /**
  41          * Gets a batch of messages from the topic.
  42          *
  43          * @param limit The amount of messages to fetch
  44          * @return A list of strings representing the messages pulled from the topic.
  45          * @throws IOException
  46          */
  47         List<String> fetch(int limit) throws IOException;
  48
  49         /**
  50         * Send dummy fetch request to register client to be able to fetch messages
  51         * @throws IOException
  52         */
  53         void registerForRead() throws IOException;
  54
  55         void close();
  56 }