2 * ============LICENSE_START=======================================================
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.crud.service;
23 import org.onap.aai.event.api.EventConsumer;
24 import org.onap.aai.event.api.EventPublisher;
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;
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;
61 public class CrudAsyncGraphDataService extends AbstractGraphDataService {
63 private static Integer requestTimeOut;
65 private EventPublisher asyncRequestPublisher;
69 public static final Integer DEFAULT_REQUEST_TIMEOUT = 30000;
70 private static final Integer DEFAULT_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL = 1000;
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();
79 OK_FIELDS.setField(Status.OK, Status.OK.toString());
82 public static Integer getRequestTimeOut() {
83 return requestTimeOut;
86 public CrudAsyncGraphDataService(GraphDao dao,
87 EventPublisher asyncRequestPublisher,
88 EventConsumer asyncResponseConsumer) throws CrudException {
89 this(dao,dao,asyncRequestPublisher,asyncResponseConsumer);
92 public CrudAsyncGraphDataService(GraphDao dao,
94 EventPublisher asyncRequestPublisher,
95 EventConsumer asyncResponseConsumer) throws CrudException {
99 this.daoForGet = daoForGet;
101 requestTimeOut = DEFAULT_REQUEST_TIMEOUT;
104 = Integer.parseInt(CrudProperties.get(CrudServiceConstants.CRD_ASYNC_REQUEST_TIMEOUT));
105 } catch (NumberFormatException ex) {
106 // Leave it as the default
109 Integer responsePollInterval = DEFAULT_ASYNC_RESPONSE_PROCESS_POLL_INTERVAL;
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());
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);
126 this.asyncRequestPublisher = asyncRequestPublisher;
128 logger.info(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO,
129 "CrudAsyncGraphDataService initialized SUCCESSFULLY!");
132 public class CollectGraphResponse implements Callable<GraphEvent> {
133 private volatile GraphEvent graphEvent;
134 private volatile CountDownLatch latch = new CountDownLatch(1);
137 public GraphEvent call() throws TimeoutException {
139 // Wait until graphEvent is available
140 latch.await(CrudAsyncGraphDataService.getRequestTimeOut(), TimeUnit.MILLISECONDS);
141 } catch (InterruptedException e) {
143 if (this.graphEvent != null) {
144 return this.graphEvent;
146 throw new TimeoutException();
149 return this.graphEvent;
152 public void populateGraphEvent(GraphEvent event) {
153 this.graphEvent = event;
158 private GraphEvent sendAndWait(GraphEvent event) throws CrudException {
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));
165 // publish to request queue
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);
172 logger.debug(CrudServiceMsgs.ASYNC_DATA_SERVICE_INFO, "Event Sent ="+event.toJson());
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());
179 ExecutorService executor = Executors
180 .newSingleThreadExecutor(new CrudThreadFactory("TX-" + event.getTransactionId()));
181 CollectGraphResponse collector = new CollectGraphResponse();
182 CrudAsyncGraphEventCache.put(event.getTransactionId(), collector);
184 Future<GraphEvent> future = executor.submit(collector);
186 response = future.get(requestTimeOut, TimeUnit.MILLISECONDS);
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());
193 throw new CrudException("Timed out , transactionId: " + event.getTransactionId()
194 + " , operation: " + event.getOperation().toString(), Status.INTERNAL_SERVER_ERROR);
196 //Kill the thread as the work is completed
197 executor.shutdownNow();
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");
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();
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);
221 logErrorResponse(event, response);
222 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
223 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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();
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()),
241 logErrorResponse(event, response);
242 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
243 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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();
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()),
261 logErrorResponse(event, response);
262 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
263 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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(),
275 GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
276 .vertex(GraphEventVertex.fromVertex(patchedVertex, version)).build();
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()),
285 logErrorResponse(event, response);
286 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
287 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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();
297 GraphEvent response = sendAndWait(event);
298 if (response.getResult().equals(GraphEventResult.SUCCESS)) {
299 logSuccessResponse(event, response);
302 logErrorResponse(event, response);
303 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
304 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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();
314 GraphEvent response = sendAndWait(event);
315 if (response.getResult().equals(GraphEventResult.SUCCESS)) {
316 logSuccessResponse(event, response);
319 logErrorResponse(event, response);
320 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
321 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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,
331 GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
332 .edge(GraphEventEdge.fromEdge(validatedEdge, version)).build();
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);
341 logErrorResponse(event, response);
342 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
343 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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,
353 GraphEvent event = GraphEvent.builder(GraphEventOperation.UPDATE)
354 .edge(GraphEventEdge.fromEdge(patchedEdge, version)).build();
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()),
363 logErrorResponse(event, response);
364 throw new CrudException("Operation Failed with transaction-id: " + response.getTransactionId()
365 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
371 protected void preShutdown() {
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();
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();
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);
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();
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();
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);
425 private GraphEvent publishEvent(GraphEvent event) throws CrudException {
426 GraphEvent response = sendAndWait(event);
427 if (response.getResult().equals(GraphEventResult.SUCCESS)) {
428 logSuccessResponse(event, response);
430 logErrorResponse(event, response);
431 throw new CrudException("Operation failed with transaction-id: " + response.getTransactionId()
432 + " Error: " + response.getErrorMessage(), response.getHttpErrorStatus());
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());
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());