src/main/java/org/onap/dmaap/dbcapi/service/DmaapService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * org.onap.dmaap
   4  * ================================================================================
   5  * Copyright (C) 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  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.dmaap.dbcapi.service;
  22
  23 import java.util.ArrayList;
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34 import org.onap.dmaap.dbcapi.aaf.AafService;
  35 import org.onap.dmaap.dbcapi.aaf.DmaapGrant;
  36 import org.onap.dmaap.dbcapi.aaf.DmaapPerm;
  37 import org.onap.dmaap.dbcapi.aaf.AafService.ServiceType;
  38 import org.onap.dmaap.dbcapi.authentication.ApiPerms;
  39 import org.onap.dmaap.dbcapi.authentication.ApiPolicy;
  40 import org.onap.dmaap.dbcapi.database.DatabaseClass;
  41 import org.onap.dmaap.dbcapi.logging.BaseLoggingClass;
  42 import org.onap.dmaap.dbcapi.logging.DmaapbcLogMessageEnum;
  43 import org.onap.dmaap.dbcapi.model.ApiError;
  44 import org.onap.dmaap.dbcapi.model.Dmaap;
  45 import org.onap.dmaap.dbcapi.model.MR_Client;
  46 import org.onap.dmaap.dbcapi.model.ReplicationType;
  47 import org.onap.dmaap.dbcapi.model.Topic;
  48 import org.onap.dmaap.dbcapi.model.DmaapObject.DmaapObject_Status;
  49 import org.onap.dmaap.dbcapi.util.DmaapConfig;
  50 import org.onap.dmaap.dbcapi.util.Singleton;
  51
  52 public class DmaapService  extends BaseLoggingClass  {
  53
  54
  55         private Singleton<Dmaap> dmaapholder = DatabaseClass.getDmaap();
  56         private static String noEnvironmentPrefix;
  57
  58
  59         String topicFactory; // = "org.openecomp.dcae.dmaap.topicFactory";
  60         String topicMgrRole; // = "org.openecomp.dmaapBC.TopicMgr";
  61         String dcaeTopicNs; // = "org.openecomp.dcae.dmaap";
  62         private boolean multiSite;
  63
  64
  65         public DmaapService() {
  66                 DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
  67                 topicFactory = p.getProperty("MR.TopicFactoryNS", "MR.topicFactoryNS.not.set");
  68                 topicMgrRole = p.getProperty("MR.TopicMgrRole", "MR.TopicMgrRole.not.set" );
  69                 dcaeTopicNs = dmaapholder.get().getTopicNsRoot();
  70                 multiSite = "true".equalsIgnoreCase(p.getProperty("MR.multisite", "true"));
  71                 noEnvironmentPrefix = p.getProperty( "AAF.NoEnvironmentPrefix", "org.onap");
  72
  73                 logger.info( "DmaapService settings: " +
  74                                 " topicFactory=" + topicFactory +
  75                                 " topicMgrRole=" + topicMgrRole +
  76                                 " dcaeTopicNs=" + dcaeTopicNs +
  77                                 " multisite=" + multiSite +
  78                                 " noEnvironmentPrefix=" + noEnvironmentPrefix
  79                                 );
  80
  81         }
  82
  83         public Dmaap getDmaap() {
  84                 logger.info( "entering getDmaap()" );
  85                 return(dmaapholder.get());
  86         }
  87
  88         public Dmaap addDmaap( Dmaap nd ) {
  89
  90                 logger.info( "entering addDmaap()" );
  91                 Dmaap dmaap = dmaapholder.get();
  92                 if ( dmaap.getVersion().equals( "0")) {
  93
  94                         nd.setLastMod();
  95                         dmaapholder.update(nd);
  96
  97                         AafService aaf = new AafService( ServiceType.AAF_Admin);
  98                         ApiPolicy apiPolicy = new ApiPolicy();
  99                         if ( apiPolicy.getUseAuthClass() ) {
 100                                 ApiPerms p = new ApiPerms();
 101                                 p.setEnvMap();
 102                         }
 103                         boolean anythingWrong = false;
 104
 105                         if ( multiSite ) {
 106                                 anythingWrong = setTopicMgtPerms(  nd,  aaf ) || createMmaTopic();
 107                         }
 108
 109                         if ( anythingWrong ) {
 110                                 dmaap.setStatus(DmaapObject_Status.INVALID);
 111                         }
 112                         else {
 113                                 dmaap.setStatus(DmaapObject_Status.VALID);
 114                         }
 115                         dmaap.setLastMod();
 116                         dmaapholder.update(dmaap);
 117
 118                         return dmaap;
 119
 120                 }
 121                 else {
 122                         return dmaap;
 123                 }
 124         }
 125
 126         public Dmaap updateDmaap( Dmaap nd ) {
 127                 logger.info( "entering updateDmaap()" );
 128
 129                 boolean anythingWrong = false;
 130
 131                 Dmaap dmaap = dmaapholder.get();
 132
 133                 // some triggers for when we attempt to reprovision perms and MMA topic:
 134                 // - if the DMaaP Name changes
 135                 // - if the version is 0  (this is a handy test to force this processing by updating the DB)
 136                 // - if the object is invalid, reprocessing might fix it.
 137                 if ( ! dmaap.isStatusValid()  || ! nd.getDmaapName().equals(dmaap.getDmaapName()) || dmaap.getVersion().equals( "0") ) {
 138                         nd.setLastMod();
 139                         dmaapholder.update(nd);  //need to set this so the following perms will pick up any new vals.
 140                         dcaeTopicNs = dmaapholder.get().getTopicNsRoot();
 141                         ApiPolicy apiPolicy = new ApiPolicy();
 142                         if ( apiPolicy.getUseAuthClass()) {
 143                                 ApiPerms p = new ApiPerms();
 144                                 p.setEnvMap();
 145                         }
 146                         AafService aaf = new AafService( ServiceType.AAF_Admin);
 147                         if ( multiSite ) {
 148                                 anythingWrong = setTopicMgtPerms(  nd,  aaf ) || createMmaTopic();
 149                         }
 150                 }
 151
 152                 if ( anythingWrong ) {
 153                         nd.setStatus(DmaapObject_Status.INVALID);
 154                 }
 155                 else {
 156                         nd.setStatus(DmaapObject_Status.VALID);
 157                 }
 158                 nd.setLastMod();
 159                 dmaapholder.update(nd);  // may need to update status...
 160                 return(dmaapholder.get());
 161
 162         }
 163
 164         public String getTopicPerm(){
 165                 Dmaap dmaap = dmaapholder.get();
 166                 return getTopicPerm( dmaap.getDmaapName() );
 167         }
 168         public String getTopicPerm( String val ) {
 169                 Dmaap dmaap = dmaapholder.get();
 170                 String nsRoot = dmaap.getTopicNsRoot();
 171                 String t;
 172                 // in ONAP Casablanca, we assume no distinction of environments reflected in topic namespace
 173                 if ( nsRoot.startsWith(noEnvironmentPrefix) ) {
 174                         t = nsRoot +  ".mr.topic";
 175                 } else {
 176                         t = nsRoot + "." + val + ".mr.topic";
 177                 }
 178                 return t;
 179         }
 180
 181         public String getBridgeAdminFqtn(){
 182                 Dmaap dmaap = dmaapholder.get();
 183                 String topic = dmaap.getBridgeAdminTopic();
 184
 185                 // check if this is already an fqtn (contains a dot)
 186                 // otherwise build it
 187                 if ( topic.indexOf('.') < 0 ) {
 188                         topic = dmaap.getTopicNsRoot() + "." + dmaap.getDmaapName() + "." + dmaap.getBridgeAdminTopic();
 189                 }
 190                 return( topic );
 191         }
 192
 193         private boolean setTopicMgtPerms( Dmaap nd, AafService aaf ){
 194                 String[] actions = { "create", "destroy" };
 195                 String instance = ":" + dcaeTopicNs + "." + nd.getDmaapName() + ".mr.topic:" + dcaeTopicNs + "." + nd.getDmaapName();
 196
 197                 for( String action : actions ) {
 198
 199                         DmaapPerm perm = new DmaapPerm( topicFactory, instance, action );
 200
 201                         int rc = aaf.addPerm( perm );
 202                         if ( rc != 201 &&  rc != 409 ) {
 203                                 logger.error( "unable to add perm for "+ topicFactory + "|" + instance + "|" + action );
 204                                 return true;
 205                         }
 206
 207                         DmaapGrant grant = new DmaapGrant( perm, topicMgrRole );
 208                         rc = aaf.addGrant( grant );
 209                         if ( rc != 201 && rc != 409 ) {
 210                                 logger.error( "unable to grant to " + topicMgrRole + " perm for "+ topicFactory + "|" + instance + "|" + action );
 211                                 return true;
 212                         }
 213                 }
 214
 215                 String t = dcaeTopicNs +"." + nd.getDmaapName() + ".mr.topic";
 216                 String[] s = { "view", "pub", "sub" };
 217                 actions = s;
 218                 instance = "*";
 219
 220                 for( String action : actions ) {
 221
 222                         DmaapPerm perm = new DmaapPerm( t, instance, action );
 223
 224                         int rc = aaf.addPerm( perm );
 225                         if ( rc != 201 &&  rc != 409 ) {
 226                                 errorLogger.error( DmaapbcLogMessageEnum.AAF_UNEXPECTED_RESPONSE, Integer.toString(rc), "add perm", t + "|" + instance + "|" + action );
 227                                 return true;
 228                         }
 229
 230                         DmaapGrant grant = new DmaapGrant( perm, topicMgrRole );
 231                         rc = aaf.addGrant( grant );
 232                         if ( rc != 201 && rc != 409 ) {
 233                                 errorLogger.error( DmaapbcLogMessageEnum.AAF_UNEXPECTED_RESPONSE, Integer.toString(rc), "grant to " + topicMgrRole + " perm ", topicFactory + "|" + instance + "|" + action );
 234                                 return true;
 235                         }
 236
 237                 }
 238                 return false;
 239         }
 240
 241         public boolean testCreateMmaTopic() {
 242
 243                 DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
 244                 String unit_test = p.getProperty( "UnitTest", "No" );
 245                 if ( unit_test.equals( "Yes" ) ) {
 246                         return createMmaTopic();
 247                 }
 248                 return false;
 249         }
 250
 251         // create the special topic for MMA provisioning.
 252         // return true indicating a problem in topic creation,
 253         // else false means it was ok  (created or previously existed)
 254         private boolean createMmaTopic() {
 255                 boolean rc = true;
 256                 DmaapConfig p = (DmaapConfig)DmaapConfig.getConfig();
 257                 Dmaap dmaap = dmaapholder.get();
 258
 259                 ArrayList<MR_Client> clients = new ArrayList<MR_Client>();
 260                 String[] actions = { "pub", "sub", "view" };
 261                 String centralMR = new DcaeLocationService().getCentralLocation();
 262                 if ( centralMR == null ) {
 263                         return rc;
 264                 }
 265                 logger.info( "Location for " + dmaap.getBridgeAdminTopic() + " is " + centralMR );
 266
 267                 // first client is the Role used by Bus Controller to send messages to MMA
 268                 String provRole = p.getProperty("MM.ProvRole");
 269                 MR_Client nClient = new MR_Client();
 270                 nClient.setAction(actions);
 271                 nClient.setClientRole(provRole);
 272                 nClient.setDcaeLocationName(centralMR);
 273                 clients.add( nClient );
 274
 275                 // second client is the Role used by MMA to listen to messages from Bus Controller
 276                 String agentRole = p.getProperty("MM.AgentRole");
 277                 nClient = new MR_Client();
 278                 nClient.setAction(actions);
 279                 nClient.setClientRole(agentRole);
 280                 nClient.setDcaeLocationName(centralMR);
 281                 clients.add( nClient );
 282
 283                 // initialize Topic
 284                 Topic mmaTopic = new Topic().init();
 285                 mmaTopic.setTopicName(dmaap.getBridgeAdminTopic());
 286                 mmaTopic.setClients(clients);
 287                 mmaTopic.setOwner("BusController");
 288                 mmaTopic.setTopicDescription("topic reserved for MirrorMaker Administration");
 289                 mmaTopic.setTnxEnabled("false");
 290                 mmaTopic.setPartitionCount("1");  // a single partition should guarantee message order
 291
 292
 293                 ApiError err = new ApiError();
 294                 TopicService svc = new TopicService();
 295                 try {
 296                         @SuppressWarnings("unused")
 297                         Topic nTopic = svc.addTopic(mmaTopic, err, true);
 298                         if ( err.is2xx() || err.getCode() == 409 ) {
 299                                 return false;
 300                         }
 301                 } catch ( Exception e) {
 302                         errorLogger.error( DmaapbcLogMessageEnum.UNEXPECTED_CONDITION, " while adding Topic: " + e.getMessage());
 303                 }
 304                 errorLogger.error( DmaapbcLogMessageEnum.TOPIC_CREATE_ERROR,  dmaap.getBridgeAdminTopic(), err.getFields(), err.getFields(), err.getMessage());
 305
 306                 return rc;
 307
 308         }
 309 }