src/main/java/org/onap/crud/service/CrudAsyncGraphDataService.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 Amdocs
   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.crud.service;
  22
  23 import org.onap.aai.event.api.EventConsumer;
  24 import org.onap.aai.event.api.EventPublisher;
  25
  26 import org.onap.aai.cl.api.LogFields;
  27 import org.onap.aai.cl.api.Logger;
  28 import org.onap.aai.cl.eelf.LoggerFactory;
  29 import org.onap.aai.cl.mdc.MdcContext;
  30 import org.onap.aai.cl.mdc.MdcOverride;
  31 import org.onap.crud.dao.GraphDao;
  32 import org.onap.crud.entity.Edge;
  33 import org.onap.crud.entity.Vertex;
  34 import org.onap.crud.event.GraphEvent;
  35 import org.onap.crud.event.GraphEvent.GraphEventOperation;
  36 import org.onap.crud.event.GraphEvent.GraphEventResult;
  37 import org.onap.crud.event.GraphEventEdge;
  38 import org.onap.crud.event.GraphEventVertex;
  39 import org.onap.crud.exception.CrudException;
  40 import org.onap.crud.logging.CrudServiceMsgs;
  41 import org.onap.crud.parser.CrudResponseBuilder;
  42 import org.onap.crud.util.CrudProperties;
  43 import org.onap.crud.util.CrudServiceConstants;
  44 import org.onap.schema.OxmModelValidator;
  45 import org.onap.schema.RelationshipSchemaValidator;
  46
  47 import java.text.SimpleDateFormat;
  48 import java.util.HashMap;
  49 import java.util.Timer;
  50 import java.util.concurrent.Callable;
  51 import java.util.concurrent.CountDownLatch;
  52 import java.util.concurrent.ExecutionException;
  53 import java.util.concurrent.ExecutorService;
  54 import java.util.concurrent.Executors;
  55 import java.util.concurrent.Future;
  56 import java.util.concurrent.TimeUnit;
  57 import java.util.concurrent.TimeoutException;
  58 import javax.annotation.PreDestroy;
  59 import javax.ws.rs.core.Response.Status;
  60
  61 public class CrudAsyncGraphDataService extends AbstractGraphDataService {
  62
  63   private static Integer requestTimeOut;
  64
  65   private EventPublisher asyncRequestPublisher;
  66
  67   private Timer timer;
  68
  69   public static final Integer DEFAULT_REQUEST_TIMEOUT = 30000;
  70   private static final Integer DEFAULT_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL = 1000;
  71
  72   private static Logger logger = LoggerFactory.getInstance()
  73     .getLogger(CrudAsyncGraphDataService.class.getName());
  74   private static Logger metricsLogger = LoggerFactory.getInstance()
  75     .getMetricsLogger(CrudAsyncGraphDataService.class.getName());
  76   private static LogFields OK_FIELDS = new LogFields();
  77
  78   static {
  79                 OK_FIELDS.setField(Status.OK, Status.OK.toString());
  80   }
  81
  82   public static Integer getRequestTimeOut() {
  83     return requestTimeOut;
  84   }
  85
  86   public CrudAsyncGraphDataService(GraphDao dao,
  87           EventPublisher asyncRequestPublisher,
  88           EventConsumer asyncResponseConsumer) throws CrudException {
  89       this(dao,dao,asyncRequestPublisher,asyncResponseConsumer);
  90   }
  91
  92   public CrudAsyncGraphDataService(GraphDao dao,
  93           GraphDao daoForGet,
  94                   EventPublisher asyncRequestPublisher,
  95                   EventConsumer asyncResponseConsumer) throws CrudException {
  96
  97     super();
  98     this.dao = dao;
  99     this.daoForGet = daoForGet;
 100
 101     requestTimeOut = DEFAULT_REQUEST_TIMEOUT;
 102     try {
 103       requestTimeOut
 104         = Integer.parseInt(CrudProperties.get(CrudServiceConstants.CRD_ASYNC_REQUEST_TIMEOUT));
 105     } catch (NumberFormatException ex) {
 106       // Leave it as the default
 107     }
 108
 109     Integer responsePollInterval = DEFAULT_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL;
 110     try {
 111       responsePollInterval = Integer
 112         .parseInt(CrudProperties
 113                   .get(CrudServiceConstants.CRD_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL));
 114     } catch (Exception ex) {
 115       logger.error(CrudServiceMsgs.ASYNC_DATA_SERVICE_ERROR, "Unable to parse "
 116                    + CrudServiceConstants.CRD_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL
 117                    + " error: " + ex.getMessage());
 118     }
 119
 120     // Start the Response Consumer timer
 121     CrudAsyncResponseConsumer crudAsyncResponseConsumer
 122       = new CrudAsyncResponseConsumer(asyncResponseConsumer);
 123     timer = new Timer("crudAsyncResponseConsumer-1");
 124     timer.schedule(crudAsyncResponseConsumer, responsePollInterval, responsePollInterval);
 125
 126     this.asyncRequestPublisher = asyncRequestPublisher;
 127
 128     logger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO,
 129                 "CrudAsyncGraphDataService initialized SUCCESSFULLY!");
 130   }
 131
 132   public class CollectGraphResponse implements Callable<GraphEvent> {
 133     private volatile GraphEvent graphEvent;
 134     private volatile CountDownLatch latch = new CountDownLatch(1);
 135
 136     @Override
 137     public GraphEvent call() throws TimeoutException {
 138       try {
 139         // Wait until graphEvent is available
 140         latch.await(CrudAsyncGraphDataService.getRequestTimeOut(), TimeUnit.MILLISECONDS);
 141       } catch (InterruptedException e) {
 142         latch.countDown();
 143         if (this.graphEvent != null) {
 144           return this.graphEvent;
 145         } else {
 146           throw new TimeoutException();
 147         }
 148       }
 149       return this.graphEvent;
 150     }
 151
 152     public void populateGraphEvent(GraphEvent event) {
 153       this.graphEvent = event;
 154       latch.countDown();
 155     }
 156   }
 157
 158   private GraphEvent sendAndWait(GraphEvent event) throws CrudException {
 159
 160     long startTimeInMs = System.currentTimeMillis();
 161     SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
 162     MdcOverride override = new MdcOverride();
 163     override.addAttribute(MdcContext.MDC_START_TIME, formatter.format(startTimeInMs));
 164
 165     // publish to request queue
 166     try {
 167       asyncRequestPublisher.sendSync(event.toJson());
 168     } catch (Exception e) {
 169       throw new CrudException("Error publishing request " + event.getTransactionId() + "  Cause: " + e.getMessage(), Status.INTERNAL_SERVER_ERROR);
 170     }
 171
 172     logger.debug(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO, "Event Sent ="+event.toJson());
 173
 174     logger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO,
 175                 "Event submitted of type: " + event.getObjectType() + " with key: " + event.getObjectKey()
 176                 + " , transaction-id: " + event.getTransactionId() + " , operation: "
 177                 + event.getOperation().toString());
 178
 179     ExecutorService executor = Executors
 180       .newSingleThreadExecutor(new CrudThreadFactory("TX-" + event.getTransactionId()));
 181     CollectGraphResponse collector = new CollectGraphResponse();
 182     CrudAsyncGraphEventCache.put(event.getTransactionId(), collector);
 183     GraphEvent response;
 184     Future<GraphEvent> future = executor.submit(collector);
 185     try {
 186       response = future.get(requestTimeOut, TimeUnit.MILLISECONDS);
 187
 188     } catch (InterruptedException | ExecutionException | TimeoutException e) {
 189       CrudAsyncGraphEventCache.invalidate(event.getTransactionId());
 190       logger.error(CrudServiceMsgs.ASYNC_DATA_SERVICE_ERROR,
 191                    "Request timed out for transactionId: " + event.getTransactionId());
 192       future.cancel(true);
 193       throw new CrudException("Timed out , transactionId: " + event.getTransactionId()
 194                               + " , operation: " + event.getOperation().toString(), Status.INTERNAL_SERVER_ERROR);
 195     } finally {
 196       //Kill the thread as the work is completed
 197       executor.shutdownNow();
 198     }
 199     metricsLogger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO, OK_FIELDS, override,
 200             "Total elapsed time for operation: " + event.getOperation().toString()
 201             + " , transactionId: " + event.getTransactionId() + " is "
 202             + Long.toString(System.currentTimeMillis() - startTimeInMs) + " ms");
 203     return response;
 204   }
 205
 206   public String addVertex(String version, String type, VertexPayload payload) throws CrudException {
 207     // Validate the incoming payload
 208     Vertex vertex = OxmModelValidator.validateIncomingUpsertPayload(null, version,
 209                                                                     type, payload.getProperties());
 210     // Create graph request event
 211     GraphEvent event = GraphEvent.builder(GraphEventOperation.CREATE)
 212       .vertex(GraphEventVertex.fromVertex(vertex, version)).build();
 213
 214     GraphEvent response = sendAndWait(event);
 215     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 216       logSuccessResponse(event, response);
 217       return CrudResponseBuilder.buildUpsertVertexResponse(
 218                                                            OxmModelValidator.validateOutgoingPayload(version,
 219                                                                                                      response.getVertex().toVertex()), version);
 220     } else {
 221       logErrorResponse(event, response);
 222       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 223                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 224     }
 225
 226   }
 227
 228   public String addEdge(String version, String type, EdgePayload payload) throws CrudException {
 229     Edge edge = RelationshipSchemaValidator.validateIncomingAddPayload(version, type, payload);
 230     // Create graph request event
 231     GraphEvent event = GraphEvent.builder(GraphEventOperation.CREATE)
 232       .edge(GraphEventEdge.fromEdge(edge, version)).build();
 233
 234     GraphEvent response = sendAndWait(event);
 235     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 236       logSuccessResponse(event, response);
 237       return CrudResponseBuilder.buildUpsertEdgeResponse(
 238                                                          RelationshipSchemaValidator.validateOutgoingPayload(version, response.getEdge().toEdge()),
 239                                                          version);
 240     } else {
 241       logErrorResponse(event, response);
 242       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 243                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 244     }
 245   }
 246
 247   public String updateVertex(String version, String id, String type, VertexPayload payload)
 248     throws CrudException {
 249     Vertex vertex = OxmModelValidator.validateIncomingUpsertPayload(id, version,
 250                                                                     type, payload.getProperties());
 251     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
 252       .vertex(GraphEventVertex.fromVertex(vertex, version)).build();
 253
 254     GraphEvent response = sendAndWait(event);
 255     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 256       logSuccessResponse(event, response);
 257       return CrudResponseBuilder.buildUpsertVertexResponse(
 258                                                            OxmModelValidator.validateOutgoingPayload(version, response.getVertex().toVertex()),
 259                                                            version);
 260     } else {
 261       logErrorResponse(event, response);
 262       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 263                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 264     }
 265
 266   }
 267
 268   public String patchVertex(String version, String id, String type, VertexPayload payload)
 269     throws CrudException {
 270     Vertex existingVertex
 271       = dao.getVertex(id, OxmModelValidator.resolveCollectionType(version, type), version, new HashMap<String, String>());
 272     Vertex patchedVertex = OxmModelValidator.validateIncomingPatchPayload(id, version,
 273                                                                           type, payload.getProperties(),
 274                                                                           existingVertex);
 275     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
 276       .vertex(GraphEventVertex.fromVertex(patchedVertex, version)).build();
 277
 278     GraphEvent response = sendAndWait(event);
 279     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 280       logSuccessResponse(event, response);
 281       return CrudResponseBuilder.buildUpsertVertexResponse(
 282                                                            OxmModelValidator.validateOutgoingPayload(version, response.getVertex().toVertex()),
 283                                                            version);
 284     } else {
 285       logErrorResponse(event, response);
 286       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 287                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 288     }
 289
 290   }
 291
 292   public String deleteVertex(String version, String id, String type) throws CrudException {
 293     type = OxmModelValidator.resolveCollectionType(version, type);
 294     GraphEvent event = GraphEvent.builder(GraphEventOperation.DELETE)
 295       .vertex(new GraphEventVertex(id, version, type, null)).build();
 296
 297     GraphEvent response = sendAndWait(event);
 298     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 299       logSuccessResponse(event, response);
 300       return "";
 301     } else {
 302       logErrorResponse(event, response);
 303       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 304                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 305     }
 306
 307   }
 308
 309   public String deleteEdge(String version, String id, String type) throws CrudException {
 310     RelationshipSchemaValidator.validateType(version, type);
 311     GraphEvent event = GraphEvent.builder(GraphEventOperation.DELETE)
 312       .edge(new GraphEventEdge(id, version, type, null, null, null)).build();
 313
 314     GraphEvent response = sendAndWait(event);
 315     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 316       logSuccessResponse(event, response);
 317       return "";
 318     } else {
 319       logErrorResponse(event, response);
 320       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 321                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 322     }
 323
 324   }
 325
 326   public String updateEdge(String version, String id, String type, EdgePayload payload)
 327     throws CrudException {
 328     Edge edge = dao.getEdge(id, type, new HashMap<String, String>());
 329     Edge validatedEdge = RelationshipSchemaValidator.validateIncomingUpdatePayload(edge, version,
 330                                                                                    payload);
 331     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
 332       .edge(GraphEventEdge.fromEdge(validatedEdge, version)).build();
 333
 334     GraphEvent response = sendAndWait(event);
 335     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 336       logSuccessResponse(event, response);
 337       return CrudResponseBuilder.buildUpsertEdgeResponse(
 338                                                          RelationshipSchemaValidator.validateOutgoingPayload(version,
 339                                                                                                              response.getEdge().toEdge()), version);
 340     } else {
 341       logErrorResponse(event, response);
 342       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 343                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 344     }
 345
 346   }
 347
 348   public String patchEdge(String version, String id, String type, EdgePayload payload)
 349     throws CrudException {
 350     Edge edge = dao.getEdge(id, type, new HashMap<String, String>());
 351     Edge patchedEdge = RelationshipSchemaValidator.validateIncomingPatchPayload(edge, version,
 352                                                                                 payload);
 353     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
 354       .edge(GraphEventEdge.fromEdge(patchedEdge, version)).build();
 355
 356     GraphEvent response = sendAndWait(event);
 357     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 358       logSuccessResponse(event, response);
 359       return CrudResponseBuilder.buildUpsertEdgeResponse(
 360                                                          RelationshipSchemaValidator.validateOutgoingPayload(version, response.getEdge().toEdge()),
 361                                                          version);
 362     } else {
 363       logErrorResponse(event, response);
 364       throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
 365                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 366     }
 367
 368   }
 369
 370   @PreDestroy
 371   protected void preShutdown() {
 372     timer.cancel();
 373
 374   }
 375
 376   @Override
 377   protected Vertex addBulkVertex(Vertex vertex, String version, String dbTransId) throws CrudException {
 378     GraphEvent event = GraphEvent.builder(GraphEventOperation.CREATE)
 379         .vertex(GraphEventVertex.fromVertex(vertex, version)).build();
 380     event.setDbTransactionId(dbTransId);
 381     GraphEvent response = publishEvent(event);
 382     return response.getVertex().toVertex();
 383   }
 384
 385   @Override
 386   protected Vertex updateBulkVertex(Vertex vertex, String id, String version, String dbTransId) throws CrudException {
 387     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
 388         .vertex(GraphEventVertex.fromVertex(vertex, version)).build();
 389     event.setDbTransactionId(dbTransId);
 390     GraphEvent response = publishEvent(event);
 391     return response.getVertex().toVertex();
 392   }
 393
 394   @Override
 395   protected void deleteBulkVertex(String id, String version, String type, String dbTransId) throws CrudException {
 396     GraphEvent event = GraphEvent.builder(GraphEventOperation.DELETE).vertex(new GraphEventVertex(id, version, type, null)).build();
 397     event.setDbTransactionId(dbTransId);
 398     publishEvent(event);
 399   }
 400
 401   @Override
 402   protected Edge addBulkEdge(Edge edge, String version, String dbTransId) throws CrudException {
 403     GraphEvent event = GraphEvent.builder(GraphEventOperation.CREATE).edge(GraphEventEdge.fromEdge(edge, version)).build();
 404     event.setDbTransactionId(dbTransId);
 405     GraphEvent response = publishEvent(event);
 406     return response.getEdge().toEdge();
 407   }
 408
 409   @Override
 410   protected Edge updateBulkEdge(Edge edge, String version, String dbTransId) throws CrudException {
 411     GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE).edge(GraphEventEdge.fromEdge(edge, version)).build();
 412     event.setDbTransactionId(dbTransId);
 413     GraphEvent response = publishEvent(event);
 414     return response.getEdge().toEdge();
 415   }
 416
 417   @Override
 418   protected void deleteBulkEdge(String id, String version, String type, String dbTransId) throws CrudException {
 419     GraphEvent event = GraphEvent.builder(GraphEventOperation.DELETE)
 420         .edge(new GraphEventEdge(id, version, type, null, null, null)).build();
 421     event.setDbTransactionId(dbTransId);
 422     publishEvent(event);
 423   }
 424
 425   private GraphEvent publishEvent(GraphEvent event) throws CrudException {
 426     GraphEvent response = sendAndWait(event);
 427     if (response.getResult().equals(GraphEventResult.SUCCESS)) {
 428       logSuccessResponse(event, response);
 429     } else {
 430       logErrorResponse(event, response);
 431       throw new CrudException("Operation failed with transaction-id: " + response.getTransactionId()
 432                               + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
 433     }
 434
 435     return response;
 436   }
 437
 438   private void logSuccessResponse(GraphEvent event, GraphEvent response) {
 439     logger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO,
 440         "Event response received: " + response.getObjectType() + " with key: "
 441         + response.getObjectKey() + " , transaction-id: " + response.getTransactionId()
 442         + " , operation: " + event.getOperation().toString() + " , result: "
 443         + response.getResult());
 444   }
 445
 446   private void logErrorResponse(GraphEvent event, GraphEvent response) {
 447     logger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO,
 448         "Event response received: " + response.getObjectType() + " with key: "
 449         + response.getObjectKey() + " , transaction-id: " + response.getTransactionId()
 450         + " , operation: " + event.getOperation().toString() + " , result: "
 451         + response.getResult() + " , error: " + response.getErrorMessage());
 452   }
 453 }