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.beans;
24 import java.util.Arrays;
25 import java.util.LinkedList;
26 import java.util.List;
27 import java.util.Properties;
29 import java.util.TreeSet;
30 import java.util.concurrent.ExecutionException;
32 import org.I0Itec.zkclient.ZkClient;
33 import org.I0Itec.zkclient.exception.ZkNoNodeException;
34 import org.apache.kafka.clients.admin.AdminClient;
35 import org.apache.kafka.clients.admin.AdminClientConfig;
36 import org.apache.kafka.clients.admin.CreateTopicsResult;
37 import org.apache.kafka.clients.admin.NewTopic;
38 import org.apache.kafka.common.KafkaFuture;
39 import org.json.JSONObject;
40 import org.json.JSONArray;
41 import org.springframework.beans.factory.annotation.Qualifier;
42 import org.springframework.util.StringUtils;
43 import org.onap.dmaap.dmf.mr.CambriaApiException;
44 import org.onap.dmaap.dmf.mr.constants.CambriaConstants;
45 import org.onap.dmaap.dmf.mr.metabroker.Broker1;
46 import org.onap.dmaap.dmf.mr.metabroker.Topic;
47 import org.onap.dmaap.dmf.mr.utils.ConfigurationReader;
48 import org.onap.dmaap.dmf.mr.utils.Utils;
49 import com.att.eelf.configuration.EELFLogger;
50 import com.att.eelf.configuration.EELFManager;
52 import com.att.nsa.configs.ConfigDb;
53 import com.att.nsa.configs.ConfigDbException;
54 import com.att.nsa.configs.ConfigPath;
55 import com.att.nsa.drumlin.service.standards.HttpStatusCodes;
56 import com.att.nsa.drumlin.till.data.stringUtils;
57 import com.att.nsa.drumlin.till.nv.rrNvReadable;
58 import com.att.nsa.security.NsaAcl;
59 import com.att.nsa.security.NsaAclUtils;
60 import com.att.nsa.security.NsaApiKey;
64 * class performing all topic operations
66 * @author anowarul.islam
70 public class DMaaPKafkaMetaBroker implements Broker1 {
72 public DMaaPKafkaMetaBroker() {
74 fCambriaConfig = null;
75 fBaseTopicData = null;
76 final Properties props = new Properties ();
77 String fkafkaBrokers = com.att.ajsc.filemonitor.AJSCPropertiesMap.getProperty(CambriaConstants.msgRtr_prop,
78 "kafka.metadata.broker.list");
79 if (StringUtils.isEmpty(fkafkaBrokers)) {
81 fkafkaBrokers = "localhost:9092";
84 props.put(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG, fkafkaBrokers );
85 if(Utils.isCadiEnabled()){
86 props.put("sasl.jaas.config", "org.apache.kafka.common.security.plain.PlainLoginModule required username='admin' password='"+Utils.getKafkaproperty()+"';");
87 props.put(AdminClientConfig.SECURITY_PROTOCOL_CONFIG, "SASL_PLAINTEXT");
88 props.put("sasl.mechanism", "PLAIN");
91 fKafkaAdminClient=AdminClient.create ( props );
95 private static final EELFLogger log = EELFManager.getInstance().getLogger(ConfigurationReader.class);
96 private final AdminClient fKafkaAdminClient;
101 * DMaaPKafkaMetaBroker constructor initializing
107 public DMaaPKafkaMetaBroker(@Qualifier("propertyReader") rrNvReadable settings,
108 @Qualifier("dMaaPZkClient") ZkClient zk, @Qualifier("dMaaPZkConfigDb") ConfigDb configDb) {
110 fCambriaConfig = configDb;
111 fBaseTopicData = configDb.parse("/topics");
112 final Properties props = new Properties ();
113 String fkafkaBrokers = com.att.ajsc.filemonitor.AJSCPropertiesMap.getProperty(CambriaConstants.msgRtr_prop,
114 "kafka.metadata.broker.list");
115 if (null == fkafkaBrokers) {
117 fkafkaBrokers = "localhost:9092";
120 if(Utils.isCadiEnabled()){
121 props.put("sasl.jaas.config", "org.apache.kafka.common.security.plain.PlainLoginModule required username='admin' password='"+Utils.getKafkaproperty()+"';");
122 props.put(AdminClientConfig.SECURITY_PROTOCOL_CONFIG, "SASL_PLAINTEXT");
123 props.put("sasl.mechanism", "PLAIN");
125 props.put(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG, fkafkaBrokers );
127 fKafkaAdminClient=AdminClient.create ( props );
133 public DMaaPKafkaMetaBroker( rrNvReadable settings,
134 ZkClient zk, ConfigDb configDb,AdminClient client) {
137 fCambriaConfig = configDb;
138 fBaseTopicData = configDb.parse("/topics");
139 fKafkaAdminClient= client;
146 public List<Topic> getAllTopics() throws ConfigDbException {
147 log.info("Retrieving list of all the topics.");
148 final LinkedList<Topic> result = new LinkedList<>();
150 log.info("Retrieving all topics from root: " + zkTopicsRoot);
151 final List<String> topics = fZk.getChildren(zkTopicsRoot);
152 for (String topic : topics) {
153 result.add(new KafkaTopic(topic, fCambriaConfig, fBaseTopicData));
155 JSONObject dataObj = new JSONObject();
156 dataObj.put("topics", new JSONObject());
158 for (String topic : topics) {
159 dataObj.getJSONObject("topics").put(topic, new JSONObject());
161 } catch (ZkNoNodeException excp) {
162 // very fresh kafka doesn't have any topics or a topics node
163 log.error("ZK doesn't have a Kakfa topics node at " + zkTopicsRoot, excp);
169 public Topic getTopic(String topic) throws ConfigDbException {
170 if (fZk.exists(zkTopicsRoot + "/" + topic)) {
171 return getKafkaTopicConfig(fCambriaConfig, fBaseTopicData, topic);
173 // else: no such topic in kafka
178 * static method get KafkaTopic object
184 * @throws ConfigDbException
186 public static KafkaTopic getKafkaTopicConfig(ConfigDb db, ConfigPath base, String topic) throws ConfigDbException {
187 return new KafkaTopic(topic, db, base);
194 public Topic createTopic(String topic, String desc, String ownerApiKey, int partitions, int replicas,
195 boolean transactionEnabled) throws TopicExistsException, CambriaApiException,ConfigDbException {
196 log.info("Creating topic: " + topic);
198 log.info("Check if topic [" + topic + "] exist.");
199 // first check for existence "our way"
200 final Topic t = getTopic(topic);
202 log.info("Could not create topic [" + topic + "]. Topic Already exists.");
203 throw new TopicExistsException("Could not create topic [" + topic + "]. Topic Alreay exists.");
205 } catch (ConfigDbException e1) {
206 log.error("Topic [" + topic + "] could not be created. Couldn't check topic data in config db.", e1);
207 throw new CambriaApiException(HttpStatusCodes.k503_serviceUnavailable,
208 "Couldn't check topic data in config db.");
211 // we only allow 3 replicas. (If we don't test this, we get weird
212 // results from the cluster,
213 // so explicit test and fail.)
214 if (replicas < 1 || replicas > 3) {
215 log.info("Topic [" + topic + "] could not be created. The replica count must be between 1 and 3.");
216 throw new CambriaApiException(HttpStatusCodes.k400_badRequest,
217 "The replica count must be between 1 and 3.");
219 if (partitions < 1) {
220 log.info("Topic [" + topic + "] could not be created. The partition count must be at least 1.");
221 throw new CambriaApiException(HttpStatusCodes.k400_badRequest, "The partition count must be at least 1.");
228 final NewTopic topicRequest = new NewTopic ( topic, partitions, new Integer(replicas).shortValue() );
229 final CreateTopicsResult ctr = fKafkaAdminClient.createTopics ( Arrays.asList ( topicRequest ) );
230 final KafkaFuture<Void> ctrResult = ctr.all ();
232 // underlying Kafka topic created. now setup our API info
233 return createTopicEntry ( topic, desc, ownerApiKey, transactionEnabled );
235 catch ( InterruptedException e )
238 log.warn ( "Execution of describeTopics timed out." );
239 throw new ConfigDbException ( e );
241 catch ( ExecutionException e )
244 log.warn ( "Execution of describeTopics failed: " + e.getCause ().getMessage (), e.getCause () );
245 throw new ConfigDbException ( e.getCause () );
251 public void deleteTopic(String topic) throws CambriaApiException, TopicExistsException,ConfigDbException {
252 log.info("Deleting topic: " + topic);
254 log.info("Loading zookeeper client for topic deletion.");
255 // topic creation. (Otherwise, the topic is only partially created
259 fKafkaAdminClient.deleteTopics(Arrays.asList(topic));
260 log.info("Zookeeper client loaded successfully. Deleting topic.");
262 } catch (Exception e) {
263 log.error("Failed to delete topic [" + topic + "]. " + e.getMessage(), e);
264 throw new ConfigDbException(e);
266 log.info("Closing zookeeper connection.");
270 private final ZkClient fZk;
271 private final ConfigDb fCambriaConfig;
272 private final ConfigPath fBaseTopicData;
274 private static final String zkTopicsRoot = "/brokers/topics";
275 private static final JSONObject kEmptyAcl = new JSONObject();
278 * method Providing KafkaTopic Object associated with owner and
279 * transactionenabled or not
284 * @param transactionEnabled
286 * @throws ConfigDbException
288 public KafkaTopic createTopicEntry(String name, String desc, String owner, boolean transactionEnabled)
289 throws ConfigDbException {
290 return createTopicEntry(fCambriaConfig, fBaseTopicData, name, desc, owner, transactionEnabled);
294 * static method giving kafka topic object
301 * @param transactionEnabled
303 * @throws ConfigDbException
305 public static KafkaTopic createTopicEntry(ConfigDb db, ConfigPath basePath, String name, String desc, String owner,
306 boolean transactionEnabled) throws ConfigDbException {
307 final JSONObject o = new JSONObject();
308 o.put("owner", owner);
309 o.put("description", desc);
310 o.put("txenabled", transactionEnabled);
311 db.store(basePath.getChild(name), o.toString());
312 return new KafkaTopic(name, db, basePath);
316 * class performing all user opearation like user is eligible to read,
317 * write. permitting a user to write and read,
319 * @author anowarul.islam
322 public static class KafkaTopic implements Topic {
324 * constructor initializes
329 * @throws ConfigDbException
331 public KafkaTopic(String name, ConfigDb configdb, ConfigPath baseTopic) throws ConfigDbException {
333 fConfigDb = configdb;
334 fBaseTopicData = baseTopic;
336 String data = fConfigDb.load(fBaseTopicData.getChild(fName));
341 final JSONObject o = new JSONObject(data);
342 fOwner = o.optString("owner", "");
343 fDesc = o.optString("description", "");
344 fTransactionEnabled = o.optBoolean("txenabled", false);// default
347 // if this topic has an owner, it needs both read/write ACLs. If there's no
348 // owner (or it's empty), null is okay -- this is for existing or implicitly
350 JSONObject readers = o.optJSONObject ( "readers" );
351 if ( readers == null && fOwner.length () > 0 ) readers = kEmptyAcl;
352 fReaders = fromJson ( readers );
354 JSONObject writers = o.optJSONObject ( "writers" );
355 if ( writers == null && fOwner.length () > 0 ) writers = kEmptyAcl;
356 fWriters = fromJson ( writers );
359 private NsaAcl fromJson(JSONObject o) {
360 NsaAcl acl = new NsaAcl();
362 JSONArray a = o.optJSONArray("allowed");
364 for (int i = 0; i < a.length(); ++i) {
365 String user = a.getString(i);
374 public String getName() {
379 public String getOwner() {
384 public String getDescription() {
389 public NsaAcl getReaderAcl() {
394 public NsaAcl getWriterAcl() {
399 public void checkUserRead(NsaApiKey user) throws AccessDeniedException {
400 NsaAclUtils.checkUserAccess ( fOwner, getReaderAcl(), user );
404 public void checkUserWrite(NsaApiKey user) throws AccessDeniedException {
405 NsaAclUtils.checkUserAccess ( fOwner, getWriterAcl(), user );
409 public void permitWritesFromUser(String pubId, NsaApiKey asUser)
410 throws ConfigDbException, AccessDeniedException {
411 updateAcl(asUser, false, true, pubId);
415 public void denyWritesFromUser(String pubId, NsaApiKey asUser) throws ConfigDbException, AccessDeniedException {
416 updateAcl(asUser, false, false, pubId);
420 public void permitReadsByUser(String consumerId, NsaApiKey asUser)
421 throws ConfigDbException, AccessDeniedException {
422 updateAcl(asUser, true, true, consumerId);
426 public void denyReadsByUser(String consumerId, NsaApiKey asUser)
427 throws ConfigDbException, AccessDeniedException {
428 updateAcl(asUser, true, false, consumerId);
431 private void updateAcl(NsaApiKey asUser, boolean reader, boolean add, String key)
432 throws ConfigDbException, AccessDeniedException{
435 final NsaAcl acl = NsaAclUtils.updateAcl ( this, asUser, key, reader, add );
437 // we have to assume we have current data, or load it again. for the expected use
438 // case, assuming we can overwrite the data is fine.
439 final JSONObject o = new JSONObject ();
440 o.put ( "owner", fOwner );
441 o.put ( "readers", safeSerialize ( reader ? acl : fReaders ) );
442 o.put ( "writers", safeSerialize ( reader ? fWriters : acl ) );
443 fConfigDb.store ( fBaseTopicData.getChild ( fName ), o.toString () );
445 log.info ( "ACL_UPDATE: " + asUser.getKey () + " " + ( add ? "added" : "removed" ) + ( reader?"subscriber":"publisher" ) + " " + key + " on " + fName );
448 catch ( ConfigDbException x )
452 catch ( AccessDeniedException x )
459 private JSONObject safeSerialize(NsaAcl acl) {
460 return acl == null ? null : acl.serialize();
463 private final String fName;
464 private final ConfigDb fConfigDb;
465 private final ConfigPath fBaseTopicData;
466 private final String fOwner;
467 private final String fDesc;
468 private final NsaAcl fReaders;
469 private final NsaAcl fWriters;
470 private boolean fTransactionEnabled;
472 public boolean isTransactionEnabled() {
473 return fTransactionEnabled;
477 public Set<String> getOwners() {
478 final TreeSet<String> owners = new TreeSet<>();
479 owners.add ( fOwner );