authz-cass/src/main/java/com/att/dao/aaf/cass/NsDAO.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aaf\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * * \r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * * \r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 package com.att.dao.aaf.cass;\r
  24 \r
  25 import java.io.ByteArrayOutputStream;\r
  26 import java.io.DataInputStream;\r
  27 import java.io.DataOutputStream;\r
  28 import java.io.IOException;\r
  29 import java.nio.ByteBuffer;\r
  30 import java.util.HashMap;\r
  31 import java.util.HashSet;\r
  32 import java.util.Iterator;\r
  33 import java.util.List;\r
  34 import java.util.Map;\r
  35 import java.util.Map.Entry;\r
  36 import java.util.Set;\r
  37 \r
  38 import com.att.authz.env.AuthzTrans;\r
  39 import com.att.authz.layer.Result;\r
  40 import com.att.dao.Bytification;\r
  41 import com.att.dao.Cached;\r
  42 import com.att.dao.CassAccess;\r
  43 import com.att.dao.CassDAOImpl;\r
  44 import com.att.dao.Loader;\r
  45 import com.att.dao.Streamer;\r
  46 import com.att.inno.env.APIException;\r
  47 import com.att.inno.env.Env;\r
  48 import com.att.inno.env.TimeTaken;\r
  49 import com.datastax.driver.core.Cluster;\r
  50 import com.datastax.driver.core.ResultSet;\r
  51 import com.datastax.driver.core.Row;\r
  52 import com.datastax.driver.core.exceptions.DriverException;\r
  53 \r
  54 /**\r
  55  * NsDAO\r
  56  * \r
  57  * Data Access Object for Namespace Data\r
  58  *\r
  59  */\r
  60 public class NsDAO extends CassDAOImpl<AuthzTrans,NsDAO.Data> {\r
  61         public static final String TABLE = "ns";\r
  62         public static final String TABLE_ATTRIB = "ns_attrib";\r
  63     public static final int CACHE_SEG = 0x40; // yields segment 0x0-0x3F\r
  64     public static final int ROOT = 1;\r
  65     public static final int COMPANY=2;\r
  66     public static final int APP = 3;\r
  67 \r
  68         private static final String BEGIN_BATCH = "BEGIN BATCH\n";\r
  69         private static final String APPLY_BATCH = "APPLY BATCH;\n";\r
  70         private static final String SQSCCR = "';\n";\r
  71         private static final String SQCSQ = "','";\r
  72     \r
  73         private HistoryDAO historyDAO;\r
  74         private CacheInfoDAO infoDAO;\r
  75         private PSInfo psNS;\r
  76 \r
  77         public NsDAO(AuthzTrans trans, Cluster cluster, String keyspace) throws APIException, IOException {\r
  78                 super(trans, NsDAO.class.getSimpleName(),cluster,keyspace,Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));\r
  79                 init(trans);\r
  80         }\r
  81 \r
  82         public NsDAO(AuthzTrans trans, HistoryDAO hDAO, CacheInfoDAO iDAO) throws APIException, IOException {\r
  83                 super(trans, NsDAO.class.getSimpleName(),hDAO,Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));\r
  84                 historyDAO=hDAO;\r
  85                 infoDAO = iDAO;\r
  86                 init(trans);\r
  87         }\r
  88 \r
  89 \r
  90     //////////////////////////////////////////\r
  91     // Data Definition, matches Cassandra DM\r
  92     //////////////////////////////////////////\r
  93     private static final int KEYLIMIT = 1;\r
  94     /**\r
  95      * Data class that matches the Cassandra Table "role"\r
  96      * \r
  97      */\r
  98         public static class Data extends CacheableData implements Bytification {\r
  99                 public String                 name;\r
 100                 public int                            type;\r
 101                 public String                     description;\r
 102                 public String                     parent;\r
 103                 public Map<String,String> attrib;\r
 104 \r
 105 //              ////////////////////////////////////////\r
 106 //        // Getters\r
 107                 public Map<String,String> attrib(boolean mutable) {\r
 108                         if (attrib == null) {\r
 109                                 attrib = new HashMap<String,String>();\r
 110                         } else if (mutable && !(attrib instanceof HashMap)) {\r
 111                                 attrib = new HashMap<String,String>(attrib);\r
 112                         }\r
 113                         return attrib;\r
 114                 }\r
 115 \r
 116                 @Override\r
 117                 public int[] invalidate(Cached<?,?> cache) {\r
 118                         return new int[] {\r
 119                                 seg(cache,name)\r
 120                         };\r
 121                 }\r
 122 \r
 123                 public NsSplit split(String name) {\r
 124                         return new NsSplit(this,name);\r
 125                 }\r
 126 \r
 127                 @Override\r
 128                 public ByteBuffer bytify() throws IOException {\r
 129                         ByteArrayOutputStream baos = new ByteArrayOutputStream();\r
 130                         NSLoader.deflt.marshal(this,new DataOutputStream(baos));\r
 131                         return ByteBuffer.wrap(baos.toByteArray());\r
 132                 }\r
 133                 \r
 134                 @Override\r
 135                 public void reconstitute(ByteBuffer bb) throws IOException {\r
 136                         NSLoader.deflt.unmarshal(this,toDIS(bb));\r
 137                 }\r
 138                 \r
 139                 @Override\r
 140                 public String toString() {\r
 141                         return name;\r
 142                 }\r
 143                 \r
 144     }\r
 145     \r
 146     private void init(AuthzTrans trans) throws APIException, IOException {\r
 147         // Set up sub-DAOs\r
 148         if(historyDAO==null) {\r
 149             historyDAO = new HistoryDAO(trans, this);\r
 150         }\r
 151         if(infoDAO==null) {\r
 152             infoDAO = new CacheInfoDAO(trans,this);\r
 153         }\r
 154 \r
 155                 String[] helpers = setCRUD(trans, TABLE, Data.class, NSLoader.deflt,4/*need to skip attrib */);\r
 156                 \r
 157                 psNS = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] + " FROM " + TABLE +\r
 158                                 " WHERE parent = ?", new NSLoader(1),readConsistency);\r
 159 \r
 160         }\r
 161         \r
 162     private static final class NSLoader extends Loader<Data> implements Streamer<Data> {\r
 163                 public static final int MAGIC=250935515;\r
 164         public static final int VERSION=1;\r
 165         public static final int BUFF_SIZE=48;\r
 166 \r
 167         public static final NSLoader deflt = new NSLoader(KEYLIMIT);\r
 168         \r
 169                 public NSLoader(int keylimit) {\r
 170                         super(keylimit);\r
 171                 }\r
 172 \r
 173                 @Override\r
 174                 public Data load(Data data, Row row) {\r
 175                         // Int more efficient\r
 176                         data.name = row.getString(0);\r
 177                         data.type = row.getInt(1);\r
 178                         data.description = row.getString(2);\r
 179                         data.parent = row.getString(3);\r
 180                         return data;\r
 181                 }\r
 182 \r
 183                 @Override\r
 184                 protected void key(Data data, int idx, Object[] obj) {\r
 185                         obj[idx]=data.name;\r
 186                 }\r
 187 \r
 188                 @Override\r
 189                 protected void body(Data data, int _idx, Object[] obj) {\r
 190                         int idx = _idx;\r
 191 \r
 192                         obj[idx]=data.type;\r
 193                         obj[++idx]=data.description;\r
 194                         obj[++idx]=data.parent;\r
 195                 }\r
 196                 \r
 197                 @Override\r
 198                 public void marshal(Data data, DataOutputStream os) throws IOException {\r
 199                         writeHeader(os,MAGIC,VERSION);\r
 200                         writeString(os, data.name);\r
 201                         os.writeInt(data.type);\r
 202                         writeString(os,data.description);\r
 203                         writeString(os,data.parent);\r
 204                         if(data.attrib==null) {\r
 205                                 os.writeInt(-1);\r
 206                         } else {\r
 207                                 os.writeInt(data.attrib.size());\r
 208                                 for(Entry<String, String> es : data.attrib(false).entrySet()) {\r
 209                                         writeString(os,es.getKey());\r
 210                                         writeString(os,es.getValue());\r
 211                                 }\r
 212                         }\r
 213                 }\r
 214 \r
 215                 @Override\r
 216                 public void unmarshal(Data data, DataInputStream is) throws IOException {\r
 217                         /*int version = */readHeader(is,MAGIC,VERSION);\r
 218                         // If Version Changes between Production runs, you'll need to do a switch Statement, and adequately read in fields\r
 219                         \r
 220                         byte[] buff = new byte[BUFF_SIZE];\r
 221                         data.name = readString(is, buff);\r
 222                         data.type = is.readInt();\r
 223                         data.description = readString(is,buff);\r
 224                         data.parent = readString(is,buff);\r
 225                         int count = is.readInt();\r
 226                         if(count>0) {\r
 227                                 Map<String, String> da = data.attrib(true);\r
 228                                 for(int i=0;i<count;++i) {\r
 229                                         da.put(readString(is,buff), readString(is,buff));\r
 230                                 }\r
 231                         }\r
 232                 }\r
 233 \r
 234     }\r
 235     \r
 236         @Override\r
 237         public Result<Data> create(AuthzTrans trans, Data data) {\r
 238                 String ns = data.name;\r
 239                 // Ensure Parent is set\r
 240                 int ldot = ns.lastIndexOf('.');\r
 241                 data.parent=ldot<0?".":ns.substring(0,ldot);\r
 242 \r
 243                 // insert Attributes\r
 244                 StringBuilder stmt = new StringBuilder();\r
 245                 stmt.append(BEGIN_BATCH);\r
 246                 attribInsertStmts(stmt, data);\r
 247                 stmt.append(APPLY_BATCH);\r
 248                 try {\r
 249                         getSession(trans).execute(stmt.toString());\r
 250 //// TEST CODE for Exception                            \r
 251 //                      boolean force = true; \r
 252 //                      if(force) {\r
 253 //                              throw new com.datastax.driver.core.exceptions.NoHostAvailableException(new HashMap<InetSocketAddress,Throwable>());\r
 254 ////                            throw new com.datastax.driver.core.exceptions.AuthenticationException(new InetSocketAddress(9999),"Sample Message");\r
 255 //                      }\r
 256 ////END TEST CODE\r
 257 \r
 258                 } catch (DriverException | APIException | IOException e) {\r
 259                         reportPerhapsReset(trans,e);\r
 260                         trans.info().log(stmt);\r
 261                         return Result.err(Result.ERR_Backend, "Backend Access");\r
 262                 }\r
 263                 return super.create(trans, data);\r
 264         }\r
 265 \r
 266         @Override\r
 267         public Result<Void> update(AuthzTrans trans, Data data) {\r
 268                 String ns = data.name;\r
 269                 // Ensure Parent is set\r
 270                 int ldot = ns.lastIndexOf('.');\r
 271                 data.parent=ldot<0?".":ns.substring(0,ldot);\r
 272 \r
 273                 StringBuilder stmt = new StringBuilder();\r
 274                 stmt.append(BEGIN_BATCH);\r
 275                 try {\r
 276                         Map<String, String> localAttr = data.attrib;\r
 277                         Result<Map<String, String>> rremoteAttr = readAttribByNS(trans,ns);\r
 278                         if(rremoteAttr.notOK()) {\r
 279                                 return Result.err(rremoteAttr);\r
 280                         }\r
 281                         // update Attributes\r
 282                         String str;\r
 283                         for(Entry<String, String> es : localAttr.entrySet()) {\r
 284                                 str = rremoteAttr.value.get(es.getKey());\r
 285                                 if(str==null || !str.equals(es.getValue())) {\r
 286                                         attribInsertStmt(stmt, ns, es.getKey(),es.getValue());\r
 287                                 }\r
 288                         }\r
 289                         \r
 290                         // No point in deleting... insert overwrites...\r
 291 //                      for(Entry<String, String> es : remoteAttr.entrySet()) {\r
 292 //                              str = localAttr.get(es.getKey());\r
 293 //                              if(str==null || !str.equals(es.getValue())) {\r
 294 //                                      attribDeleteStmt(stmt, ns, es.getKey());\r
 295 //                              }\r
 296 //                      }\r
 297                         if(stmt.length()>BEGIN_BATCH.length()) {\r
 298                                 stmt.append(APPLY_BATCH);\r
 299                                 getSession(trans).execute(stmt.toString());\r
 300                         }\r
 301                 } catch (DriverException | APIException | IOException e) {\r
 302                         reportPerhapsReset(trans,e);\r
 303                         trans.info().log(stmt);\r
 304                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 305                 }\r
 306 \r
 307                 return super.update(trans,data);\r
 308         }\r
 309 \r
 310         /* (non-Javadoc)\r
 311          * @see com.att.dao.CassDAOImpl#read(com.att.inno.env.TransStore, java.lang.Object)\r
 312          */\r
 313         @Override\r
 314         public Result<List<Data>> read(AuthzTrans trans, Data data) {\r
 315                 Result<List<Data>> rld = super.read(trans, data);\r
 316                 \r
 317                 if(rld.isOKhasData()) {\r
 318                         for(Data d : rld.value) {\r
 319                                 // Note: Map is null at this point, save time/mem by assignment\r
 320                                 Result<Map<String, String>> rabn = readAttribByNS(trans,d.name);\r
 321                                 if(rabn.isOK()) {\r
 322                                         d.attrib = rabn.value;\r
 323                                 } else {\r
 324                                         return Result.err(rabn);\r
 325                                 }\r
 326                         }\r
 327                 }\r
 328                 return rld;\r
 329         }\r
 330 \r
 331         /* (non-Javadoc)\r
 332          * @see com.att.dao.CassDAOImpl#read(com.att.inno.env.TransStore, java.lang.Object[])\r
 333          */\r
 334         @Override\r
 335         public Result<List<Data>> read(AuthzTrans trans, Object... key) {\r
 336                 Result<List<Data>> rld = super.read(trans, key);\r
 337 \r
 338                 if(rld.isOKhasData()) {\r
 339                         for(Data d : rld.value) {\r
 340                                 // Note: Map is null at this point, save time/mem by assignment\r
 341                                 Result<Map<String, String>> rabn = readAttribByNS(trans,d.name);\r
 342                                 if(rabn.isOK()) {\r
 343                                         d.attrib = rabn.value;\r
 344                                 } else {\r
 345                                         return Result.err(rabn);\r
 346                                 }\r
 347                         }\r
 348                 }\r
 349                 return rld;\r
 350         }\r
 351 \r
 352         @Override\r
 353         public Result<Void> delete(AuthzTrans trans, Data data, boolean reread) {\r
 354                 TimeTaken tt = trans.start("Delete NS Attributes " + data.name, Env.REMOTE);\r
 355                 try {\r
 356                         StringBuilder stmt = new StringBuilder();\r
 357                         attribDeleteAllStmt(stmt, data);\r
 358                         try {\r
 359                                 getSession(trans).execute(stmt.toString());\r
 360                         } catch (DriverException | APIException | IOException e) {\r
 361                                 reportPerhapsReset(trans,e);\r
 362                                 trans.info().log(stmt);\r
 363                                 return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 364                         }\r
 365                 } finally {\r
 366                         tt.done();\r
 367                 }\r
 368                 return super.delete(trans, data, reread);\r
 369 \r
 370         }\r
 371     \r
 372         public Result<Map<String,String>> readAttribByNS(AuthzTrans trans, String ns) {\r
 373                 Map<String,String> map = new HashMap<String,String>();\r
 374                 TimeTaken tt = trans.start("readAttribByNS " + ns, Env.REMOTE);\r
 375                 try {\r
 376                         ResultSet rs = getSession(trans).execute("SELECT key,value FROM " \r
 377                                         + TABLE_ATTRIB \r
 378                                         + " WHERE ns='"\r
 379                                         + ns\r
 380                                         + "';");\r
 381                         \r
 382                         for(Iterator<Row> iter = rs.iterator();iter.hasNext(); ) {\r
 383                                 Row r = iter.next();\r
 384                                 map.put(r.getString(0), r.getString(1));\r
 385                         }\r
 386                 } catch (DriverException | APIException | IOException e) {\r
 387                         reportPerhapsReset(trans,e);\r
 388                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 389                 } finally {\r
 390                         tt.done();\r
 391                 }\r
 392                 return Result.ok(map);\r
 393         }\r
 394 \r
 395         public Result<Set<String>> readNsByAttrib(AuthzTrans trans, String key) {\r
 396                 Set<String> set = new HashSet<String>();\r
 397                 TimeTaken tt = trans.start("readNsBykey " + key, Env.REMOTE);\r
 398                 try {\r
 399                         ResultSet rs = getSession(trans).execute("SELECT ns FROM " \r
 400                                 + TABLE_ATTRIB \r
 401                                 + " WHERE key='"\r
 402                                 + key\r
 403                                 + "';");\r
 404                 \r
 405                         for(Iterator<Row> iter = rs.iterator();iter.hasNext(); ) {\r
 406                                 Row r = iter.next();\r
 407                                 set.add(r.getString(0));\r
 408                         }\r
 409                 } catch (DriverException | APIException | IOException e) {\r
 410                         reportPerhapsReset(trans,e);\r
 411                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 412                 } finally {\r
 413                         tt.done();\r
 414                 }\r
 415                 return Result.ok(set);\r
 416         }\r
 417 \r
 418         public Result<Void> attribAdd(AuthzTrans trans, String ns, String key, String value) {\r
 419                 try {\r
 420                         getSession(trans).execute(attribInsertStmt(new StringBuilder(),ns,key,value).toString());\r
 421                         return Result.ok();\r
 422                 } catch (DriverException | APIException | IOException e) {\r
 423                         reportPerhapsReset(trans,e);\r
 424                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 425                 }\r
 426         }\r
 427         \r
 428         private StringBuilder attribInsertStmt(StringBuilder sb, String ns, String key, String value) {\r
 429                 sb.append("INSERT INTO ");\r
 430                 sb.append(TABLE_ATTRIB);\r
 431                 sb.append(" (ns,key,value) VALUES ('");\r
 432                 sb.append(ns);\r
 433                 sb.append(SQCSQ);\r
 434                 sb.append(key);\r
 435                 sb.append(SQCSQ);\r
 436                 sb.append(value);\r
 437                 sb.append("');");\r
 438                 return sb;\r
 439         }\r
 440         \r
 441         public Result<Void> attribRemove(AuthzTrans trans, String ns, String key) {\r
 442                 try {\r
 443                         getSession(trans).execute(attribDeleteStmt(new StringBuilder(),ns,key).toString());\r
 444                         return Result.ok();\r
 445                 } catch (DriverException | APIException | IOException e) {\r
 446                         reportPerhapsReset(trans,e);\r
 447                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 448                 }\r
 449         }\r
 450         \r
 451         private StringBuilder attribDeleteStmt(StringBuilder stmt, String ns, String key) {\r
 452                 stmt.append("DELETE FROM ");\r
 453                 stmt.append(TABLE_ATTRIB);\r
 454                 stmt.append(" WHERE ns='");\r
 455                 stmt.append(ns);\r
 456                 stmt.append("' AND key='");\r
 457                 stmt.append(key);\r
 458                 stmt.append("';");\r
 459                 return stmt;\r
 460         }\r
 461         \r
 462         private void attribDeleteAllStmt(StringBuilder stmt, Data data) {\r
 463                 stmt.append("  DELETE FROM ");\r
 464                 stmt.append(TABLE_ATTRIB);\r
 465                 stmt.append(" WHERE ns='");\r
 466                 stmt.append(data.name);\r
 467                 stmt.append(SQSCCR);\r
 468         }\r
 469 \r
 470         private void attribInsertStmts(StringBuilder stmt, Data data) {\r
 471                 // INSERT new Attrib\r
 472                 for(Entry<String,String> es : data.attrib(false).entrySet() ) {\r
 473                         stmt.append("  ");\r
 474                         attribInsertStmt(stmt,data.name,es.getKey(),es.getValue());\r
 475                 }\r
 476         }\r
 477 \r
 478         /**\r
 479          * Add description to Namespace\r
 480          * @param trans\r
 481          * @param ns\r
 482          * @param description\r
 483          * @return\r
 484          */\r
 485         public Result<Void> addDescription(AuthzTrans trans, String ns, String description) {\r
 486                 try {\r
 487                         getSession(trans).execute(UPDATE_SP + TABLE + " SET description = '" \r
 488                                 + description + "' WHERE name = '" + ns + "';");\r
 489                 } catch (DriverException | APIException | IOException e) {\r
 490                         reportPerhapsReset(trans,e);\r
 491                         return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
 492                 }\r
 493 \r
 494                 Data data = new Data();\r
 495                 data.name=ns;\r
 496                 wasModified(trans, CRUD.update, data, "Added description " + description + " to namespace " + ns, null );\r
 497                 return Result.ok();\r
 498         }\r
 499 \r
 500         public Result<List<Data>> getChildren(AuthzTrans trans, String parent) {\r
 501                 return psNS.read(trans, R_TEXT, new Object[]{parent});\r
 502         }\r
 503                 \r
 504 \r
 505     /**\r
 506      * Log Modification statements to History\r
 507      * \r
 508      * @param modified           which CRUD action was done\r
 509      * @param data               entity data that needs a log entry\r
 510      * @param overrideMessage    if this is specified, we use it rather than crafting a history message based on data\r
 511      */\r
 512     @Override\r
 513     protected void wasModified(AuthzTrans trans, CRUD modified, Data data, String ... override) {\r
 514         boolean memo = override.length>0 && override[0]!=null;\r
 515         boolean subject = override.length>1 && override[1]!=null;\r
 516 \r
 517         //TODO Must log history\r
 518         HistoryDAO.Data hd = HistoryDAO.newInitedData();\r
 519         hd.user = trans.user();\r
 520         hd.action = modified.name();\r
 521         hd.target = TABLE;\r
 522         hd.subject = subject ? override[1] : data.name;\r
 523         hd.memo = memo ? override[0] : (data.name + " was "  + modified.name() + 'd' );\r
 524                 if(modified==CRUD.delete) {\r
 525                         try {\r
 526                                 hd.reconstruct = data.bytify();\r
 527                         } catch (IOException e) {\r
 528                                 trans.error().log(e,"Could not serialize NsDAO.Data");\r
 529                         }\r
 530                 }\r
 531 \r
 532         if(historyDAO.create(trans, hd).status!=Status.OK) {\r
 533             trans.error().log("Cannot log to History");\r
 534         }\r
 535         if(infoDAO.touch(trans, TABLE,data.invalidate(cache)).notOK()) {\r
 536             trans.error().log("Cannot touch CacheInfo");\r
 537         }\r
 538     }\r
 539 \r
 540 }\r