src/main/java/com/att/dmf/mr/beans/DMaaPKafkaMetaBroker.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.beans;
  23
  24 import java.util.Arrays;
  25 import java.util.LinkedList;
  26 import java.util.List;
  27 import java.util.Properties;
  28 import java.util.Set;
  29 import java.util.TreeSet;
  30 import java.util.concurrent.ExecutionException;
  31
  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.stereotype.Component;
  43
  44 import com.att.dmf.mr.CambriaApiException;
  45 import com.att.dmf.mr.constants.CambriaConstants;
  46 import com.att.dmf.mr.metabroker.Broker;
  47 import com.att.dmf.mr.metabroker.Broker1;
  48 import com.att.dmf.mr.metabroker.Topic;
  49 import com.att.dmf.mr.utils.ConfigurationReader;
  50 import com.att.dmf.mr.utils.Utils;
  51 //import org.apache.log4-j.Logger;
  52 import com.att.eelf.configuration.EELFLogger;
  53 import com.att.eelf.configuration.EELFManager;
  54
  55 import com.att.nsa.configs.ConfigDb;
  56 import com.att.nsa.configs.ConfigDbException;
  57 import com.att.nsa.configs.ConfigPath;
  58 import com.att.nsa.drumlin.service.standards.HttpStatusCodes;
  59 import com.att.nsa.drumlin.till.nv.rrNvReadable;
  60 import com.att.nsa.security.NsaAcl;
  61 import com.att.nsa.security.NsaAclUtils;
  62 import com.att.nsa.security.NsaApiKey;
  63
  64
  65 /**
  66  * class performing all topic operations
  67  *
  68  * @author anowarul.islam
  69  *
  70  */
  71 //@Component
  72 public class DMaaPKafkaMetaBroker implements Broker1 {
  73
  74         public DMaaPKafkaMetaBroker() {
  75                 fZk = null;
  76                 fCambriaConfig = null;
  77                 fBaseTopicData = null;
  78                 final Properties props = new Properties ();
  79                 String fkafkaBrokers = com.att.ajsc.filemonitor.AJSCPropertiesMap.getProperty(CambriaConstants.msgRtr_prop,
  80                                 "kafka.metadata.broker.list");
  81                 if (null == fkafkaBrokers) {
  82
  83                         fkafkaBrokers = "localhost:9092";
  84                 }
  85
  86              props.put(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG, fkafkaBrokers );
  87              props.put("sasl.jaas.config", "org.apache.kafka.common.security.plain.PlainLoginModule required username='admin' password='"+Utils.getKafkaproperty()+"';");
  88                  props.put(AdminClientConfig.SECURITY_PROTOCOL_CONFIG, "SASL_PLAINTEXT");
  89              props.put("sasl.mechanism", "PLAIN");
  90
  91              fKafkaAdminClient=AdminClient.create ( props );
  92
  93         }
  94
  95         //private static final Logger log = Logger.getLogger(DMaaPKafkaMetaBroker.class);
  96         private static final EELFLogger log = EELFManager.getInstance().getLogger(ConfigurationReader.class);
  97         private final AdminClient fKafkaAdminClient;
  98
  99
 100
 101         /**
 102          * DMaaPKafkaMetaBroker constructor initializing
 103          *
 104          * @param settings
 105          * @param zk
 106          * @param configDb
 107          */
 108         public DMaaPKafkaMetaBroker(@Qualifier("propertyReader") rrNvReadable settings,
 109                         @Qualifier("dMaaPZkClient") ZkClient zk, @Qualifier("dMaaPZkConfigDb") ConfigDb configDb) {
 110                 //fSettings = settings;
 111                 fZk = zk;
 112                 fCambriaConfig = configDb;
 113                 fBaseTopicData = configDb.parse("/topics");
 114                 final Properties props = new Properties ();
 115                 String fkafkaBrokers = com.att.ajsc.filemonitor.AJSCPropertiesMap.getProperty(CambriaConstants.msgRtr_prop,
 116                                 "kafka.metadata.broker.list");
 117                 if (null == fkafkaBrokers) {
 118
 119                         fkafkaBrokers = "localhost:9092";
 120                 }
 121
 122
 123                  props.put("sasl.jaas.config", "org.apache.kafka.common.security.plain.PlainLoginModule required username='admin' password='"+Utils.getKafkaproperty()+"';");
 124                  props.put(AdminClientConfig.SECURITY_PROTOCOL_CONFIG, "SASL_PLAINTEXT");
 125              props.put("sasl.mechanism", "PLAIN");
 126              props.put(AdminClientConfig.BOOTSTRAP_SERVERS_CONFIG, fkafkaBrokers );
 127
 128              fKafkaAdminClient=AdminClient.create ( props );
 129
 130
 131
 132         }
 133
 134         public DMaaPKafkaMetaBroker( rrNvReadable settings,
 135                         ZkClient zk,  ConfigDb configDb,AdminClient client) {
 136
 137                 fZk = zk;
 138                 fCambriaConfig = configDb;
 139                 fBaseTopicData = configDb.parse("/topics");
 140             fKafkaAdminClient= client;
 141
 142
 143
 144         }
 145
 146         @Override
 147         public List<Topic> getAllTopics() throws ConfigDbException {
 148                 log.info("Retrieving list of all the topics.");
 149                 final LinkedList<Topic> result = new LinkedList<Topic>();
 150                 try {
 151                         log.info("Retrieving all topics from root: " + zkTopicsRoot);
 152                         final List<String> topics = fZk.getChildren(zkTopicsRoot);
 153                         for (String topic : topics) {
 154                                 result.add(new KafkaTopic(topic, fCambriaConfig, fBaseTopicData));
 155                         }
 156                         JSONObject dataObj = new JSONObject();
 157                         dataObj.put("topics", new JSONObject());
 158
 159                         for (String topic : topics) {
 160                                 dataObj.getJSONObject("topics").put(topic, new JSONObject());
 161                         }
 162                 } catch (ZkNoNodeException excp) {
 163                         // very fresh kafka doesn't have any topics or a topics node
 164                         log.error("ZK doesn't have a Kakfa topics node at " + zkTopicsRoot, excp);
 165                 }
 166                 return result;
 167         }
 168
 169         @Override
 170         public Topic getTopic(String topic) throws ConfigDbException {
 171                 if (fZk.exists(zkTopicsRoot + "/" + topic)) {
 172                         return getKafkaTopicConfig(fCambriaConfig, fBaseTopicData, topic);
 173                 }
 174                 // else: no such topic in kafka
 175                 return null;
 176         }
 177
 178         /**
 179          * static method get KafkaTopic object
 180          *
 181          * @param db
 182          * @param base
 183          * @param topic
 184          * @return
 185          * @throws ConfigDbException
 186          */
 187         public static KafkaTopic getKafkaTopicConfig(ConfigDb db, ConfigPath base, String topic) throws ConfigDbException {
 188                 return new KafkaTopic(topic, db, base);
 189         }
 190
 191         /**
 192          * creating topic
 193          */
 194         @Override
 195         public Topic createTopic(String topic, String desc, String ownerApiKey, int partitions, int replicas,
 196                         boolean transactionEnabled) throws TopicExistsException, CambriaApiException,ConfigDbException {
 197                 log.info("Creating topic: " + topic);
 198                 try {
 199                         log.info("Check if topic [" + topic + "] exist.");
 200                         // first check for existence "our way"
 201                         final Topic t = getTopic(topic);
 202                         if (t != null) {
 203                                 log.info("Could not create topic [" + topic + "]. Topic Already exists.");
 204                                 throw new TopicExistsException("Could not create topic [" + topic + "]. Topic Alreay exists.");
 205                         }
 206                 } catch (ConfigDbException e1) {
 207                         log.error("Topic [" + topic + "] could not be created. Couldn't check topic data in config db.", e1);
 208                         throw new CambriaApiException(HttpStatusCodes.k503_serviceUnavailable,
 209                                         "Couldn't check topic data in config db.");
 210                 }
 211
 212                 // we only allow 3 replicas. (If we don't test this, we get weird
 213                 // results from the cluster,
 214                 // so explicit test and fail.)
 215                 if (replicas < 1 || replicas > 3) {
 216                         log.info("Topic [" + topic + "] could not be created. The replica count must be between 1 and 3.");
 217                         throw new CambriaApiException(HttpStatusCodes.k400_badRequest,
 218                                         "The replica count must be between 1 and 3.");
 219                 }
 220                 if (partitions < 1) {
 221                         log.info("Topic [" + topic + "] could not be created. The partition count must be at least 1.");
 222                         throw new CambriaApiException(HttpStatusCodes.k400_badRequest, "The partition count must be at least 1.");
 223                 }
 224
 225                 // create via kafka
 226
 227                         try
 228                         {
 229                                 final NewTopic topicRequest = new NewTopic ( topic, partitions, new Integer(replicas).shortValue () );
 230                                 final CreateTopicsResult ctr = fKafkaAdminClient.createTopics ( Arrays.asList ( topicRequest ) );
 231                                 final KafkaFuture<Void> ctrResult = ctr.all ();
 232                                 ctrResult.get ();
 233                                 // underlying Kafka topic created. now setup our API info
 234                                 return createTopicEntry ( topic, desc, ownerApiKey, transactionEnabled );
 235                         }
 236                         catch ( InterruptedException e )
 237                         {
 238
 239                                 log.warn ( "Execution of describeTopics timed out." );
 240                                 throw new ConfigDbException ( e );
 241                         }
 242                         catch ( ExecutionException e )
 243                         {
 244
 245                                 log.warn ( "Execution of describeTopics failed: " + e.getCause ().getMessage (), e.getCause () );
 246                                 throw new ConfigDbException ( e.getCause () );
 247                         }
 248
 249         }
 250
 251         @Override
 252         public void deleteTopic(String topic) throws CambriaApiException, TopicExistsException,ConfigDbException {
 253                 log.info("Deleting topic: " + topic);
 254                 ZkClient zkClient = null;
 255                 try {
 256                         log.info("Loading zookeeper client for topic deletion.");
 257                                         // topic creation. (Otherwise, the topic is only partially created
 258                         // in ZK.)
 259
 260
 261                         fKafkaAdminClient.deleteTopics(Arrays.asList(topic));
 262                         log.info("Zookeeper client loaded successfully. Deleting topic.");
 263
 264                 } catch (Exception e) {
 265                         log.error("Failed to delete topic [" + topic + "]. " + e.getMessage(), e);
 266                         throw new ConfigDbException(e);
 267                 }  finally {
 268                         log.info("Closing zookeeper connection.");
 269                         if (zkClient != null)
 270                                 zkClient.close();
 271                 }
 272
 273                 // throw new UnsupportedOperationException ( "We can't programmatically
 274                 // delete Kafka topics yet." );
 275         }
 276
 277         //private final rrNvReadable fSettings;
 278         private final ZkClient fZk;
 279         private final ConfigDb fCambriaConfig;
 280         private final ConfigPath fBaseTopicData;
 281
 282         private static final String zkTopicsRoot = "/brokers/topics";
 283         private static final JSONObject kEmptyAcl = new JSONObject();
 284
 285         /**
 286          * method Providing KafkaTopic Object associated with owner and
 287          * transactionenabled or not
 288          *
 289          * @param name
 290          * @param desc
 291          * @param owner
 292          * @param transactionEnabled
 293          * @return
 294          * @throws ConfigDbException
 295          */
 296         public KafkaTopic createTopicEntry(String name, String desc, String owner, boolean transactionEnabled)
 297                         throws ConfigDbException {
 298                 return createTopicEntry(fCambriaConfig, fBaseTopicData, name, desc, owner, transactionEnabled);
 299         }
 300
 301         /**
 302          * static method giving kafka topic object
 303          *
 304          * @param db
 305          * @param basePath
 306          * @param name
 307          * @param desc
 308          * @param owner
 309          * @param transactionEnabled
 310          * @return
 311          * @throws ConfigDbException
 312          */
 313         public static KafkaTopic createTopicEntry(ConfigDb db, ConfigPath basePath, String name, String desc, String owner,
 314                         boolean transactionEnabled) throws ConfigDbException {
 315                 final JSONObject o = new JSONObject();
 316                 o.put("owner", owner);
 317                 o.put("description", desc);
 318                 o.put("txenabled", transactionEnabled);
 319                 db.store(basePath.getChild(name), o.toString());
 320                 return new KafkaTopic(name, db, basePath);
 321         }
 322
 323         /**
 324          * class performing all user opearation like user is eligible to read,
 325          * write. permitting a user to write and read,
 326          *
 327          * @author anowarul.islam
 328          *
 329          */
 330         public static class KafkaTopic implements Topic {
 331                 /**
 332                  * constructor initializes
 333                  *
 334                  * @param name
 335                  * @param configdb
 336                  * @param baseTopic
 337                  * @throws ConfigDbException
 338                  */
 339                 public KafkaTopic(String name, ConfigDb configdb, ConfigPath baseTopic) throws ConfigDbException {
 340                         fName = name;
 341                         fConfigDb = configdb;
 342                         fBaseTopicData = baseTopic;
 343
 344                         String data = fConfigDb.load(fBaseTopicData.getChild(fName));
 345                         if (data == null) {
 346                                 data = "{}";
 347                         }
 348
 349                         final JSONObject o = new JSONObject(data);
 350                         fOwner = o.optString("owner", "");
 351                         fDesc = o.optString("description", "");
 352                         fTransactionEnabled = o.optBoolean("txenabled", false);// default
 353                                                                                                                                         // value is
 354                                                                                                                                         // false
 355                         // if this topic has an owner, it needs both read/write ACLs. If there's no
 356                                                 // owner (or it's empty), null is okay -- this is for existing or implicitly
 357                                                 // created topics.
 358                                                 JSONObject readers = o.optJSONObject ( "readers" );
 359                                                 if ( readers == null && fOwner.length () > 0 ) readers = kEmptyAcl;
 360                                                 fReaders =  fromJson ( readers );
 361
 362                                                 JSONObject writers = o.optJSONObject ( "writers" );
 363                                                 if ( writers == null && fOwner.length () > 0 ) writers = kEmptyAcl;
 364                                                 fWriters = fromJson ( writers );
 365                 }
 366
 367                 private NsaAcl fromJson(JSONObject o) {
 368                         NsaAcl acl = new NsaAcl();
 369                         if (o != null) {
 370                                 JSONArray a = o.optJSONArray("allowed");
 371                                 if (a != null) {
 372                                         for (int i = 0; i < a.length(); ++i) {
 373                                                 String user = a.getString(i);
 374                                                 acl.add(user);
 375                                         }
 376                                 }
 377                         }
 378                         return acl;
 379                 }
 380
 381                 @Override
 382                 public String getName() {
 383                         return fName;
 384                 }
 385
 386                 @Override
 387                 public String getOwner() {
 388                         return fOwner;
 389                 }
 390
 391                 @Override
 392                 public String getDescription() {
 393                         return fDesc;
 394                 }
 395
 396                 @Override
 397                 public NsaAcl getReaderAcl() {
 398                         return fReaders;
 399                 }
 400
 401                 @Override
 402                 public NsaAcl getWriterAcl() {
 403                         return fWriters;
 404                 }
 405
 406                 @Override
 407                 public void checkUserRead(NsaApiKey user) throws AccessDeniedException  {
 408                         NsaAclUtils.checkUserAccess ( fOwner, getReaderAcl(), user );
 409                 }
 410
 411                 @Override
 412                 public void checkUserWrite(NsaApiKey user) throws AccessDeniedException  {
 413                         NsaAclUtils.checkUserAccess ( fOwner, getWriterAcl(), user );
 414                 }
 415
 416                 @Override
 417                 public void permitWritesFromUser(String pubId, NsaApiKey asUser)
 418                                 throws ConfigDbException, AccessDeniedException {
 419                         updateAcl(asUser, false, true, pubId);
 420                 }
 421
 422                 @Override
 423                 public void denyWritesFromUser(String pubId, NsaApiKey asUser) throws ConfigDbException, AccessDeniedException {
 424                         updateAcl(asUser, false, false, pubId);
 425                 }
 426
 427                 @Override
 428                 public void permitReadsByUser(String consumerId, NsaApiKey asUser)
 429                                 throws ConfigDbException, AccessDeniedException {
 430                         updateAcl(asUser, true, true, consumerId);
 431                 }
 432
 433                 @Override
 434                 public void denyReadsByUser(String consumerId, NsaApiKey asUser)
 435                                 throws ConfigDbException, AccessDeniedException {
 436                         updateAcl(asUser, true, false, consumerId);
 437                 }
 438
 439                 private void updateAcl(NsaApiKey asUser, boolean reader, boolean add, String key)
 440                                 throws ConfigDbException, AccessDeniedException{
 441                         try
 442                         {
 443                                 final NsaAcl acl = NsaAclUtils.updateAcl ( this, asUser, key, reader, add );
 444
 445                                 // we have to assume we have current data, or load it again. for the expected use
 446                                 // case, assuming we can overwrite the data is fine.
 447                                 final JSONObject o = new JSONObject ();
 448                                 o.put ( "owner", fOwner );
 449                                 o.put ( "readers", safeSerialize ( reader ? acl : fReaders ) );
 450                                 o.put ( "writers", safeSerialize ( reader ? fWriters : acl ) );
 451                                 fConfigDb.store ( fBaseTopicData.getChild ( fName ), o.toString () );
 452
 453                                 log.info ( "ACL_UPDATE: " + asUser.getKey () + " " + ( add ? "added" : "removed" ) + ( reader?"subscriber":"publisher" ) + " " + key + " on " + fName );
 454
 455                         }
 456                         catch ( ConfigDbException x )
 457                         {
 458                                 throw x;
 459                         }
 460                         catch ( AccessDeniedException x )
 461                         {
 462                                 throw x;
 463                         }
 464
 465                 }
 466
 467                 private JSONObject safeSerialize(NsaAcl acl) {
 468                         return acl == null ? null : acl.serialize();
 469                 }
 470
 471                 private final String fName;
 472                 private final ConfigDb fConfigDb;
 473                 private final ConfigPath fBaseTopicData;
 474                 private final String fOwner;
 475                 private final String fDesc;
 476                 private final NsaAcl fReaders;
 477                 private final NsaAcl fWriters;
 478                 private boolean fTransactionEnabled;
 479
 480                 public boolean isTransactionEnabled() {
 481                         return fTransactionEnabled;
 482                 }
 483
 484                 @Override
 485                 public Set<String> getOwners() {
 486                         final TreeSet<String> owners = new TreeSet<String> ();
 487                         owners.add ( fOwner );
 488                         return owners;
 489                 }
 490         }
 491
 492 }