1 /*******************************************************************************
2 * ============LICENSE_START=======================================================
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
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=========================================================
19 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 *******************************************************************************/
22 package org.onap.dmaap.dmf.mr.backends;
24 import org.apache.kafka.clients.producer.ProducerRecord;
25 import org.onap.dmaap.dmf.mr.beans.LogDetails;
27 import java.io.IOException;
28 import java.util.ArrayList;
29 import java.util.List;
32 * A publisher interface. Publishers receive messages and post them to a topic.
35 public interface Publisher
38 * A message interface. The message has a key and a body.
41 public interface message
44 * Get the key for this message. The key is used to partition messages
45 * into "sub-streams" that have guaranteed order. The key can be null,
46 * which means the message can be processed without any concern for order.
48 * @return a key, possibly null
53 * Get the message body.
54 * @return a message body
58 * set the logging params for transaction enabled logging
61 void setLogDetails (LogDetails logDetails);
63 * Get the log details for transaction enabled logging
66 LogDetails getLogDetails ();
69 * boolean transactionEnabled
72 boolean isTransactionEnabled();
74 * Set the transaction enabled flag from prop file or topic based implementation
75 * @param transactionEnabled
77 void setTransactionEnabled(boolean transactionEnabled);
81 * Send a single message to a topic. Equivalent to sendMessages with a list of size 1.
86 public void sendMessage ( String topic, message msg ) throws IOException;
89 * Send messages to a topic.
94 public void sendMessages ( String topic, List<? extends message> msgs ) throws IOException;
96 public void sendBatchMessageNew(String topic ,ArrayList<ProducerRecord<String,String>> kms) throws IOException;
97 public void sendMessagesNew( String topic, List<? extends message> msgs ) throws IOException;