src/main/java/com/att/dmf/mr/backends/Publisher.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 com.att.dmf.mr.backends;
  23
  24 import java.io.IOException;
  25 import java.util.ArrayList;
  26 import java.util.List;
  27
  28 import org.apache.kafka.clients.producer.ProducerRecord;
  29
  30 import com.att.dmf.mr.beans.LogDetails;
  31
  32 /**
  33  * A publisher interface. Publishers receive messages and post them to a topic.
  34  * @author peter
  35  */
  36 public interface Publisher
  37 {
  38         /**
  39          * A message interface. The message has a key and a body.
  40          * @author peter
  41          */
  42         public interface message
  43         {
  44                 /**
  45                  * Get the key for this message. The key is used to partition messages
  46                  * into "sub-streams" that have guaranteed order. The key can be null,
  47                  * which means the message can be processed without any concern for order.
  48                  *
  49                  * @return a key, possibly null
  50                  */
  51                 String getKey();
  52
  53                 /**
  54                  * Get the message body.
  55                  * @return a message body
  56                  */
  57                 String getMessage();
  58                 /**
  59                  * set the logging params for transaction enabled logging
  60                  * @param logDetails
  61                  */
  62                 void setLogDetails (LogDetails logDetails);
  63                 /**
  64                  * Get the log details for transaction enabled logging
  65                  * @return LogDetails
  66                  */
  67                 LogDetails getLogDetails ();
  68
  69                 /**
  70                  * boolean transactionEnabled
  71                  * @return true/false
  72                  */
  73                 boolean isTransactionEnabled();
  74                 /**
  75                  * Set the transaction enabled flag from prop file or topic based implementation
  76                  * @param transactionEnabled
  77                  */
  78                 void setTransactionEnabled(boolean transactionEnabled);
  79         }
  80
  81         /**
  82          * Send a single message to a topic. Equivalent to sendMessages with a list of size 1.
  83          * @param topic
  84          * @param msg
  85          * @throws IOException
  86          */
  87         public void sendMessage ( String topic, message msg ) throws IOException;
  88
  89         /**
  90          * Send messages to a topic.
  91          * @param topic
  92          * @param msgs
  93          * @throws IOException
  94          */
  95         public void sendMessages ( String topic, List<? extends message> msgs ) throws IOException;
  96
  97         public void sendBatchMessageNew(String topic ,ArrayList<ProducerRecord<String,String>> kms) throws IOException;
  98         public void sendMessagesNew( String topic, List<? extends message> msgs ) throws IOException;
  99 }