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.metabroker;
24 import com.att.nsa.configs.ConfigDbException;
25 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
26 import org.onap.dmaap.dmf.mr.CambriaApiException;
28 import java.util.List;
31 * A broker interface to manage metadata around topics, etc.
36 public interface Broker {
39 * @author anowarul.islam
42 public class TopicExistsException extends Exception {
47 public TopicExistsException(String topicName) {
48 super("Topic " + topicName + " exists.");
51 private static final long serialVersionUID = 1L;
55 * Get all topics in the underlying broker.
58 * @throws ConfigDbException
60 List<Topic> getAllTopics() throws ConfigDbException;
63 * Get a specific topic from the underlying broker.
66 * @return a topic, or null
68 Topic getTopic(String topic) throws ConfigDbException;
78 * @param transactionEnabled
80 * @throws TopicExistsException
81 * @throws CambriaApiException
83 Topic createTopic(String topic, String description, String ownerApiKey, int partitions, int replicas,
84 boolean transactionEnabled) throws TopicExistsException, CambriaApiException,ConfigDbException;
87 * Delete a topic by name
91 void deleteTopic(String topic) throws AccessDeniedException, CambriaApiException, TopicExistsException,ConfigDbException;