Update project structure to org.onap.aaf
[aaf/authz.git] / authz-cass / src / main / java / org / onap / aaf / dao / aaf / cass / NsDAO.java
diff --git a/authz-cass/src/main/java/org/onap/aaf/dao/aaf/cass/NsDAO.java b/authz-cass/src/main/java/org/onap/aaf/dao/aaf/cass/NsDAO.java
new file mode 100644 (file)
index 0000000..9e18195
--- /dev/null
@@ -0,0 +1,542 @@
+/*******************************************************************************\r
+ * ============LICENSE_START====================================================\r
+ * * org.onap.aaf\r
+ * * ===========================================================================\r
+ * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * * ===========================================================================\r
+ * * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * * you may not use this file except in compliance with the License.\r
+ * * You may obtain a copy of the License at\r
+ * * \r
+ *  *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * * \r
+ *  * Unless required by applicable law or agreed to in writing, software\r
+ * * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * * See the License for the specific language governing permissions and\r
+ * * limitations under the License.\r
+ * * ============LICENSE_END====================================================\r
+ * *\r
+ * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
+ * *\r
+ ******************************************************************************/\r
+package org.onap.aaf.dao.aaf.cass;\r
+\r
+import java.io.ByteArrayOutputStream;\r
+import java.io.DataInputStream;\r
+import java.io.DataOutputStream;\r
+import java.io.IOException;\r
+import java.nio.ByteBuffer;\r
+import java.util.HashMap;\r
+import java.util.HashSet;\r
+import java.util.Iterator;\r
+import java.util.List;\r
+import java.util.Map;\r
+import java.util.Map.Entry;\r
+\r
+import org.onap.aaf.authz.env.AuthzTrans;\r
+import org.onap.aaf.authz.layer.Result;\r
+import org.onap.aaf.dao.Bytification;\r
+import org.onap.aaf.dao.Cached;\r
+import org.onap.aaf.dao.CassAccess;\r
+import org.onap.aaf.dao.CassDAOImpl;\r
+import org.onap.aaf.dao.Loader;\r
+import org.onap.aaf.dao.Streamer;\r
+\r
+import java.util.Set;\r
+\r
+import org.onap.aaf.inno.env.APIException;\r
+import org.onap.aaf.inno.env.Env;\r
+import org.onap.aaf.inno.env.TimeTaken;\r
+import com.datastax.driver.core.Cluster;\r
+import com.datastax.driver.core.ResultSet;\r
+import com.datastax.driver.core.Row;\r
+import com.datastax.driver.core.exceptions.DriverException;\r
+\r
+/**\r
+ * NsDAO\r
+ * \r
+ * Data Access Object for Namespace Data\r
+ *\r
+ */\r
+public class NsDAO extends CassDAOImpl<AuthzTrans,NsDAO.Data> {\r
+       public static final String TABLE = "ns";\r
+       public static final String TABLE_ATTRIB = "ns_attrib";\r
+    public static final int CACHE_SEG = 0x40; // yields segment 0x0-0x3F\r
+    public static final int ROOT = 1;\r
+    public static final int COMPANY=2;\r
+    public static final int APP = 3;\r
+\r
+       private static final String BEGIN_BATCH = "BEGIN BATCH\n";\r
+       private static final String APPLY_BATCH = "APPLY BATCH;\n";\r
+       private static final String SQSCCR = "';\n";\r
+       private static final String SQCSQ = "','";\r
+    \r
+       private HistoryDAO historyDAO;\r
+       private CacheInfoDAO infoDAO;\r
+       private PSInfo psNS;\r
+\r
+       public NsDAO(AuthzTrans trans, Cluster cluster, String keyspace) throws APIException, IOException {\r
+               super(trans, NsDAO.class.getSimpleName(),cluster,keyspace,Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));\r
+               init(trans);\r
+       }\r
+\r
+       public NsDAO(AuthzTrans trans, HistoryDAO hDAO, CacheInfoDAO iDAO) throws APIException, IOException {\r
+               super(trans, NsDAO.class.getSimpleName(),hDAO,Data.class,TABLE, readConsistency(trans,TABLE), writeConsistency(trans,TABLE));\r
+               historyDAO=hDAO;\r
+               infoDAO = iDAO;\r
+               init(trans);\r
+       }\r
+\r
+\r
+    //////////////////////////////////////////\r
+    // Data Definition, matches Cassandra DM\r
+    //////////////////////////////////////////\r
+    private static final int KEYLIMIT = 1;\r
+    /**\r
+     * Data class that matches the Cassandra Table "role"\r
+     * \r
+     */\r
+       public static class Data extends CacheableData implements Bytification {\r
+               public String                 name;\r
+               public int                            type;\r
+               public String                     description;\r
+               public String                     parent;\r
+               public Map<String,String> attrib;\r
+\r
+//             ////////////////////////////////////////\r
+//        // Getters\r
+               public Map<String,String> attrib(boolean mutable) {\r
+                       if (attrib == null) {\r
+                               attrib = new HashMap<String,String>();\r
+                       } else if (mutable && !(attrib instanceof HashMap)) {\r
+                               attrib = new HashMap<String,String>(attrib);\r
+                       }\r
+                       return attrib;\r
+               }\r
+\r
+               @Override\r
+               public int[] invalidate(Cached<?,?> cache) {\r
+                       return new int[] {\r
+                               seg(cache,name)\r
+                       };\r
+               }\r
+\r
+               public NsSplit split(String name) {\r
+                       return new NsSplit(this,name);\r
+               }\r
+\r
+               @Override\r
+               public ByteBuffer bytify() throws IOException {\r
+                       ByteArrayOutputStream baos = new ByteArrayOutputStream();\r
+                       NSLoader.deflt.marshal(this,new DataOutputStream(baos));\r
+                       return ByteBuffer.wrap(baos.toByteArray());\r
+               }\r
+               \r
+               @Override\r
+               public void reconstitute(ByteBuffer bb) throws IOException {\r
+                       NSLoader.deflt.unmarshal(this,toDIS(bb));\r
+               }\r
+               \r
+               @Override\r
+               public String toString() {\r
+                       return name;\r
+               }\r
+               \r
+    }\r
+    \r
+    private void init(AuthzTrans trans) throws APIException, IOException {\r
+        // Set up sub-DAOs\r
+        if(historyDAO==null) {\r
+           historyDAO = new HistoryDAO(trans, this);\r
+       }\r
+        if(infoDAO==null) {\r
+           infoDAO = new CacheInfoDAO(trans,this);\r
+       }\r
+\r
+               String[] helpers = setCRUD(trans, TABLE, Data.class, NSLoader.deflt,4/*need to skip attrib */);\r
+               \r
+               psNS = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] + " FROM " + TABLE +\r
+                               " WHERE parent = ?", new NSLoader(1),readConsistency);\r
+\r
+       }\r
+       \r
+    private static final class NSLoader extends Loader<Data> implements Streamer<Data> {\r
+               public static final int MAGIC=250935515;\r
+       public static final int VERSION=1;\r
+       public static final int BUFF_SIZE=48;\r
+\r
+       public static final NSLoader deflt = new NSLoader(KEYLIMIT);\r
+       \r
+               public NSLoader(int keylimit) {\r
+                       super(keylimit);\r
+               }\r
+\r
+               @Override\r
+               public Data load(Data data, Row row) {\r
+                       // Int more efficient\r
+                       data.name = row.getString(0);\r
+                       data.type = row.getInt(1);\r
+                       data.description = row.getString(2);\r
+                       data.parent = row.getString(3);\r
+                       return data;\r
+               }\r
+\r
+               @Override\r
+               protected void key(Data data, int idx, Object[] obj) {\r
+                       obj[idx]=data.name;\r
+               }\r
+\r
+               @Override\r
+               protected void body(Data data, int _idx, Object[] obj) {\r
+                       int idx = _idx;\r
+\r
+                       obj[idx]=data.type;\r
+                       obj[++idx]=data.description;\r
+                       obj[++idx]=data.parent;\r
+               }\r
+               \r
+               @Override\r
+               public void marshal(Data data, DataOutputStream os) throws IOException {\r
+                       writeHeader(os,MAGIC,VERSION);\r
+                       writeString(os, data.name);\r
+                       os.writeInt(data.type);\r
+                       writeString(os,data.description);\r
+                       writeString(os,data.parent);\r
+                       if(data.attrib==null) {\r
+                               os.writeInt(-1);\r
+                       } else {\r
+                               os.writeInt(data.attrib.size());\r
+                               for(Entry<String, String> es : data.attrib(false).entrySet()) {\r
+                                       writeString(os,es.getKey());\r
+                                       writeString(os,es.getValue());\r
+                               }\r
+                       }\r
+               }\r
+\r
+               @Override\r
+               public void unmarshal(Data data, DataInputStream is) throws IOException {\r
+                       /*int version = */readHeader(is,MAGIC,VERSION);\r
+                       // If Version Changes between Production runs, you'll need to do a switch Statement, and adequately read in fields\r
+                       \r
+                       byte[] buff = new byte[BUFF_SIZE];\r
+                       data.name = readString(is, buff);\r
+                       data.type = is.readInt();\r
+                       data.description = readString(is,buff);\r
+                       data.parent = readString(is,buff);\r
+                       int count = is.readInt();\r
+                       if(count>0) {\r
+                               Map<String, String> da = data.attrib(true);\r
+                               for(int i=0;i<count;++i) {\r
+                                       da.put(readString(is,buff), readString(is,buff));\r
+                               }\r
+                       }\r
+               }\r
+\r
+    }\r
+    \r
+       @Override\r
+       public Result<Data> create(AuthzTrans trans, Data data) {\r
+               String ns = data.name;\r
+               // Ensure Parent is set\r
+               int ldot = ns.lastIndexOf('.');\r
+               data.parent=ldot<0?".":ns.substring(0,ldot);\r
+\r
+               // insert Attributes\r
+               StringBuilder stmt = new StringBuilder();\r
+               stmt.append(BEGIN_BATCH);\r
+               attribInsertStmts(stmt, data);\r
+               stmt.append(APPLY_BATCH);\r
+               try {\r
+                       getSession(trans).execute(stmt.toString());\r
+//// TEST CODE for Exception                           \r
+//                     boolean force = true; \r
+//                     if(force) {\r
+//                             throw new com.datastax.driver.core.exceptions.NoHostAvailableException(new HashMap<InetSocketAddress,Throwable>());\r
+////                           throw new com.datastax.driver.core.exceptions.AuthenticationException(new InetSocketAddress(9999),"Sample Message");\r
+//                     }\r
+////END TEST CODE\r
+\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       trans.info().log(stmt);\r
+                       return Result.err(Result.ERR_Backend, "Backend Access");\r
+               }\r
+               return super.create(trans, data);\r
+       }\r
+\r
+       @Override\r
+       public Result<Void> update(AuthzTrans trans, Data data) {\r
+               String ns = data.name;\r
+               // Ensure Parent is set\r
+               int ldot = ns.lastIndexOf('.');\r
+               data.parent=ldot<0?".":ns.substring(0,ldot);\r
+\r
+               StringBuilder stmt = new StringBuilder();\r
+               stmt.append(BEGIN_BATCH);\r
+               try {\r
+                       Map<String, String> localAttr = data.attrib;\r
+                       Result<Map<String, String>> rremoteAttr = readAttribByNS(trans,ns);\r
+                       if(rremoteAttr.notOK()) {\r
+                               return Result.err(rremoteAttr);\r
+                       }\r
+                       // update Attributes\r
+                       String str;\r
+                       for(Entry<String, String> es : localAttr.entrySet()) {\r
+                               str = rremoteAttr.value.get(es.getKey());\r
+                               if(str==null || !str.equals(es.getValue())) {\r
+                                       attribInsertStmt(stmt, ns, es.getKey(),es.getValue());\r
+                               }\r
+                       }\r
+                       \r
+                       // No point in deleting... insert overwrites...\r
+//                     for(Entry<String, String> es : remoteAttr.entrySet()) {\r
+//                             str = localAttr.get(es.getKey());\r
+//                             if(str==null || !str.equals(es.getValue())) {\r
+//                                     attribDeleteStmt(stmt, ns, es.getKey());\r
+//                             }\r
+//                     }\r
+                       if(stmt.length()>BEGIN_BATCH.length()) {\r
+                               stmt.append(APPLY_BATCH);\r
+                               getSession(trans).execute(stmt.toString());\r
+                       }\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       trans.info().log(stmt);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               }\r
+\r
+               return super.update(trans,data);\r
+       }\r
+\r
+       /* (non-Javadoc)\r
+        * @see org.onap.aaf.dao.CassDAOImpl#read(org.onap.aaf.inno.env.TransStore, java.lang.Object)\r
+        */\r
+       @Override\r
+       public Result<List<Data>> read(AuthzTrans trans, Data data) {\r
+               Result<List<Data>> rld = super.read(trans, data);\r
+               \r
+               if(rld.isOKhasData()) {\r
+                       for(Data d : rld.value) {\r
+                               // Note: Map is null at this point, save time/mem by assignment\r
+                               Result<Map<String, String>> rabn = readAttribByNS(trans,d.name);\r
+                               if(rabn.isOK()) {\r
+                                       d.attrib = rabn.value;\r
+                               } else {\r
+                                       return Result.err(rabn);\r
+                               }\r
+                       }\r
+               }\r
+               return rld;\r
+       }\r
+\r
+       /* (non-Javadoc)\r
+        * @see org.onap.aaf.dao.CassDAOImpl#read(org.onap.aaf.inno.env.TransStore, java.lang.Object[])\r
+        */\r
+       @Override\r
+       public Result<List<Data>> read(AuthzTrans trans, Object... key) {\r
+               Result<List<Data>> rld = super.read(trans, key);\r
+\r
+               if(rld.isOKhasData()) {\r
+                       for(Data d : rld.value) {\r
+                               // Note: Map is null at this point, save time/mem by assignment\r
+                               Result<Map<String, String>> rabn = readAttribByNS(trans,d.name);\r
+                               if(rabn.isOK()) {\r
+                                       d.attrib = rabn.value;\r
+                               } else {\r
+                                       return Result.err(rabn);\r
+                               }\r
+                       }\r
+               }\r
+               return rld;\r
+       }\r
+\r
+       @Override\r
+       public Result<Void> delete(AuthzTrans trans, Data data, boolean reread) {\r
+               TimeTaken tt = trans.start("Delete NS Attributes " + data.name, Env.REMOTE);\r
+               try {\r
+                       StringBuilder stmt = new StringBuilder();\r
+                       attribDeleteAllStmt(stmt, data);\r
+                       try {\r
+                               getSession(trans).execute(stmt.toString());\r
+                       } catch (DriverException | APIException | IOException e) {\r
+                               reportPerhapsReset(trans,e);\r
+                               trans.info().log(stmt);\r
+                               return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+                       }\r
+               } finally {\r
+                       tt.done();\r
+               }\r
+               return super.delete(trans, data, reread);\r
+\r
+       }\r
+    \r
+       public Result<Map<String,String>> readAttribByNS(AuthzTrans trans, String ns) {\r
+               Map<String,String> map = new HashMap<String,String>();\r
+               TimeTaken tt = trans.start("readAttribByNS " + ns, Env.REMOTE);\r
+               try {\r
+                       ResultSet rs = getSession(trans).execute("SELECT key,value FROM " \r
+                                       + TABLE_ATTRIB \r
+                                       + " WHERE ns='"\r
+                                       + ns\r
+                                       + "';");\r
+                       \r
+                       for(Iterator<Row> iter = rs.iterator();iter.hasNext(); ) {\r
+                               Row r = iter.next();\r
+                               map.put(r.getString(0), r.getString(1));\r
+                       }\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               } finally {\r
+                       tt.done();\r
+               }\r
+               return Result.ok(map);\r
+       }\r
+\r
+       public Result<Set<String>> readNsByAttrib(AuthzTrans trans, String key) {\r
+               Set<String> set = new HashSet<String>();\r
+               TimeTaken tt = trans.start("readNsBykey " + key, Env.REMOTE);\r
+               try {\r
+                       ResultSet rs = getSession(trans).execute("SELECT ns FROM " \r
+                               + TABLE_ATTRIB \r
+                               + " WHERE key='"\r
+                               + key\r
+                               + "';");\r
+               \r
+                       for(Iterator<Row> iter = rs.iterator();iter.hasNext(); ) {\r
+                               Row r = iter.next();\r
+                               set.add(r.getString(0));\r
+                       }\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               } finally {\r
+                       tt.done();\r
+               }\r
+               return Result.ok(set);\r
+       }\r
+\r
+       public Result<Void> attribAdd(AuthzTrans trans, String ns, String key, String value) {\r
+               try {\r
+                       getSession(trans).execute(attribInsertStmt(new StringBuilder(),ns,key,value).toString());\r
+                       return Result.ok();\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               }\r
+       }\r
+       \r
+       private StringBuilder attribInsertStmt(StringBuilder sb, String ns, String key, String value) {\r
+               sb.append("INSERT INTO ");\r
+               sb.append(TABLE_ATTRIB);\r
+               sb.append(" (ns,key,value) VALUES ('");\r
+               sb.append(ns);\r
+               sb.append(SQCSQ);\r
+               sb.append(key);\r
+               sb.append(SQCSQ);\r
+               sb.append(value);\r
+               sb.append("');");\r
+               return sb;\r
+       }\r
+       \r
+       public Result<Void> attribRemove(AuthzTrans trans, String ns, String key) {\r
+               try {\r
+                       getSession(trans).execute(attribDeleteStmt(new StringBuilder(),ns,key).toString());\r
+                       return Result.ok();\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               }\r
+       }\r
+       \r
+       private StringBuilder attribDeleteStmt(StringBuilder stmt, String ns, String key) {\r
+               stmt.append("DELETE FROM ");\r
+               stmt.append(TABLE_ATTRIB);\r
+               stmt.append(" WHERE ns='");\r
+               stmt.append(ns);\r
+               stmt.append("' AND key='");\r
+               stmt.append(key);\r
+               stmt.append("';");\r
+               return stmt;\r
+       }\r
+       \r
+       private void attribDeleteAllStmt(StringBuilder stmt, Data data) {\r
+               stmt.append("  DELETE FROM ");\r
+               stmt.append(TABLE_ATTRIB);\r
+               stmt.append(" WHERE ns='");\r
+               stmt.append(data.name);\r
+               stmt.append(SQSCCR);\r
+       }\r
+\r
+       private void attribInsertStmts(StringBuilder stmt, Data data) {\r
+               // INSERT new Attrib\r
+               for(Entry<String,String> es : data.attrib(false).entrySet() ) {\r
+                       stmt.append("  ");\r
+                       attribInsertStmt(stmt,data.name,es.getKey(),es.getValue());\r
+               }\r
+       }\r
+\r
+       /**\r
+        * Add description to Namespace\r
+        * @param trans\r
+        * @param ns\r
+        * @param description\r
+        * @return\r
+        */\r
+       public Result<Void> addDescription(AuthzTrans trans, String ns, String description) {\r
+               try {\r
+                       getSession(trans).execute(UPDATE_SP + TABLE + " SET description = '" \r
+                               + description + "' WHERE name = '" + ns + "';");\r
+               } catch (DriverException | APIException | IOException e) {\r
+                       reportPerhapsReset(trans,e);\r
+                       return Result.err(Result.ERR_Backend, CassAccess.ERR_ACCESS_MSG);\r
+               }\r
+\r
+               Data data = new Data();\r
+               data.name=ns;\r
+               wasModified(trans, CRUD.update, data, "Added description " + description + " to namespace " + ns, null );\r
+               return Result.ok();\r
+       }\r
+\r
+       public Result<List<Data>> getChildren(AuthzTrans trans, String parent) {\r
+               return psNS.read(trans, R_TEXT, new Object[]{parent});\r
+       }\r
+               \r
+\r
+    /**\r
+     * Log Modification statements to History\r
+     * \r
+     * @param modified           which CRUD action was done\r
+     * @param data               entity data that needs a log entry\r
+     * @param overrideMessage    if this is specified, we use it rather than crafting a history message based on data\r
+     */\r
+    @Override\r
+    protected void wasModified(AuthzTrans trans, CRUD modified, Data data, String ... override) {\r
+       boolean memo = override.length>0 && override[0]!=null;\r
+       boolean subject = override.length>1 && override[1]!=null;\r
+\r
+        //TODO Must log history\r
+        HistoryDAO.Data hd = HistoryDAO.newInitedData();\r
+        hd.user = trans.user();\r
+        hd.action = modified.name();\r
+        hd.target = TABLE;\r
+        hd.subject = subject ? override[1] : data.name;\r
+        hd.memo = memo ? override[0] : (data.name + " was "  + modified.name() + 'd' );\r
+               if(modified==CRUD.delete) {\r
+                       try {\r
+                               hd.reconstruct = data.bytify();\r
+                       } catch (IOException e) {\r
+                               trans.error().log(e,"Could not serialize NsDAO.Data");\r
+                       }\r
+               }\r
+\r
+        if(historyDAO.create(trans, hd).status!=Status.OK) {\r
+           trans.error().log("Cannot log to History");\r
+       }\r
+        if(infoDAO.touch(trans, TABLE,data.invalidate(cache)).notOK()) {\r
+           trans.error().log("Cannot touch CacheInfo");\r
+       }\r
+    }\r
+\r
+}\r