src/main/java/org/onap/dmaap/mr/client/MRConsumer.java

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   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  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *  ============LICENSE_END=========================================================
  18  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  *
  21  *******************************************************************************/
  22 package org.onap.dmaap.mr.client;
  23
  24 import java.io.IOException;
  25
  26 import org.onap.dmaap.mr.client.response.MRConsumerResponse;
  27
  28 public interface MRConsumer extends MRClient
  29 {
  30         /**
  31          * Fetch a set of messages. The consumer's timeout and message limit are used if set in the constructor call.
  32
  33          * @return a set of messages
  34          * @throws IOException
  35          */
  36         Iterable<String> fetch ()  throws IOException, Exception;
  37
  38         /**
  39          * Fetch a set of messages with an explicit timeout and limit for this call. These values
  40          * override any set in the constructor call.
  41          *
  42          * @param timeoutMs     The amount of time in milliseconds that the server should keep the connection
  43          * open while waiting for message traffic. Use -1 for default timeout (controlled on the server-side).
  44          * @param limit A limit on the number of messages returned in a single call. Use -1 for no limit.
  45          * @return a set messages
  46          * @throws IOException if there's a problem connecting to the server
  47          */
  48         Iterable<String> fetch ( int timeoutMs, int limit )  throws IOException, Exception;
  49
  50         MRConsumerResponse fetchWithReturnConsumerResponse ();
  51
  52
  53         MRConsumerResponse fetchWithReturnConsumerResponse ( int timeoutMs, int limit );
  54 }