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

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   4  *  ================================================================================
   5  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  *  ================================================================================
   7  *  Modifications Copyright © 2021 Orange.
   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  *        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  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  *
  23  *******************************************************************************/
  24
  25 package org.onap.dmaap.mr.client;
  26
  27 import java.io.IOException;
  28 import java.util.List;
  29 import java.util.concurrent.TimeUnit;
  30 import org.onap.dmaap.mr.client.response.MRPublisherResponse;
  31
  32 /**
  33  * A MR batching publisher is a publisher with additional functionality
  34  * for managing delayed sends.
  35  *
  36  * @author author
  37  */
  38 public interface MRBatchingPublisher extends MRPublisher {
  39     /**
  40      * Get the number of messages that have not yet been sent.
  41      *
  42      * @return the number of pending messages
  43      */
  44     int getPendingMessageCount();
  45
  46     /**
  47      * Close this publisher, sending any remaining messages.
  48      *
  49      * @param timeout      an amount of time to wait for unsent messages to be sent
  50      * @param timeoutUnits the time unit for the timeout arg
  51      * @return a list of any unsent messages after the timeout
  52      * @throws IOException          exception
  53      * @throws InterruptedException exception
  54      */
  55     List<Message> close(long timeout, TimeUnit timeoutUnits) throws IOException, InterruptedException;
  56
  57     MRPublisherResponse sendBatchWithResponse();
  58 }