mso-api-handlers/mso-api-handler-infra/src/main/java/org/openecomp/mso/apihandlerinfra/VolumeInfoHandler.java

   1 package org.openecomp.mso.apihandlerinfra;
   2
   3 /*-
   4  * #%L
   5  * MSO
   6  * %%
   7  * Copyright (C) 2016 ONAP - SO
   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  * #L%
  21  */
  22
  23
  24 import java.io.StringReader;
  25 import java.io.StringWriter;
  26 import java.util.LinkedList;
  27 import java.util.List;
  28
  29 import javax.ws.rs.GET;
  30 import javax.ws.rs.Path;
  31 import javax.ws.rs.PathParam;
  32 import javax.ws.rs.QueryParam;
  33 import javax.ws.rs.core.Response;
  34 import javax.xml.bind.JAXBContext;
  35 import javax.xml.bind.JAXBException;
  36 import javax.xml.bind.Marshaller;
  37 import javax.xml.bind.Unmarshaller;
  38 import javax.xml.transform.sax.SAXSource;
  39
  40 import org.apache.http.HttpStatus;
  41 import org.openecomp.mso.apihandler.common.ValidationException;
  42 import org.openecomp.mso.apihandlerinfra.volumebeans.ActionType;
  43 import org.openecomp.mso.apihandlerinfra.volumebeans.ObjectFactory;
  44 import org.openecomp.mso.apihandlerinfra.volumebeans.RequestInfo;
  45 import org.openecomp.mso.apihandlerinfra.volumebeans.RequestStatusType;
  46 import org.openecomp.mso.apihandlerinfra.volumebeans.VolumeInputs;
  47 import org.openecomp.mso.apihandlerinfra.volumebeans.VolumeOutputs;
  48 import org.openecomp.mso.apihandlerinfra.volumebeans.VolumeRequest;
  49 import org.openecomp.mso.apihandlerinfra.volumebeans.VolumeRequests;
  50 import org.openecomp.mso.logger.MsoLogger;
  51 import org.openecomp.mso.requestsdb.InfraActiveRequests;
  52 import org.openecomp.mso.requestsdb.InfraRequests;
  53 import org.openecomp.mso.requestsdb.RequestsDatabase;
  54 import org.openecomp.mso.utils.UUIDChecker;
  55 import org.xml.sax.InputSource;
  56
  57 import com.wordnik.swagger.annotations.Api;
  58 import com.wordnik.swagger.annotations.ApiOperation;
  59
  60 @Path("/{version: v1|v2|v3}/volume-request")
  61 @Api(value="/{version: v1|v2|v3}/volume-request",description="API Requests for volumeRequest")
  62 public class VolumeInfoHandler {
  63
  64         protected ObjectFactory beansObjectFactory = new ObjectFactory ();
  65
  66         private static MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.APIH);
  67
  68     @GET
  69     @ApiOperation(value="Finds Volume Requests",response=Response.class)
  70     public Response queryFilters (@QueryParam("vnf-type") String vnfType,
  71                                   @QueryParam("service-type") String serviceType,
  72                                   @QueryParam("aic-node-clli") String aicNodeClli,
  73                                   @QueryParam("tenantId") String tenantId,
  74                                   @QueryParam("volume-group-id") String volumeGroupId,
  75                                   @QueryParam("volume-group-name") String volumeGroupName,
  76                                   @PathParam("version") String version) {
  77         long startTime = System.currentTimeMillis ();
  78         MsoLogger.setServiceName ("VolumeQueryFilters");
  79         // Generate a Request Id
  80         UUIDChecker.generateUUID(msoLogger);
  81         msoLogger.debug ("Incoming request received for queryFilter with vnf-type:" + vnfType
  82                                                                 + " service-type:" + serviceType
  83                                                                 + " aic-node-clli:" + aicNodeClli
  84                                                                 + " tenant-id:" + tenantId
  85                                                                 + " volume-group-id:" + volumeGroupId
  86                                                                 + " volume-group-name:" + volumeGroupName);
  87         Response response;
  88         if (vnfType != null) {
  89             response = this.getRequestList ("vnfType", vnfType, version);
  90         } else {
  91                 response = queryGenericFilters (serviceType, aicNodeClli, tenantId, volumeGroupId, volumeGroupName, version);
  92         }
  93         msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, "Successful");
  94         msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
  95         return response;
  96     }
  97
  98     @GET
  99     @Path(Constants.REQUEST_ID_PATH)
 100     @ApiOperation(value="Find Volume Outputs by requestId and verison",response=Response.class)
 101     public Response getRequest (@PathParam("request-id") String requestId, @PathParam("version") String version) {
 102
 103         // Check INFRA_ACTIVE_REQUESTS table to find info
 104         // on this request
 105
 106         long startTime = System.currentTimeMillis ();
 107         MsoLogger.setServiceName ("VolumeGetRequest");
 108         // Generate a Request Id
 109         UUIDChecker.generateUUID(msoLogger);
 110         msoLogger.debug ("Incoming request received for getRequest with request-id:" + requestId);
 111
 112         Response response = getRequestGeneric (requestId, version);
 113         msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc, "Successful");
 114         msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
 115         return response;
 116
 117     }
 118
 119
 120     protected MsoLogger getMsoLogger () {
 121         return msoLogger;
 122     }
 123
 124
 125      protected void fillVolumeRequest (VolumeRequest qr, InfraRequests ar, String version) {
 126         VolumeInputs vi = beansObjectFactory.createVolumeInputs ();
 127
 128         if (ar.getVolumeGroupId () != null) {
 129             vi.setVolumeGroupId (ar.getVolumeGroupId ());
 130         }
 131         if (ar.getVolumeGroupName () != null) {
 132             vi.setVolumeGroupName (ar.getVolumeGroupName ());
 133         }
 134         if (ar.getVnfType () != null) {
 135             vi.setVnfType (ar.getVnfType ());
 136         }
 137
 138          switch (version) {
 139              case Constants.SCHEMA_VERSION_V1:
 140                  if (ar.getServiceType() != null) {
 141                      vi.setServiceType(ar.getServiceType());
 142                  }
 143                  if (ar.getAicNodeClli() != null) {
 144                      vi.setAicNodeClli(ar.getAicNodeClli());
 145                  }
 146                  break;
 147              case Constants.SCHEMA_VERSION_V2:
 148                  if (ar.getAaiServiceId() != null) {
 149                      vi.setServiceId(ar.getAaiServiceId());
 150                  }
 151                  if (ar.getAicCloudRegion() != null) {
 152                      vi.setAicCloudRegion(ar.getAicCloudRegion());
 153                  }
 154                  if (ar.getVfModuleModelName() != null) {
 155                      vi.setVfModuleModelName(ar.getVfModuleModelName());
 156                  }
 157                  break;
 158              case Constants.SCHEMA_VERSION_V3:
 159                  if (ar.getAaiServiceId() != null) {
 160                      vi.setServiceId(ar.getAaiServiceId());
 161                  }
 162                  if (ar.getAicCloudRegion() != null) {
 163                      vi.setAicCloudRegion(ar.getAicCloudRegion());
 164                  }
 165                  if (ar.getVfModuleModelName() != null) {
 166                      vi.setVfModuleModelName(ar.getVfModuleModelName());
 167                  }
 168                  if (ar.getServiceInstanceId() != null) {
 169                      vi.setServiceInstanceId(ar.getServiceInstanceId());
 170                  }
 171                  if (ar.getVnfId() != null) {
 172                      vi.setVnfId(ar.getVnfId());
 173                  }
 174                  break;
 175          }
 176         if (ar.getTenantId () != null) {
 177             vi.setTenantId (ar.getTenantId ());
 178         }
 179
 180         qr.setVolumeInputs (vi);
 181
 182         qr.setVolumeParams(ar.getVnfParams ());
 183
 184         try {
 185             String volumeoutputs = ar.getVnfOutputs ();
 186             if (volumeoutputs != null && volumeoutputs.length () > 0) {
 187                 msoLogger.debug ("Read VOLUME outputs: " + volumeoutputs);
 188                 VolumeOutputs volumeOutput = null;
 189
 190                 // Now unmarshal it into network outputs
 191                 try {
 192                     JAXBContext jaxbContext = JAXBContext.newInstance (VolumeOutputs.class);
 193                     Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller ();
 194
 195                     InputSource inputSource = new InputSource (new StringReader (volumeoutputs));
 196                     SAXSource source = new SAXSource (inputSource);
 197
 198                     volumeOutput = (VolumeOutputs) jaxbUnmarshaller.unmarshal (source, VolumeOutputs.class).getValue ();
 199
 200                 } catch (Exception e) {
 201                     msoLogger.debug ("Validation failed", e);
 202                     throw new ValidationException ("format for volume outputs");
 203                 }
 204
 205                 qr.setVolumeOutputs (volumeOutput);
 206             }
 207         } catch (Exception e) {
 208             msoLogger.debug ("exception reading networkOutputs Clob", e);
 209         }
 210     }
 211
 212     protected Response queryGenericFilters (String serviceType, String aicNodeClli, String tenantId, String volumeGroupId, String volumeGroupName, String version) {
 213         if (serviceType != null) {
 214             return this.getRequestList ("serviceType", serviceType, version);
 215         }
 216         if (aicNodeClli != null) {
 217             return this.getRequestList ("aicNodeClli", aicNodeClli, version);
 218         }
 219         if (tenantId != null) {
 220             return this.getRequestList ("tenantId", tenantId, version);
 221         }
 222         if (volumeGroupName != null) {
 223                 return this.getRequestList ("volumeGroupName", volumeGroupName, version);
 224         }
 225         if (volumeGroupId != null) {
 226                 return this.getRequestList ("volumeGroupId", volumeGroupId, version);
 227         }
 228         return Response.status (HttpStatus.SC_BAD_REQUEST).entity ("").build ();
 229     }
 230
 231
 232     protected Response getRequestGeneric (String requestId, String version) {
 233         // Check INFRA_ACTIVE_REQUESTS table  to find info
 234         // on this request
 235
 236         getMsoLogger ().debug ("getRequest: " + requestId);
 237
 238         String responseString;
 239
 240         InfraActiveRequests activeReq = (RequestsDatabase.getInstance()).getRequestFromInfraActive (requestId,
 241                                                                                     "VOLUME");
 242         if (activeReq != null) {
 243             // build response for active
 244             responseString = infraRequestsResponse (activeReq, version);
 245             return Response.status (HttpStatus.SC_OK).entity (responseString).build ();
 246         } else {
 247             // Report that no request has been found
 248             return Response.status (HttpStatus.SC_NOT_FOUND).entity ("").build ();
 249          }
 250     }
 251
 252     protected Response getRequestList (String queryAttribute, String queryValue, String version) {
 253         // Check INFRA_ACTIVE_REQUESTS table to find info
 254         // on this request
 255
 256         getMsoLogger ().debug ("getRequest based on " + queryAttribute + ": " + queryValue);
 257
 258         List <InfraActiveRequests> activeReqList = (RequestsDatabase.getInstance()).getRequestListFromInfraActive (queryAttribute,
 259                                                                                                    queryValue,
 260                                                                                                    "VOLUME");
 261
 262         List <VolumeRequest> queryResponseList = new LinkedList <> ();
 263
 264         if (activeReqList != null) {
 265             // build response for active
 266             queryResponseList = infraRequestsResponses (activeReqList, version);
 267
 268         }
 269
 270
 271         if (queryResponseList != null && !queryResponseList.isEmpty ()) {
 272             String result = this.translateVolumeRequests (queryResponseList);
 273             return Response.status (HttpStatus.SC_OK).entity (result).build ();
 274
 275         } else {
 276             // Report that no request has been found
 277             return Response.status (HttpStatus.SC_NOT_FOUND).entity ("").build ();
 278         }
 279     }
 280
 281     private VolumeRequest fillGeneric (InfraRequests ar) {
 282         VolumeRequest qr = beansObjectFactory.createVolumeRequest ();
 283         RequestInfo ri = beansObjectFactory.createRequestInfo ();
 284         ri.setRequestId (ar.getRequestId ());
 285         ri.setAction (ActionType.fromValue (ar.getAction ()));
 286         ri.setRequestStatus (RequestStatusType.fromValue (ar.getRequestStatus ()));
 287         if (ar.getProgress () != null) {
 288             ri.setProgress (ar.getProgress ().intValue ());
 289         }
 290         if (ar.getSource () != null) {
 291             ri.setSource (ar.getSource ());
 292         }
 293
 294         ri.setStartTime (ar.getStartTime ().toString ());
 295         if (ar.getEndTime () != null) {
 296             ri.setEndTime (ar.getEndTime ().toString ());
 297         }
 298
 299         if (ar.getStatusMessage () != null) {
 300                 ri.setStatusMessage (ar.getStatusMessage ());
 301         }
 302         qr.setRequestInfo (ri);
 303         return qr;
 304     }
 305
 306     private List <VolumeRequest> infraRequestsResponses (List <? extends InfraRequests> arList, String version) {
 307         List <VolumeRequest> queryResponseList = new LinkedList <> ();
 308
 309         for (InfraRequests ar : arList) {
 310             VolumeRequest qr = fillGeneric (ar);
 311             fillVolumeRequest (qr, ar, version);
 312             queryResponseList.add (qr);
 313         }
 314         return queryResponseList;
 315     }
 316
 317     private String translateVolumeRequests (List <VolumeRequest> queryResponseList) {
 318         VolumeRequests queryResponses = new VolumeRequests ();
 319         for (VolumeRequest aQueryResponseList : queryResponseList) {
 320             queryResponses.getVolumeRequest().add(aQueryResponseList);
 321         }
 322
 323         StringWriter stringWriter = new StringWriter ();
 324         try {
 325             JAXBContext jaxbContext = JAXBContext.newInstance (VolumeRequests.class);
 326             Marshaller jaxbMarshaller = jaxbContext.createMarshaller ();
 327
 328             // output pretty printed
 329             jaxbMarshaller.setProperty (Marshaller.JAXB_FORMATTED_OUTPUT, true);
 330
 331             jaxbMarshaller.marshal (queryResponses, stringWriter);
 332
 333         } catch (JAXBException e) {
 334             getMsoLogger ().debug ("Marshalling issue", e);
 335         }
 336
 337         return stringWriter.toString ();
 338     }
 339
 340     private String infraRequestsResponse (InfraRequests ar, String version) {
 341         VolumeRequest qr = fillGeneric (ar);
 342         fillVolumeRequest (qr, ar, version);
 343
 344         StringWriter stringWriter = new StringWriter ();
 345         try {
 346             JAXBContext jaxbContext = JAXBContext.newInstance (VolumeRequest.class);
 347             Marshaller jaxbMarshaller = jaxbContext.createMarshaller ();
 348
 349             jaxbMarshaller.setProperty (Marshaller.JAXB_FORMATTED_OUTPUT, true);
 350             jaxbMarshaller.marshal (qr, stringWriter);
 351
 352         } catch (JAXBException e) {
 353             getMsoLogger ().debug ("Marshalling issue", e);
 354         }
 355
 356         String response = stringWriter.toString ();
 357         return response;
 358     }
 359
 360     private String getAuditLogReturnMsg (Response response) {
 361         String returnMsg = "";
 362         if (response.getStatus() == HttpStatus.SC_OK) {
 363                 returnMsg = "Successful. StatusCode=" + HttpStatus.SC_OK;
 364         } else if (response.getStatus() == HttpStatus.SC_NOT_FOUND) {
 365                 returnMsg = "Record not found . StatusCode=" + HttpStatus.SC_NOT_FOUND;
 366         } else if (response.getStatus() == HttpStatus.SC_BAD_REQUEST) {
 367                 returnMsg = "Bad request: one of the following attribute serviceType, aicNodeClli, tenantId, volumeGroupId, volumeGroupName should be defined. StatusCode=" + HttpStatus.SC_BAD_REQUEST;
 368         }
 369         return returnMsg;
 370     }
 371 }