appc-asdc-listener/appc-asdc-listener-bundle/src/main/java/org/openecomp/appc/sdc/artifacts/helper/ArtifactStorageService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.openecomp.appc.sdc.artifacts.helper;
  26
  27 import org.openecomp.appc.exceptions.APPCException;
  28 import com.att.eelf.configuration.EELFLogger;
  29 import com.att.eelf.configuration.EELFManager;
  30 import org.openecomp.appc.sdc.artifacts.object.SDCReference;
  31 import org.openecomp.sdnc.sli.resource.dblib.DbLibService;
  32 import org.openecomp.appc.sdc.artifacts.object.SDCArtifact;
  33 import org.osgi.framework.BundleContext;
  34 import org.osgi.framework.FrameworkUtil;
  35 import org.osgi.framework.ServiceReference;
  36
  37 import javax.sql.rowset.CachedRowSet;
  38 import java.sql.SQLException;
  39 import java.util.ArrayList;
  40
  41 import static org.openecomp.appc.sdc.artifacts.helper.Constants.COMMA;
  42 import static org.openecomp.appc.sdc.artifacts.helper.Constants.AND;
  43
  44 /**
  45  * Provides methods for storing sdc artifacts into app-c database
  46  */
  47 public class ArtifactStorageService {
  48
  49     private DbLibService dbLibService;
  50
  51     private static final String SCHEMA =  "sdnctl";
  52
  53     private static final String SELECT_QUERY = Constants.SELECT_FROM + Constants.ASDC_ARTIFACTS +
  54             Constants.WHERE + Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_NAME + Constants.QUERY_PLACEHOLDER +
  55             AND + Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_VERSION + Constants.QUERY_PLACEHOLDER +
  56             AND + Constants.ARTIFACT_TYPE + Constants.QUERY_PLACEHOLDER;
  57
  58     private static final String SELECT_QUERY_SDC_REFERENCE = Constants.SELECT_FROM + Constants.ASDC_REFERENCE +
  59             Constants.WHERE + Constants.ASDC_REFERENCE_FIELDS.VNF_TYPE + Constants.QUERY_PLACEHOLDER +
  60             AND + Constants.ASDC_REFERENCE_FIELDS.FILE_CATEGORY + Constants.QUERY_PLACEHOLDER ;
  61
  62     private static final String INSERT_QUERY = Constants.INSERT + Constants.ASDC_ARTIFACTS +
  63             " ( " + Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_UUID + COMMA +
  64             Constants.ASDC_ARTIFACTS_FIELDS.DISTRIBUTION_ID + COMMA +
  65             Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_NAME + COMMA +
  66             Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_DESCRIPTION + COMMA +
  67             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_UUID + COMMA +
  68             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_INSTANCE_NAME + COMMA +
  69             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_NAME + COMMA +
  70             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_VERSION + COMMA +
  71             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_TYPE + COMMA +
  72             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_UUID + COMMA +
  73             Constants.ARTIFACT_TYPE + COMMA +
  74             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_VERSION + COMMA +
  75             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_DESCRIPTION + COMMA +
  76             Constants.ASDC_ARTIFACTS_FIELDS.CREATION_DATE + COMMA +
  77             Constants.ARTIFACT_NAME  +COMMA +
  78             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_CONTENT + " ) values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
  79
  80     private static final String INSERT_QUERY_WITH_INT_VER = Constants.INSERT + Constants.ASDC_ARTIFACTS +
  81             " ( " + Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_UUID + COMMA +
  82             Constants.ASDC_ARTIFACTS_FIELDS.DISTRIBUTION_ID + COMMA +
  83             Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_NAME + COMMA +
  84             Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_DESCRIPTION + COMMA +
  85             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_UUID + COMMA +
  86             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_INSTANCE_NAME + COMMA +
  87             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_NAME + COMMA +
  88             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_VERSION + COMMA +
  89             Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_TYPE + COMMA +
  90             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_UUID + COMMA +
  91             Constants.ARTIFACT_TYPE + COMMA +
  92             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_VERSION + COMMA +
  93             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_DESCRIPTION + COMMA +
  94             Constants.ASDC_ARTIFACTS_FIELDS.CREATION_DATE + COMMA +
  95             Constants.ARTIFACT_NAME + COMMA +
  96             Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_CONTENT + COMMA +
  97             Constants.ASDC_ARTIFACTS_FIELDS.INTERNAL_VERSION + " ) values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
  98
  99     private static final String ASDC_REF_INSERT_QUERY = Constants.INSERT + Constants.ASDC_REFERENCE +
 100             "( "+ Constants.ASDC_REFERENCE_FIELDS.VNF_TYPE + COMMA +
 101             Constants.ASDC_REFERENCE_FIELDS.VNFC_TYPE+ COMMA +
 102             Constants.ASDC_REFERENCE_FIELDS.FILE_CATEGORY +COMMA +
 103             Constants.ASDC_REFERENCE_FIELDS.ACTION +COMMA +
 104             Constants.ARTIFACT_TYPE + COMMA +
 105             Constants.ARTIFACT_NAME  + " ) values (?,?,?,?,?,?)";
 106
 107     private static final String SELECT_MAX_INT_VERSION = "SELECT coalesce(max(" + Constants.ASDC_ARTIFACTS_FIELDS.INTERNAL_VERSION + ")+1,1) as " + Constants.ASDC_ARTIFACTS_FIELDS.INTERNAL_VERSION  +
 108             " FROM " + Constants.ASDC_ARTIFACTS + Constants.WHERE + Constants.ARTIFACT_NAME  + Constants.QUERY_PLACEHOLDER;
 109
 110
 111     private final EELFLogger logger = EELFManager.getInstance().getLogger(ArtifactStorageService.class);
 112
 113     /**
 114      * Stores Artifact received from SDC into APP-C database
 115      * @param artifact - SDC Artifact object
 116      * @throws APPCException
 117      */
 118     public void storeASDCArtifact(SDCArtifact artifact) throws APPCException {
 119         if(logger.isDebugEnabled()){
 120             logger.debug("Entering storeASDCArtifact with : " + artifact.toString());
 121         }
 122         try {
 123             initializeDBLibService();
 124             ArrayList<String> arguments = prepareArguments(artifact);
 125             dbLibService.writeData(INSERT_QUERY,arguments,SCHEMA);
 126         } catch (SQLException e) {
 127             logger.error("Error storing artifact in database : " +artifact.toString(),e);
 128             throw new APPCException(e.getMessage(),e);
 129         }
 130         if(logger.isDebugEnabled()){
 131             logger.debug("Exiting storeASDCArtifact");
 132         }
 133     }
 134
 135     /**
 136      * Stores Artifact received from SDC and its Reference into APP-C database if it does not exist
 137      * @param artifact - SDC Artifact object
 138      * @param reference - SDC reference object
 139      * @throws APPCException
 140      */
 141     public void storeASDCArtifactWithReference(SDCArtifact artifact , SDCReference reference) throws APPCException {
 142         if(logger.isDebugEnabled()){
 143             logger.debug("Entering storeASDCArtifactWithReference with : " + artifact.toString());
 144         }
 145         try {
 146             initializeDBLibService();
 147             SDCArtifact existingArtifact = retrieveSDCArtifact(artifact.getResourceName(), artifact.getResourceVersion(),artifact.getArtifactType());
 148             if (existingArtifact ==null) { // new resource
 149                 logger.debug(String.format("Artifact not found for vnfType = %s, version = %s and artifactType = %s. Inserting data." ,
 150                         artifact.getResourceName(),artifact.getResourceVersion() ,artifact.getArtifactType()));
 151                 ArrayList<String> arguments = prepareArguments(artifact);
 152                 Integer version = getNextInternalVersion(artifact.getArtifactName());
 153                 arguments.add(version.toString());
 154                 dbLibService.writeData(INSERT_QUERY_WITH_INT_VER,arguments,SCHEMA);
 155             } else { // duplicate
 156                 logger.debug(String.format("Artifact of type '%s' already deployed for resource_type='%s' and resource_version='%s'",
 157                         artifact.getArtifactType() , artifact.getResourceName() , artifact.getResourceVersion()));
 158             }
 159
 160             SDCReference existingReference = retrieveSDCReference(reference.getVnfType(),reference.getFileCategory());
 161             if(existingReference == null){
 162                 logger.debug("Inserting SDC Reference data: " +reference.toString());
 163                 ArrayList<String> arguments = prepareReferenceArguments(reference);
 164                 dbLibService.writeData(ASDC_REF_INSERT_QUERY,arguments,SCHEMA);
 165             }else{
 166                 logger.debug("Artifact reference already exists for: " +reference.toString());
 167             }
 168         } catch (SQLException e) {
 169             logger.error("Error storing artifact to database: " + artifact.toString(),e);
 170             throw new APPCException(e.getMessage(),e);
 171         }
 172         if(logger.isDebugEnabled()){
 173             logger.debug("Exiting storeASDCArtifactWithReference");
 174         }
 175     }
 176
 177     private Integer getNextInternalVersion(String artifactName) throws APPCException {
 178         if (logger.isDebugEnabled()) {
 179             logger.debug("Entering getNextInternalVersion with artifactName:" + artifactName);
 180         }
 181         Integer version = 1;
 182         try {
 183             initializeDBLibService();
 184             ArrayList<String> arguments = new ArrayList<>();
 185             arguments.add(artifactName);
 186             CachedRowSet rowSet = dbLibService.getData(SELECT_MAX_INT_VERSION, arguments, SCHEMA);
 187             if (rowSet.first()) {
 188                 version = rowSet.getInt(Constants.ASDC_ARTIFACTS_FIELDS.INTERNAL_VERSION .toString());
 189             }
 190         }catch (SQLException e) {
 191             logger.error("Error getting internal version for artifact name " + artifactName , e);
 192             throw new APPCException(e);
 193         }
 194         if (logger.isDebugEnabled()) {
 195             logger.debug("Exiting getNextInternalVersion with retrieved version:" + version.toString());
 196         }
 197         return version;
 198     }
 199
 200     private void initializeDBLibService() {
 201         if(dbLibService == null){
 202             BundleContext context = FrameworkUtil.getBundle(DbLibService.class).getBundleContext();
 203             ServiceReference serviceReference = context.getServiceReference(DbLibService.class.getName());
 204             dbLibService  = (DbLibService)context.getService(serviceReference);
 205         }
 206     }
 207
 208     private ArrayList<String> prepareReferenceArguments(SDCReference reference) {
 209         ArrayList<String> arguments = new ArrayList<>();
 210         arguments.add(reference.getVnfType());
 211         arguments.add(reference.getVnfcType());
 212         arguments.add(reference.getFileCategory());
 213         arguments.add(reference.getAction());
 214         arguments.add(reference.getArtifactType());
 215         arguments.add(reference.getArtifactName());
 216         return arguments;
 217     }
 218
 219     private ArrayList<String> prepareArguments(SDCArtifact artifact) {
 220         ArrayList<String> arguments = new ArrayList<>();
 221         arguments.add(artifact.getServiceUUID());
 222         arguments.add(artifact.getDistributionId());
 223         arguments.add(artifact.getServiceName());
 224         arguments.add(artifact.getServiceDescription());
 225         arguments.add(artifact.getResourceUUID());
 226         arguments.add(artifact.getResourceInstanceName());
 227         arguments.add(artifact.getResourceName());
 228         arguments.add(artifact.getResourceVersion());
 229         arguments.add(artifact.getResourceType());
 230         arguments.add(artifact.getArtifactUUID());
 231         arguments.add(artifact.getArtifactType());
 232         arguments.add(artifact.getArtifactVersion());
 233         arguments.add(artifact.getArtifactDescription());
 234         arguments.add(artifact.getCreationDate());
 235         arguments.add(artifact.getArtifactName());
 236         arguments.add(artifact.getArtifactContent());
 237         return arguments;
 238     }
 239
 240     /**
 241      * Reads the SDC artifact from APP-C database
 242      * @param resourceName  - resource Name from ASDC Artifact
 243      * @param resourceVersion - resource version from ASDC Artifact
 244      * @param artifactType artifact type from ASDC Artifact
 245      * @return - ASDC_ARTIFACT record if data exists
 246      * @throws APPCException
 247      */
 248     public SDCArtifact retrieveSDCArtifact(String resourceName, String resourceVersion, String artifactType) throws APPCException {
 249         SDCArtifact artifact = null;
 250         try {
 251             initializeDBLibService();
 252             ArrayList<String> arguments = new ArrayList<>();
 253             arguments.add(resourceName);
 254             arguments.add(resourceVersion);
 255             arguments.add(artifactType);
 256             CachedRowSet rowSet = dbLibService.getData(SELECT_QUERY, arguments, SCHEMA);
 257             if (rowSet.first()) {
 258                 artifact = new SDCArtifact();
 259                 artifact.setArtifactUUID(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_UUID.toString()));
 260                 artifact.setArtifactName(rowSet.getString(Constants.ARTIFACT_NAME));
 261                 artifact.setArtifactType(rowSet.getString(Constants.ARTIFACT_TYPE));
 262                 artifact.setArtifactVersion(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_VERSION.toString()));
 263                 artifact.setArtifactDescription(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_DESCRIPTION.toString()));
 264                 artifact.setArtifactContent(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.ARTIFACT_CONTENT.toString()));
 265
 266                 artifact.setResourceUUID(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_UUID.toString()));
 267                 artifact.setResourceName(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_NAME.toString()));
 268                 artifact.setResourceType(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_TYPE.toString()));
 269                 artifact.setResourceVersion(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_VERSION.toString()));
 270                 artifact.setResourceInstanceName(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_INSTANCE_NAME.toString()));
 271
 272                 artifact.setServiceUUID(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_UUID.toString()));
 273                 artifact.setServiceName(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_NAME.toString()));
 274                 artifact.setServiceDescription(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.SERVICE_DESCRIPTION.toString()));
 275
 276                 artifact.setCreationDate(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.CREATION_DATE.toString()));
 277                 artifact.setDistributionId(rowSet.getString(Constants.ASDC_ARTIFACTS_FIELDS.DISTRIBUTION_ID.toString()));
 278             }
 279
 280         } catch (SQLException e) {
 281             logger.error("Error query artifact for " + Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_NAME + " = " + resourceName +
 282                     Constants.ASDC_ARTIFACTS_FIELDS.RESOURCE_VERSION + " = " + resourceVersion +
 283                     Constants.ARTIFACT_TYPE + " = " + artifactType, e);
 284             throw new APPCException(e);
 285         }
 286         return artifact;
 287     }
 288
 289     /**
 290      * Reads the SDC reference from APP-C database
 291      * @param vnfType  - vnf Type from ASDC reference
 292      * @param fileCategory - file category from ASDC reference
 293      * @return - ASDC_ARTIFACT record if data exists
 294      * @throws APPCException
 295      */
 296     public SDCReference retrieveSDCReference(String vnfType, String fileCategory) throws APPCException {
 297         SDCReference reference = null;
 298         try {
 299             initializeDBLibService();
 300             ArrayList<String> arguments = new ArrayList<>();
 301             arguments.add(vnfType);
 302             arguments.add(fileCategory);
 303             CachedRowSet rowSet = dbLibService.getData(SELECT_QUERY_SDC_REFERENCE, arguments, SCHEMA);
 304             if (rowSet.first()) {
 305                 reference = new SDCReference();
 306                 reference.setVnfType(rowSet.getString(Constants.ASDC_REFERENCE_FIELDS.VNF_TYPE.toString()));
 307                 reference.setVnfcType(rowSet.getString(Constants.ASDC_REFERENCE_FIELDS.VNFC_TYPE.toString()));
 308                 reference.setFileCategory(rowSet.getString(Constants.ASDC_REFERENCE_FIELDS.FILE_CATEGORY.toString()));
 309                 reference.setAction(rowSet.getString(Constants.ASDC_REFERENCE_FIELDS.ACTION.toString()));
 310                 reference.setArtifactType(rowSet.getString(Constants.ARTIFACT_TYPE));
 311                 reference.setArtifactName(rowSet.getString(Constants.ARTIFACT_NAME));
 312             }
 313         } catch (SQLException e) {
 314             logger.error("Error querying ASDC_REFERENCE for " + Constants.ASDC_REFERENCE_FIELDS.VNF_TYPE + " = " + vnfType +
 315                     Constants.ASDC_REFERENCE_FIELDS.FILE_CATEGORY + " = " + fileCategory , e);
 316             throw new APPCException(e);
 317         }
 318         return reference;
 319     }
 320 }