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.aai.sa.rest;
23 import com.fasterxml.jackson.annotation.JsonInclude.Include;
24 import com.fasterxml.jackson.core.JsonProcessingException;
25 import com.fasterxml.jackson.databind.ObjectMapper;
26 import javax.servlet.http.HttpServletRequest;
27 import javax.servlet.http.HttpServletResponse;
28 import org.onap.aai.cl.api.LogFields;
29 import org.onap.aai.cl.api.LogLine;
30 import org.onap.aai.cl.api.Logger;
31 import org.onap.aai.cl.eelf.LoggerFactory;
32 import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.DocumentStoreDataEntityImpl;
33 import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.DocumentStoreInterface;
34 import org.onap.aai.sa.searchdbabstraction.entity.AggregationResults;
35 import org.onap.aai.sa.searchdbabstraction.entity.DocumentOperationResult;
36 import org.onap.aai.sa.searchdbabstraction.entity.SearchOperationResult;
37 import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
38 import org.onap.aai.sa.searchdbabstraction.searchapi.SearchStatement;
39 import org.onap.aai.sa.searchdbabstraction.searchapi.SuggestionStatement;
40 import org.springframework.http.HttpHeaders;
41 import org.springframework.http.HttpStatus;
42 import org.springframework.http.MediaType;
43 import org.springframework.http.ResponseEntity;
45 public class DocumentApi {
46 private static final String REQUEST_HEADER_RESOURCE_VERSION = "If-Match";
47 private static final String RESPONSE_HEADER_RESOURCE_VERSION = "ETag";
48 private static final String REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION = "X-CreateIndex";
50 protected SearchServiceApi searchService = null;
52 private Logger logger = LoggerFactory.getInstance().getLogger(DocumentApi.class.getName());
53 private Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(DocumentApi.class.getName());
55 public DocumentApi(SearchServiceApi searchService) {
56 this.searchService = searchService;
59 public ResponseEntity<String> processPost(String content, HttpServletRequest request, HttpHeaders headers,
60 HttpServletResponse httpResponse, String index, DocumentStoreInterface documentStore) {
62 // Initialize the MDC Context for logging purposes.
63 ApiUtils.initMdcContext(request, headers);
66 ObjectMapper mapper = new ObjectMapper();
67 mapper.setSerializationInclusion(Include.NON_EMPTY);
68 if (content == null) {
69 return handleError(request, content, HttpStatus.BAD_REQUEST);
74 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
75 ApiUtils.SEARCH_AUTH_POLICY_NAME);
76 } catch (Exception e) {
77 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processPost", e.getMessage());
78 return handleError(request, content, HttpStatus.FORBIDDEN);
82 return handleError(request, content, HttpStatus.FORBIDDEN);
85 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
86 document.setContent(content);
88 DocumentOperationResult result =
89 documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
91 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
92 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
94 output = result.getError() != null
95 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
96 : result.getFailureCause();
99 if (httpResponse != null) {
100 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
102 ResponseEntity response =
103 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
104 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
105 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
107 // Clear the MDC context so that no other transaction inadvertently
108 // uses our transaction id.
109 ApiUtils.clearMdcContext();
112 } catch (Exception e) {
113 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
117 public ResponseEntity<String> processPut(String content, HttpServletRequest request, HttpHeaders headers,
118 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
120 // Initialize the MDC Context for logging purposes.
121 ApiUtils.initMdcContext(request, headers);
124 ObjectMapper mapper = new ObjectMapper();
125 mapper.setSerializationInclusion(Include.NON_EMPTY);
126 if (content == null) {
127 return handleError(request, content, HttpStatus.BAD_REQUEST);
132 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.PUT,
133 ApiUtils.SEARCH_AUTH_POLICY_NAME);
134 } catch (Exception e) {
135 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processPut", e.getMessage());
136 return handleError(request, content, HttpStatus.FORBIDDEN);
140 return handleError(request, content, HttpStatus.FORBIDDEN);
143 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
145 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
147 document.setContent(content);
148 document.setVersion(resourceVersion);
150 DocumentOperationResult result = null;
151 if (resourceVersion == null) {
152 result = documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
154 result = documentStore.updateDocument(index, document, implicitlyCreateIndex(headers));
157 String output = null;
158 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
159 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
161 output = result.getError() != null
162 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
163 : result.getFailureCause();
165 if (httpResponse != null) {
166 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
168 ResponseEntity response =
169 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
170 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
172 // Clear the MDC context so that no other transaction inadvertently
173 // uses our transaction id.
174 ApiUtils.clearMdcContext();
177 } catch (Exception e) {
178 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
182 public ResponseEntity<String> processDelete(String content, HttpServletRequest request, HttpHeaders headers,
183 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
185 // Initialize the MDC Context for logging purposes.
186 ApiUtils.initMdcContext(request, headers);
189 ObjectMapper mapper = new ObjectMapper();
190 mapper.setSerializationInclusion(Include.NON_EMPTY);
193 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.DELETE,
194 ApiUtils.SEARCH_AUTH_POLICY_NAME);
195 } catch (Exception e) {
196 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processDelete", e.getMessage());
197 return handleError(request, content, HttpStatus.FORBIDDEN);
201 return handleError(request, content, HttpStatus.FORBIDDEN);
204 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
205 if (resourceVersion == null || resourceVersion.isEmpty()) {
206 return handleError(request, "Request header 'If-Match' missing", HttpStatus.BAD_REQUEST);
209 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
211 document.setVersion(resourceVersion);
213 DocumentOperationResult result = documentStore.deleteDocument(index, document);
214 String output = null;
215 if (!(result.getResultCode() >= 200 && result.getResultCode() <= 299)) { //
216 output = result.getError() != null
217 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
218 : result.getFailureCause();
221 if (httpResponse != null) {
222 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
224 ResponseEntity response;
225 if (output == null) {
226 response = ResponseEntity.status(result.getResultCode()).build();
228 response = ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON)
232 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
234 // Clear the MDC context so that no other transaction inadvertently
235 // uses our transaction id.
236 ApiUtils.clearMdcContext();
239 } catch (Exception e) {
240 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
244 public ResponseEntity<String> processGet(String content, HttpServletRequest request, HttpHeaders headers,
245 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
247 // Initialize the MDC Context for logging purposes.
248 ApiUtils.initMdcContext(request, headers);
251 ObjectMapper mapper = new ObjectMapper();
252 mapper.setSerializationInclusion(Include.NON_EMPTY);
255 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.GET,
256 ApiUtils.SEARCH_AUTH_POLICY_NAME);
257 } catch (Exception e) {
258 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processGet", e.getMessage());
259 return handleError(request, content, HttpStatus.FORBIDDEN);
263 return handleError(request, content, HttpStatus.FORBIDDEN);
266 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
268 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
270 document.setVersion(resourceVersion);
272 DocumentOperationResult result = documentStore.getDocument(index, document);
273 String output = null;
274 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
275 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
277 output = result.getError() != null
278 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
279 : result.getFailureCause();
281 if (httpResponse != null) {
282 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
284 ResponseEntity response =
285 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
286 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
288 // Clear the MDC context so that no other transaction inadvertently
289 // uses our transaction id.
290 ApiUtils.clearMdcContext();
293 } catch (Exception e) {
294 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
298 public ResponseEntity<String> processSearchWithGet(String content, HttpServletRequest request, HttpHeaders headers,
299 String index, String queryText, DocumentStoreInterface documentStore) {
301 // Initialize the MDC Context for logging purposes.
302 ApiUtils.initMdcContext(request, headers);
305 ObjectMapper mapper = new ObjectMapper();
306 mapper.setSerializationInclusion(Include.NON_EMPTY);
310 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.GET,
311 ApiUtils.SEARCH_AUTH_POLICY_NAME);
312 } catch (Exception e) {
313 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processSearchWithGet", e.getMessage());
314 return handleError(request, content, HttpStatus.FORBIDDEN);
318 return handleError(request, content, HttpStatus.FORBIDDEN);
321 SearchOperationResult result = documentStore.search(index, queryText);
322 String output = null;
323 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
324 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSearchResult());
326 output = result.getError() != null
327 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
328 : result.getFailureCause();
330 ResponseEntity response =
331 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
333 // Clear the MDC context so that no other transaction inadvertently
334 // uses our transaction id.
335 ApiUtils.clearMdcContext();
338 } catch (Exception e) {
339 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
343 public ResponseEntity<String> queryWithGetWithPayload(String content, HttpServletRequest request,
344 HttpHeaders headers, String index, DocumentStoreInterface documentStore) {
346 // Initialize the MDC Context for logging purposes.
347 ApiUtils.initMdcContext(request, headers);
349 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "GET",
350 (request != null) ? request.getRequestURL().toString() : "");
351 if (logger.isDebugEnabled()) {
352 logger.debug("Request Body: " + content);
354 return processQuery(index, content, request, headers, documentStore);
357 public ResponseEntity<String> processSearchWithPost(String content, HttpServletRequest request, HttpHeaders headers,
358 String index, DocumentStoreInterface documentStore) {
360 // Initialize the MDC Context for logging purposes.
361 ApiUtils.initMdcContext(request, headers);
363 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST",
364 (request != null) ? request.getRequestURL().toString() : "");
365 if (logger.isDebugEnabled()) {
366 logger.debug("Request Body: " + content);
369 return processQuery(index, content, request, headers, documentStore);
373 public ResponseEntity<String> processSuggestQueryWithPost(String content, HttpServletRequest request,
374 HttpHeaders headers, String index, DocumentStoreInterface documentStore) {
376 // Initialize the MDC Context for logging purposes.
377 ApiUtils.initMdcContext(request, headers);
379 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST",
380 (request != null) ? request.getRequestURL().toString() : "");
381 if (logger.isDebugEnabled()) {
382 logger.debug("Request Body: " + content);
385 return processSuggestQuery(index, content, request, headers, documentStore);
389 * Common handler for query requests. This is called by both the GET with payload and POST with payload variants of
390 * the query endpoint.
392 * @param index - The index to be queried against.
393 * @param content - The payload containing the query structure.
394 * @param request - The HTTP request.
395 * @param headers - The HTTP headers.
396 * @return - A standard HTTP response.
398 private ResponseEntity processQuery(String index, String content, HttpServletRequest request, HttpHeaders headers,
399 DocumentStoreInterface documentStore) {
402 ObjectMapper mapper = new ObjectMapper();
403 mapper.setSerializationInclusion(Include.NON_EMPTY);
405 // Make sure that we were supplied a payload before proceeding.
406 if (content == null) {
407 return handleError(request, content, HttpStatus.BAD_REQUEST);
410 // Validate that the request has the appropriate authorization.
413 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
414 ApiUtils.SEARCH_AUTH_POLICY_NAME);
416 } catch (Exception e) {
417 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processQuery", e.getMessage());
418 return handleError(request, content, HttpStatus.FORBIDDEN);
422 return handleError(request, content, HttpStatus.FORBIDDEN);
425 SearchStatement searchStatement;
428 // Marshall the supplied request payload into a search statement
430 searchStatement = mapper.readValue(content, SearchStatement.class);
432 } catch (Exception e) {
433 return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
436 // Now, submit the search statement, translated into
437 // ElasticSearch syntax, to the document store DAO.
438 SearchOperationResult result = documentStore.searchWithPayload(index, searchStatement.toElasticSearch());
439 String output = null;
440 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
441 output = prepareOutput(mapper, result);
443 output = result.getError() != null
444 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
445 : result.getFailureCause();
447 ResponseEntity response =
448 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
450 // Clear the MDC context so that no other transaction inadvertently
451 // uses our transaction id.
452 ApiUtils.clearMdcContext();
456 } catch (Exception e) {
457 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
463 * Common handler for query requests. This is called by both the GET with payload and POST with payload variants of
464 * the query endpoint.
466 * @param index - The index to be queried against.
467 * @param content - The payload containing the query structure.
468 * @param request - The HTTP request.
469 * @param headers - The HTTP headers.
470 * @return - A standard HTTP response.
472 private ResponseEntity<String> processSuggestQuery(String index, String content, HttpServletRequest request,
473 HttpHeaders headers, DocumentStoreInterface documentStore) {
476 ObjectMapper mapper = new ObjectMapper();
477 mapper.setSerializationInclusion(Include.NON_EMPTY);
479 // Make sure that we were supplied a payload before proceeding.
480 if (content == null) {
481 return handleError(request, content, HttpStatus.BAD_REQUEST);
484 // Validate that the request has the appropriate authorization.
487 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
488 ApiUtils.SEARCH_AUTH_POLICY_NAME);
490 } catch (Exception e) {
491 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processQuery", e.getMessage());
492 return handleError(request, content, HttpStatus.FORBIDDEN);
496 return handleError(request, content, HttpStatus.FORBIDDEN);
499 SuggestionStatement suggestionStatement;
502 // Marshall the supplied request payload into a search statement
504 suggestionStatement = mapper.readValue(content, SuggestionStatement.class);
506 } catch (Exception e) {
507 return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
510 // Now, submit the search statement, translated into
511 // ElasticSearch syntax, to the document store DAO.
512 SearchOperationResult result =
513 documentStore.suggestionQueryWithPayload(index, suggestionStatement.toElasticSearch());
514 String output = null;
515 if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
516 output = prepareSuggestOutput(mapper, result);
518 output = result.getError() != null
519 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
520 : result.getFailureCause();
522 ResponseEntity<String> response = ResponseEntity.status(result.getResultCode()).body(output);
524 // Clear the MDC context so that no other transaction inadvertently
525 // uses our transaction id.
526 ApiUtils.clearMdcContext();
530 } catch (Exception e) {
531 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
536 * Checks the supplied HTTP headers to see if we should allow the underlying document store to implicitly create the
537 * index referenced in a document PUT or POST if it does not already exist in the data store.
539 * @param headers - The HTTP headers to examine.
541 * @return - true if the headers indicate that missing indices should be implicitly created, false otherwise.
543 private boolean implicitlyCreateIndex(HttpHeaders headers) {
545 boolean createIndexIfNotPresent = false;
546 String implicitIndexCreationHeader = headers.getFirst(REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION);
548 if ((implicitIndexCreationHeader != null) && (implicitIndexCreationHeader.equals("true"))) {
549 createIndexIfNotPresent = true;
552 return createIndexIfNotPresent;
555 private String prepareOutput(ObjectMapper mapper, SearchOperationResult result) throws JsonProcessingException {
556 StringBuffer output = new StringBuffer();
557 output.append("{\r\n\"searchResult\":");
558 output.append(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSearchResult()));
559 AggregationResults aggs = result.getAggregationResult();
561 output.append(",\r\n\"aggregationResult\":");
562 output.append(mapper.setSerializationInclusion(Include.NON_NULL).writerWithDefaultPrettyPrinter()
563 .writeValueAsString(aggs));
565 output.append("\r\n}");
566 return output.toString();
569 private String prepareSuggestOutput(ObjectMapper mapper, SearchOperationResult result)
570 throws JsonProcessingException {
571 StringBuffer output = new StringBuffer();
572 output.append("{\r\n\"searchResult\":");
573 output.append(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSuggestResult()));
574 AggregationResults aggs = result.getAggregationResult();
576 output.append(",\r\n\"aggregationResult\":");
577 output.append(mapper.setSerializationInclusion(Include.NON_NULL).writerWithDefaultPrettyPrinter()
578 .writeValueAsString(aggs));
580 output.append("\r\n}");
581 return output.toString();
584 private ResponseEntity handleError(HttpServletRequest request, String message, HttpStatus status) {
585 logResult(request, status);
586 return ResponseEntity.status(status).contentType(MediaType.APPLICATION_JSON).body(message);
589 void logResult(HttpServletRequest request, HttpStatus status) {
591 logger.info(SearchDbMsgs.PROCESS_REST_REQUEST, (request != null) ? request.getMethod().toString() : "",
592 (request != null) ? request.getRequestURL().toString() : "",
593 (request != null) ? request.getRemoteHost() : "", Integer.toString(status.value()));
595 auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
596 new LogFields().setField(LogLine.DefinedFields.RESPONSE_CODE, status.value())
597 .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, status.getReasonPhrase()),
598 (request != null) ? request.getMethod().toString() : "",
599 (request != null) ? request.getRequestURL().toString() : "",
600 (request != null) ? request.getRemoteHost() : "", Integer.toString(status.value()));
602 // Clear the MDC context so that no other transaction inadvertently
603 // uses our transaction id.
604 ApiUtils.clearMdcContext();