auth/auth-cass/src/main/java/org/onap/aaf/auth/dao/cass/HistoryDAO.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 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
  22 package org.onap.aaf.auth.dao.cass;
  23
  24 import java.nio.ByteBuffer;
  25 import java.text.SimpleDateFormat;
  26 import java.util.Date;
  27 import java.util.List;
  28 import java.util.UUID;
  29
  30 import org.onap.aaf.auth.dao.AbsCassDAO;
  31 import org.onap.aaf.auth.dao.CassDAOImpl;
  32 import org.onap.aaf.auth.dao.Loader;
  33 import org.onap.aaf.auth.env.AuthzTrans;
  34 import org.onap.aaf.auth.layer.Result;
  35
  36 import com.datastax.driver.core.Cluster;
  37 import com.datastax.driver.core.ConsistencyLevel;
  38 import com.datastax.driver.core.ResultSet;
  39 import com.datastax.driver.core.Row;
  40
  41 /**
  42  * History
  43  *
  44  * Originally written PE3617
  45  * @author Jonathan
  46  *
  47  * History is a special case, because we don't want Updates or Deletes...  Too likely to mess up history.
  48  *
  49  * Jonathan 9-9-2013 - Found a problem with using "Prepare".  You cannot prepare anything with a "now()" in it, as
  50  * it is evaluated once during the prepare, and kept.  That renders any use of "now()" pointless.  Therefore
  51  * the Create function needs to be run fresh everytime.
  52  *
  53  * Fixed in Cassandra 1.2.6 https://issues.apache.org/jira/browse/CASSANDRA-5616
  54  *
  55  */
  56 public class HistoryDAO extends CassDAOImpl<AuthzTrans, HistoryDAO.Data> {
  57     private static final String TABLE = "history";
  58
  59     private String[] helpers;
  60
  61     private HistLoader defLoader;
  62
  63     private AbsCassDAO<AuthzTrans, Data>.PSInfo readByUser, readBySubject, readByYRMN;
  64
  65     public HistoryDAO(AuthzTrans trans, Cluster cluster, String keyspace) {
  66         super(trans, HistoryDAO.class.getSimpleName(),cluster,keyspace,Data.class,TABLE,ConsistencyLevel.LOCAL_ONE,ConsistencyLevel.ANY);
  67         init(trans);
  68     }
  69
  70     public HistoryDAO(AuthzTrans trans, AbsCassDAO<AuthzTrans,?> aDao) {
  71         super(trans, HistoryDAO.class.getSimpleName(),aDao,Data.class,TABLE,ConsistencyLevel.LOCAL_ONE,ConsistencyLevel.ANY);
  72         init(trans);
  73     }
  74
  75
  76     private static final int KEYLIMIT = 1;
  77     public static class Data {
  78         public UUID id;
  79         public int    yr_mon;
  80         public String user;
  81         public String action;
  82         public String target;
  83         public String subject;
  84         public String  memo;
  85         public ByteBuffer reconstruct;
  86     }
  87
  88     public static class HistLoader extends Loader<Data> {
  89         public HistLoader(int keylimit) {
  90             super(keylimit);
  91         }
  92
  93         @Override
  94         public Data load(Data data, Row row) {
  95             data.id = row.getUUID(0);
  96             data.yr_mon = row.getInt(1);
  97             data.user = row.getString(2);
  98             data.action = row.getString(3);
  99             data.target = row.getString(4);
 100             data.subject = row.getString(5);
 101             data.memo = row.getString(6);
 102             data.reconstruct = row.getBytes(7);
 103             return data;
 104         }
 105
 106         @Override
 107         protected void key(Data data, int idx, Object[] obj) {
 108             obj[idx]=data.id;
 109         }
 110
 111         @Override
 112         protected void body(Data data, int _idx, Object[] obj) {
 113                 int idx = _idx;
 114             obj[idx]=data.yr_mon;
 115             obj[++idx]=data.user;
 116             obj[++idx]=data.action;
 117             obj[++idx]=data.target;
 118             obj[++idx]=data.subject;
 119             obj[++idx]=data.memo;
 120 //            obj[++idx]=data.detail;
 121             obj[++idx]=data.reconstruct;
 122         }
 123     };
 124
 125     private void init(AuthzTrans trans) {
 126         // Loader must match fields order
 127         defLoader = new HistLoader(KEYLIMIT);
 128         helpers = setCRUD(trans, TABLE, Data.class, defLoader);
 129
 130         // Need a specialty Creator to handle the "now()"
 131         // 9/9/2013 - Jonathan - Just great... now() is evaluated once on Client side, invalidating usage (what point is a now() from a long time in the past?
 132         // Unless this is fixed, we're putting in non-prepared statement
 133         // Solved in Cassandra.  Make sure you are running 1.2.6 Cassandra or later. https://issues.apache.org/jira/browse/CASSANDRA-5616
 134         replace(CRUD.create, new PSInfo(trans, "INSERT INTO history (" +  helpers[FIELD_COMMAS] +
 135                     ") VALUES(now(),?,?,?,?,?,?,?)",
 136                     new HistLoader(0) {
 137                         @Override
 138                         protected void key(Data data, int idx, Object[] obj) {
 139                         }
 140                     },writeConsistency)
 141                 );
 142 //        disable(CRUD.Create);
 143
 144         replace(CRUD.read, new PSInfo(trans, SELECT_SP +  helpers[FIELD_COMMAS] +
 145                 " FROM history WHERE id = ?", defLoader,readConsistency)
 146 //                new HistLoader(2) {
 147 //                    @Override
 148 //                    protected void key(Data data, int idx, Object[] obj) {
 149 //                        obj[idx]=data.yr_mon;
 150 //                        obj[++idx]=data.id;
 151 //                    }
 152 //                })
 153             );
 154         disable(CRUD.update);
 155         disable(CRUD.delete);
 156
 157         readByUser = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] +
 158                 " FROM history WHERE user = ?", defLoader,readConsistency);
 159         readBySubject = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] +
 160                 " FROM history WHERE subject = ? and target = ? ALLOW FILTERING", defLoader,readConsistency);
 161         readByYRMN = new PSInfo(trans, SELECT_SP + helpers[FIELD_COMMAS] +
 162                 " FROM history WHERE yr_mon = ?", defLoader,readConsistency);
 163         async(true); //TODO dropping messages with Async
 164     }
 165
 166     public static Data newInitedData() {
 167         Data data = new Data();
 168         Date now = new Date();
 169         // Sonar claims that SimpleDateFormat is not thread safe, so we can't be static
 170         data.yr_mon = Integer.parseInt(new SimpleDateFormat("yyyyMM").format(now));
 171         // data.day_time = Integer.parseInt(dayTimeFormat.format(now));
 172         return data;
 173     }
 174
 175     public void createBatch(StringBuilder sb, Data data) {
 176         sb.append("INSERT INTO history (");
 177         sb.append(helpers[FIELD_COMMAS]);
 178         sb.append(") VALUES(now(),");
 179         sb.append(data.yr_mon);
 180         sb.append(",'");
 181         sb.append(data.user);
 182         sb.append("','");
 183         sb.append(data.action);
 184         sb.append("','");
 185         sb.append(data.target);
 186         sb.append("','");
 187         sb.append(data.subject);
 188         sb.append("','");
 189         sb.append(data.memo);
 190         sb.append("',null);\n");
 191     }
 192
 193     public Result<List<Data>> readByYYYYMM(AuthzTrans trans, int yyyymm) {
 194         Result<ResultSet> rs = readByYRMN.exec(trans, "yr_mon", yyyymm);
 195         if (rs.notOK()) {
 196             return Result.err(rs);
 197         }
 198         return extract(defLoader,rs.value,null,dflt);
 199     }
 200
 201     /**
 202      * Gets the history for a user in the specified year and month
 203      * year - the year in yyyy format
 204      * month -  the month in a year ...values 1 - 12
 205      **/
 206     public Result<List<Data>> readByUser(AuthzTrans trans, String user, int ... yyyymm) {
 207         if (yyyymm.length==0) {
 208             return Result.err(Status.ERR_BadData, "No or invalid yyyymm specified");
 209         }
 210         Result<ResultSet> rs = readByUser.exec(trans, "user", user);
 211         if (rs.notOK()) {
 212             return Result.err(rs);
 213         }
 214         return extract(defLoader,rs.value,null,yyyymm.length>0?new YYYYMM(yyyymm):dflt);
 215     }
 216
 217     public Result<List<Data>> readBySubject(AuthzTrans trans, String subject, String target, int ... yyyymm) {
 218         if (yyyymm.length==0) {
 219             return Result.err(Status.ERR_BadData, "No or invalid yyyymm specified");
 220         }
 221         Result<ResultSet> rs = readBySubject.exec(trans, "subject", subject, target);
 222         if (rs.notOK()) {
 223             return Result.err(rs);
 224         }
 225         return extract(defLoader,rs.value,null,yyyymm.length>0?new YYYYMM(yyyymm):dflt);
 226     }
 227
 228     private class YYYYMM implements Accept<Data> {
 229         private int[] yyyymm;
 230         public YYYYMM(int yyyymm[]) {
 231             this.yyyymm = yyyymm;
 232         }
 233         @Override
 234         public boolean ok(Data data) {
 235             int dym = data.yr_mon;
 236             for (int ym:yyyymm) {
 237                 if (dym==ym) {
 238                     return true;
 239                 }
 240             }
 241             return false;
 242         }
 243
 244     };
 245
 246 }