src/main/java/org/onap/aai/modelloader/service/ModelLoaderService.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.modelloader.service;
  22
  23 import java.io.IOException;
  24 import java.nio.file.Files;
  25 import java.nio.file.Paths;
  26 import java.util.ArrayList;
  27 import java.util.Base64;
  28 import java.util.Date;
  29 import java.util.List;
  30 import java.util.Properties;
  31 import java.util.Timer;
  32 import java.util.TimerTask;
  33
  34 import javax.annotation.PostConstruct;
  35 import javax.ws.rs.core.MediaType;
  36 import javax.ws.rs.core.Response;
  37
  38 import org.onap.aai.cl.api.Logger;
  39 import org.onap.aai.cl.eelf.LoggerFactory;
  40 import org.onap.aai.modelloader.config.ModelLoaderConfig;
  41 import org.onap.aai.modelloader.entity.Artifact;
  42 import org.onap.aai.modelloader.notification.ArtifactDownloadManager;
  43 import org.onap.aai.modelloader.notification.EventCallback;
  44 import org.onap.aai.modelloader.notification.NotificationDataImpl;
  45 import org.onap.aai.modelloader.notification.NotificationPublisher;
  46 import org.onap.sdc.api.IDistributionClient;
  47 import org.onap.sdc.api.notification.IArtifactInfo;
  48 import org.onap.sdc.api.results.IDistributionClientResult;
  49 import org.onap.sdc.impl.DistributionClientFactory;
  50 import org.onap.sdc.utils.DistributionActionResultEnum;
  51 import org.springframework.beans.factory.annotation.Autowired;
  52 import org.springframework.beans.factory.annotation.Value;
  53 import org.springframework.web.bind.annotation.PathVariable;
  54 import org.springframework.web.bind.annotation.RequestBody;
  55 import org.springframework.web.bind.annotation.RequestMapping;
  56 import org.springframework.web.bind.annotation.RestController;
  57
  58 /**
  59  * Service class in charge of managing the negotiating model loading capabilities between AAI and an ASDC.
  60  */
  61 @RestController
  62 @RequestMapping("/services/model-loader/v1/model-service")
  63 public class ModelLoaderService implements ModelLoaderInterface {
  64
  65     private static Logger logger = LoggerFactory.getInstance().getLogger(ModelLoaderService.class.getName());
  66
  67     @Value("${CONFIG_HOME}")
  68     private String configDir;
  69     private IDistributionClient client;
  70     private ModelLoaderConfig config;
  71     @Autowired
  72     private BabelServiceClientFactory babelClientFactory;
  73
  74     /**
  75      * Responsible for loading configuration files and calling initialization.
  76      */
  77     @PostConstruct
  78     protected void start() {
  79         // Load model loader system configuration
  80         logger.info(ModelLoaderMsgs.LOADING_CONFIGURATION);
  81         ModelLoaderConfig.setConfigHome(configDir);
  82         Properties configProperties = new Properties();
  83         try {
  84             configProperties.load(Files.newInputStream(Paths.get(configDir, "model-loader.properties")));
  85             config = new ModelLoaderConfig(configProperties);
  86             if (!config.getASDCConnectionDisabled()) {
  87                 initSdcClient();
  88             }
  89         } catch (IOException e) {
  90             String errorMsg = "Failed to load configuration: " + e.getMessage();
  91             logger.error(ModelLoaderMsgs.ASDC_CONNECTION_ERROR, errorMsg);
  92         }
  93     }
  94
  95     /**
  96      * Responsible for stopping the connection to the distribution client before the resource is destroyed.
  97      */
  98     public void preShutdownOperations() {
  99         logger.info(ModelLoaderMsgs.STOPPING_CLIENT);
 100         if (client != null) {
 101             client.stop();
 102         }
 103     }
 104
 105     /**
 106      * Responsible for loading configuration files, initializing model distribution clients, and starting them.
 107      */
 108     protected void initSdcClient() {
 109         // Initialize distribution client
 110         logger.debug(ModelLoaderMsgs.INITIALIZING, "Initializing distribution client...");
 111         client = DistributionClientFactory.createDistributionClient();
 112         EventCallback callback = new EventCallback(client, config, babelClientFactory);
 113
 114         IDistributionClientResult initResult = client.init(config, callback);
 115
 116         if (initResult.getDistributionActionResult() == DistributionActionResultEnum.SUCCESS) {
 117             // Start distribution client
 118             logger.debug(ModelLoaderMsgs.INITIALIZING, "Starting distribution client...");
 119             IDistributionClientResult startResult = client.start();
 120             if (startResult.getDistributionActionResult() == DistributionActionResultEnum.SUCCESS) {
 121                 logger.info(ModelLoaderMsgs.INITIALIZING, "Connection to SDC established");
 122             } else {
 123                 String errorMsg = "Failed to start distribution client: " + startResult.getDistributionMessageResult();
 124                 logger.error(ModelLoaderMsgs.ASDC_CONNECTION_ERROR, errorMsg);
 125
 126                 // Kick off a timer to retry the SDC connection
 127                 Timer timer = new Timer();
 128                 TimerTask task = new SdcConnectionJob(client, config, callback, timer);
 129                 timer.schedule(task, new Date(), 60000);
 130             }
 131         } else {
 132             String errorMsg = "Failed to initialize distribution client: " + initResult.getDistributionMessageResult();
 133             logger.error(ModelLoaderMsgs.ASDC_CONNECTION_ERROR, errorMsg);
 134
 135             // Kick off a timer to retry the SDC connection
 136             Timer timer = new Timer();
 137             TimerTask task = new SdcConnectionJob(client, config, callback, timer);
 138             timer.schedule(task, new Date(), 60000);
 139         }
 140
 141         Runtime.getRuntime().addShutdownHook(new Thread(this::preShutdownOperations));
 142     }
 143
 144     /**
 145      * (non-Javadoc)
 146      *
 147      * @see org.onap.aai.modelloader.service.ModelLoaderInterface#loadModel(java.lang.String)
 148      */
 149     @Override
 150     public Response loadModel(@PathVariable String modelid) {
 151         return Response.ok("{\"model_loaded\":\"" + modelid + "\"}").build();
 152     }
 153
 154     /**
 155      * (non-Javadoc)
 156      *
 157      * @see org.onap.aai.modelloader.service.ModelLoaderInterface#saveModel(java.lang.String, java.lang.String)
 158      */
 159     @Override
 160     public Response saveModel(@PathVariable String modelid, @PathVariable String modelname) {
 161         return Response.ok("{\"model_saved\":\"" + modelid + "-" + modelname + "\"}").build();
 162     }
 163
 164     @Override
 165     public Response ingestModel(@PathVariable String modelName, @PathVariable String modelVersion,
 166             @RequestBody String payload) throws IOException {
 167         Response response;
 168
 169         if (config.getIngestSimulatorEnabled()) {
 170             response = processTestArtifact(modelName, modelVersion, payload);
 171         } else {
 172             logger.debug("Simulation interface disabled");
 173             response = Response.serverError().build();
 174         }
 175
 176         return response;
 177     }
 178
 179     private Response processTestArtifact(String modelName, String modelVersion, String payload) {
 180         IArtifactInfo artifactInfo = new ArtifactInfoImpl();
 181         ((ArtifactInfoImpl) artifactInfo).setArtifactName(modelName);
 182         ((ArtifactInfoImpl) artifactInfo).setArtifactVersion(modelVersion);
 183
 184         Response response;
 185         try {
 186             logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Received test artifact " + modelName + " " + modelVersion);
 187
 188             byte[] csarFile = Base64.getDecoder().decode(payload);
 189
 190             logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Generating XML models from test artifact");
 191
 192             List<Artifact> modelArtifacts = new ArrayList<>();
 193             List<Artifact> catalogArtifacts = new ArrayList<>();
 194
 195             new ArtifactDownloadManager(client, config, babelClientFactory).processToscaArtifacts(modelArtifacts,
 196                     catalogArtifacts, csarFile, artifactInfo, "test-transaction-id", modelVersion);
 197
 198             logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Loading xml models from test artifacts: "
 199                     + modelArtifacts.size() + " model(s) and " + catalogArtifacts.size() + " catalog(s)");
 200
 201             NotificationDataImpl notificationData = new NotificationDataImpl();
 202             notificationData.setDistributionID("TestDistributionID");
 203             boolean success =
 204                     new ArtifactDeploymentManager(config).deploy(notificationData, modelArtifacts, catalogArtifacts);
 205             logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Deployment success was " + success);
 206             response = success ? Response.ok().build() : Response.serverError().build();
 207         } catch (Exception e) {
 208             String responseMessage = e.getMessage();
 209             logger.info(ModelLoaderMsgs.DISTRIBUTION_EVENT, "Exception handled: " + responseMessage);
 210             if (config.getASDCConnectionDisabled()) {
 211                 // Make sure the NotificationPublisher logger is invoked as per the standard processing flow.
 212                 new NotificationPublisher().publishDeployFailure(client, new NotificationDataImpl(), artifactInfo);
 213             } else {
 214                 responseMessage += "\nSDC publishing is enabled but has been bypassed";
 215             }
 216             response = Response.serverError().entity(responseMessage).type(MediaType.APPLICATION_XML).build();
 217         }
 218         return response;
 219     }
 220 }