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 MSG_REQUEST_BODY = "Request Body: ";
47 private static final String REQUEST_HEADER_RESOURCE_VERSION = "If-Match";
48 private static final String RESPONSE_HEADER_RESOURCE_VERSION = "ETag";
49 private static final String REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION = "X-CreateIndex";
51 protected SearchServiceApi searchService = null;
53 private Logger logger = LoggerFactory.getInstance().getLogger(DocumentApi.class.getName());
54 private Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(DocumentApi.class.getName());
56 public DocumentApi(SearchServiceApi searchService) {
57 this.searchService = searchService;
60 public ResponseEntity<String> processPost(String content, HttpServletRequest request, HttpHeaders headers,
61 HttpServletResponse httpResponse, String index, DocumentStoreInterface documentStore) {
63 // Initialize the MDC Context for logging purposes.
64 ApiUtils.initMdcContext(request, headers);
67 ObjectMapper mapper = new ObjectMapper();
68 mapper.setSerializationInclusion(Include.NON_EMPTY);
69 if (content == null) {
70 return handleError(request, content, HttpStatus.BAD_REQUEST);
75 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
76 ApiUtils.SEARCH_AUTH_POLICY_NAME);
77 } catch (Exception e) {
78 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processPost", e.getMessage());
79 return handleError(request, content, HttpStatus.FORBIDDEN);
83 return handleError(request, content, HttpStatus.FORBIDDEN);
86 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
87 document.setContent(content);
89 DocumentOperationResult result =
90 documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
92 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
93 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
95 output = result.getError() != null
96 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
97 : result.getFailureCause();
100 if (httpResponse != null) {
101 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
103 ResponseEntity<String> response =
104 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
105 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
106 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
108 // Clear the MDC context so that no other transaction inadvertently
109 // uses our transaction id.
110 ApiUtils.clearMdcContext();
113 } catch (Exception e) {
114 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
118 public ResponseEntity<String> processPut(String content, HttpServletRequest request, HttpHeaders headers,
119 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
121 // Initialize the MDC Context for logging purposes.
122 ApiUtils.initMdcContext(request, headers);
125 ObjectMapper mapper = new ObjectMapper();
126 mapper.setSerializationInclusion(Include.NON_EMPTY);
127 if (content == null) {
128 return handleError(request, content, HttpStatus.BAD_REQUEST);
133 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.PUT,
134 ApiUtils.SEARCH_AUTH_POLICY_NAME);
135 } catch (Exception e) {
136 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processPut", e.getMessage());
137 return handleError(request, content, HttpStatus.FORBIDDEN);
141 return handleError(request, content, HttpStatus.FORBIDDEN);
144 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
146 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
148 document.setContent(content);
149 document.setVersion(resourceVersion);
151 DocumentOperationResult result = null;
152 if (resourceVersion == null) {
153 result = documentStore.createDocument(index, document, implicitlyCreateIndex(headers));
155 result = documentStore.updateDocument(index, document, implicitlyCreateIndex(headers));
158 String output = null;
159 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
160 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
162 output = result.getError() != null
163 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
164 : result.getFailureCause();
166 if (httpResponse != null) {
167 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
169 ResponseEntity<String> response =
170 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
171 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
173 // Clear the MDC context so that no other transaction inadvertently
174 // uses our transaction id.
175 ApiUtils.clearMdcContext();
178 } catch (Exception e) {
179 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
183 public ResponseEntity<String> processDelete(String content, HttpServletRequest request, HttpHeaders headers,
184 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
186 // Initialize the MDC Context for logging purposes.
187 ApiUtils.initMdcContext(request, headers);
190 ObjectMapper mapper = new ObjectMapper();
191 mapper.setSerializationInclusion(Include.NON_EMPTY);
194 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.DELETE,
195 ApiUtils.SEARCH_AUTH_POLICY_NAME);
196 } catch (Exception e) {
197 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processDelete", e.getMessage());
198 return handleError(request, content, HttpStatus.FORBIDDEN);
202 return handleError(request, content, HttpStatus.FORBIDDEN);
205 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
206 if (resourceVersion == null || resourceVersion.isEmpty()) {
207 return handleError(request, "Request header 'If-Match' missing", HttpStatus.BAD_REQUEST);
210 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
212 document.setVersion(resourceVersion);
214 DocumentOperationResult result = documentStore.deleteDocument(index, document);
215 String output = null;
216 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
217 output = result.getError() != null
218 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
219 : result.getFailureCause();
222 if (httpResponse != null) {
223 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
225 ResponseEntity<String> response;
226 if (output == null) {
227 response = ResponseEntity.status(result.getResultCode()).build();
229 response = ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON)
233 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
235 // Clear the MDC context so that no other transaction inadvertently
236 // uses our transaction id.
237 ApiUtils.clearMdcContext();
240 } catch (Exception e) {
241 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
245 public ResponseEntity<String> processGet(String content, HttpServletRequest request, HttpHeaders headers,
246 HttpServletResponse httpResponse, String index, String id, DocumentStoreInterface documentStore) {
248 // Initialize the MDC Context for logging purposes.
249 ApiUtils.initMdcContext(request, headers);
252 ObjectMapper mapper = new ObjectMapper();
253 mapper.setSerializationInclusion(Include.NON_EMPTY);
256 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.GET,
257 ApiUtils.SEARCH_AUTH_POLICY_NAME);
258 } catch (Exception e) {
259 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "DocumentApi.processGet", e.getMessage());
260 return handleError(request, content, HttpStatus.FORBIDDEN);
264 return handleError(request, content, HttpStatus.FORBIDDEN);
267 String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
269 DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
271 document.setVersion(resourceVersion);
273 DocumentOperationResult result = documentStore.getDocument(index, document);
274 String output = null;
275 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
276 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getDocument());
278 output = result.getError() != null
279 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
280 : result.getFailureCause();
282 if (httpResponse != null) {
283 httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
285 ResponseEntity<String> response =
286 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
287 logResult(request, HttpStatus.valueOf(response.getStatusCodeValue()));
289 // Clear the MDC context so that no other transaction inadvertently
290 // uses our transaction id.
291 ApiUtils.clearMdcContext();
294 } catch (Exception e) {
295 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
299 public ResponseEntity<String> processSearchWithGet(String content, HttpServletRequest request, HttpHeaders headers,
300 String index, String queryText, DocumentStoreInterface documentStore) {
302 // Initialize the MDC Context for logging purposes.
303 ApiUtils.initMdcContext(request, headers);
306 ObjectMapper mapper = new ObjectMapper();
307 mapper.setSerializationInclusion(Include.NON_EMPTY);
311 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.GET,
312 ApiUtils.SEARCH_AUTH_POLICY_NAME);
313 } catch (Exception e) {
314 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processSearchWithGet", e.getMessage());
315 return handleError(request, content, HttpStatus.FORBIDDEN);
319 return handleError(request, content, HttpStatus.FORBIDDEN);
322 SearchOperationResult result = documentStore.search(index, queryText);
323 String output = null;
324 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
325 output = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSearchResult());
327 output = result.getError() != null
328 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
329 : result.getFailureCause();
331 ResponseEntity<String> response =
332 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
334 // Clear the MDC context so that no other transaction inadvertently
335 // uses our transaction id.
336 ApiUtils.clearMdcContext();
339 } catch (Exception e) {
340 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
344 public ResponseEntity<String> queryWithGetWithPayload(String content, HttpServletRequest request,
345 HttpHeaders headers, String index, DocumentStoreInterface documentStore) {
347 // Initialize the MDC Context for logging purposes.
348 ApiUtils.initMdcContext(request, headers);
350 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "GET",
351 (request != null) ? request.getRequestURL().toString() : "");
352 if (logger.isDebugEnabled()) {
353 logger.debug(MSG_REQUEST_BODY + content);
355 return processQuery(index, content, request, headers, documentStore);
358 public ResponseEntity<String> processSearchWithPost(String content, HttpServletRequest request, HttpHeaders headers,
359 String index, DocumentStoreInterface documentStore) {
361 // Initialize the MDC Context for logging purposes.
362 ApiUtils.initMdcContext(request, headers);
364 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST",
365 (request != null) ? request.getRequestURL().toString() : "");
366 if (logger.isDebugEnabled()) {
367 logger.debug(MSG_REQUEST_BODY + content);
370 return processQuery(index, content, request, headers, documentStore);
374 public ResponseEntity<String> processSuggestQueryWithPost(String content, HttpServletRequest request,
375 HttpHeaders headers, String index, DocumentStoreInterface documentStore) {
377 // Initialize the MDC Context for logging purposes.
378 ApiUtils.initMdcContext(request, headers);
380 logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST",
381 (request != null) ? request.getRequestURL().toString() : "");
382 if (logger.isDebugEnabled()) {
383 logger.debug(MSG_REQUEST_BODY + content);
386 return processSuggestQuery(index, content, request, headers, documentStore);
390 * Common handler for query requests. This is called by both the GET with payload and POST with payload variants of
391 * the query endpoint.
393 * @param index - The index to be queried against.
394 * @param content - The payload containing the query structure.
395 * @param request - The HTTP request.
396 * @param headers - The HTTP headers.
397 * @return - A standard HTTP response.
399 private ResponseEntity<String> processQuery(String index, String content, HttpServletRequest request,
400 HttpHeaders headers, DocumentStoreInterface documentStore) {
403 ObjectMapper mapper = new ObjectMapper();
404 mapper.setSerializationInclusion(Include.NON_EMPTY);
406 // Make sure that we were supplied a payload before proceeding.
407 if (content == null) {
408 return handleError(request, content, HttpStatus.BAD_REQUEST);
411 // Validate that the request has the appropriate authorization.
414 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
415 ApiUtils.SEARCH_AUTH_POLICY_NAME);
417 } catch (Exception e) {
418 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processQuery", e.getMessage());
419 return handleError(request, content, HttpStatus.FORBIDDEN);
423 return handleError(request, content, HttpStatus.FORBIDDEN);
426 SearchStatement searchStatement;
429 // Marshall the supplied request payload into a search statement
431 searchStatement = mapper.readValue(content, SearchStatement.class);
433 } catch (Exception e) {
434 return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
437 // Now, submit the search statement, translated into
438 // ElasticSearch syntax, to the document store DAO.
439 SearchOperationResult result = documentStore.searchWithPayload(index, searchStatement.toElasticSearch());
440 String output = null;
441 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
442 output = prepareOutput(mapper, result);
444 output = result.getError() != null
445 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
446 : result.getFailureCause();
448 ResponseEntity<String> response =
449 ResponseEntity.status(result.getResultCode()).contentType(MediaType.APPLICATION_JSON).body(output);
451 // Clear the MDC context so that no other transaction inadvertently
452 // uses our transaction id.
453 ApiUtils.clearMdcContext();
457 } catch (Exception e) {
458 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
464 * Common handler for query requests. This is called by both the GET with payload and POST with payload variants of
465 * the query endpoint.
467 * @param index - The index to be queried against.
468 * @param content - The payload containing the query structure.
469 * @param request - The HTTP request.
470 * @param headers - The HTTP headers.
471 * @return - A standard HTTP response.
473 private ResponseEntity<String> processSuggestQuery(String index, String content, HttpServletRequest request,
474 HttpHeaders headers, DocumentStoreInterface documentStore) {
477 ObjectMapper mapper = new ObjectMapper();
478 mapper.setSerializationInclusion(Include.NON_EMPTY);
480 // Make sure that we were supplied a payload before proceeding.
481 if (content == null) {
482 return handleError(request, content, HttpStatus.BAD_REQUEST);
485 // Validate that the request has the appropriate authorization.
488 isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
489 ApiUtils.SEARCH_AUTH_POLICY_NAME);
491 } catch (Exception e) {
492 logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processQuery", e.getMessage());
493 return handleError(request, content, HttpStatus.FORBIDDEN);
497 return handleError(request, content, HttpStatus.FORBIDDEN);
500 SuggestionStatement suggestionStatement;
503 // Marshall the supplied request payload into a search statement
505 suggestionStatement = mapper.readValue(content, SuggestionStatement.class);
507 } catch (Exception e) {
508 return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
511 // Now, submit the search statement, translated into
512 // ElasticSearch syntax, to the document store DAO.
513 SearchOperationResult result =
514 documentStore.suggestionQueryWithPayload(index, suggestionStatement.toElasticSearch());
515 String output = null;
516 if (ApiUtils.isSuccessStatusCode(result.getResultCode())) {
517 output = prepareSuggestOutput(mapper, result);
519 output = result.getError() != null
520 ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
521 : result.getFailureCause();
523 ResponseEntity<String> response = ResponseEntity.status(result.getResultCode()).body(output);
525 // Clear the MDC context so that no other transaction inadvertently
526 // uses our transaction id.
527 ApiUtils.clearMdcContext();
531 } catch (Exception e) {
532 return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
537 * Checks the supplied HTTP headers to see if we should allow the underlying document store to implicitly create the
538 * index referenced in a document PUT or POST if it does not already exist in the data store.
540 * @param headers - The HTTP headers to examine.
542 * @return - true if the headers indicate that missing indices should be implicitly created, false otherwise.
544 private boolean implicitlyCreateIndex(HttpHeaders headers) {
545 String implicitIndexCreationHeader = headers.getFirst(REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION);
546 return implicitIndexCreationHeader != null && "true".equals(implicitIndexCreationHeader);
549 private String prepareOutput(ObjectMapper mapper, SearchOperationResult result) throws JsonProcessingException {
550 StringBuffer output = new StringBuffer();
551 output.append("{\r\n\"searchResult\":");
552 output.append(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSearchResult()));
553 AggregationResults aggs = result.getAggregationResult();
555 output.append(",\r\n\"aggregationResult\":");
556 output.append(mapper.setSerializationInclusion(Include.NON_NULL).writerWithDefaultPrettyPrinter()
557 .writeValueAsString(aggs));
559 output.append("\r\n}");
560 return output.toString();
563 private String prepareSuggestOutput(ObjectMapper mapper, SearchOperationResult result)
564 throws JsonProcessingException {
565 StringBuffer output = new StringBuffer();
566 output.append("{\r\n\"searchResult\":");
567 output.append(mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSuggestResult()));
568 AggregationResults aggs = result.getAggregationResult();
570 output.append(",\r\n\"aggregationResult\":");
571 output.append(mapper.setSerializationInclusion(Include.NON_NULL).writerWithDefaultPrettyPrinter()
572 .writeValueAsString(aggs));
574 output.append("\r\n}");
575 return output.toString();
578 private ResponseEntity<String> handleError(HttpServletRequest request, String message, HttpStatus status) {
579 logResult(request, status);
580 return ResponseEntity.status(status).contentType(MediaType.APPLICATION_JSON).body(message);
583 void logResult(HttpServletRequest request, HttpStatus status) {
585 logger.info(SearchDbMsgs.PROCESS_REST_REQUEST, (request != null) ? request.getMethod() : "",
586 (request != null) ? request.getRequestURL().toString() : "",
587 (request != null) ? request.getRemoteHost() : "", Integer.toString(status.value()));
589 auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
590 new LogFields().setField(LogLine.DefinedFields.RESPONSE_CODE, status.value())
591 .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, status.getReasonPhrase()),
592 (request != null) ? request.getMethod() : "",
593 (request != null) ? request.getRequestURL().toString() : "",
594 (request != null) ? request.getRemoteHost() : "", Integer.toString(status.value()));
596 // Clear the MDC context so that no other transaction inadvertently uses our transaction id.
597 ApiUtils.clearMdcContext();