+++ /dev/null
-/**
- * ============LICENSE_START=======================================================
- * org.onap.aai
- * ================================================================================
- * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2017-2018 Amdocs
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-package org.onap.aai.sa.rest;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.github.fge.jsonschema.main.JsonSchema;
-import com.github.fge.jsonschema.main.JsonSchemaFactory;
-import java.io.IOException;
-import java.util.concurrent.atomic.AtomicBoolean;
-import javax.servlet.http.HttpServletRequest;
-import org.onap.aai.cl.api.LogFields;
-import org.onap.aai.cl.api.LogLine;
-import org.onap.aai.cl.api.Logger;
-import org.onap.aai.cl.eelf.LoggerFactory;
-import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.DocumentStoreInterface;
-import org.onap.aai.sa.searchdbabstraction.elasticsearch.exception.DocumentStoreOperationException;
-import org.onap.aai.sa.searchdbabstraction.entity.OperationResult;
-import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
-import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
-import org.springframework.http.ResponseEntity;
-
-/**
- * This class encapsulates the REST end points associated with performing bulk operations against the document store.
- */
-public class BulkApi {
-
- /**
- * Indicates whether or not we have performed the one-time static initialization required for performing schema
- * validation.
- */
- protected static AtomicBoolean validationInitialized = new AtomicBoolean(false);
-
- /**
- * Factory used for importing our payload schema for validation purposes.
- */
- protected static JsonSchemaFactory schemaFactory = null;
-
- /**
- * Imported payload schema that will be used by our validation methods.
- */
- protected static JsonSchema schema = null;
-
- protected SearchServiceApi searchService = null;
-
- // Instantiate the loggers.
- private static Logger logger = LoggerFactory.getInstance().getLogger(BulkApi.class.getName());
- private static Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(BulkApi.class.getName());
-
- private static final String MSG_STACK_TRACE = "Stack Trace:\n";
-
- /**
- * Create a new instance of the BulkApi end point.
- */
- public BulkApi(SearchServiceApi searchService) {
- this.searchService = searchService;
- }
-
-
- /**
- * Processes client requests containing a set of operations to be performed in bulk.
- *
- * <p>
- * Method: POST
- *
- * @param operations - JSON structure enumerating the operations to be performed.
- * @param request - Raw HTTP request.
- * @param headers - HTTP headers.
- * @return - A standard REST response structure.
- */
- public ResponseEntity<String> processPost(String operations, HttpServletRequest request, HttpHeaders headers,
- DocumentStoreInterface documentStore) {
- ApiUtils.initMdcContext(request, headers);
-
- if (logger.isDebugEnabled()) {
- logger.debug("SEARCH: Process Bulk Request - operations = [" + operations.replaceAll("\n", "") + " ]");
- }
-
- // We expect a payload containing a JSON structure enumerating the operations to be performed.
- if (operations == null) {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, "Missing operations list payload");
- return buildResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Missing payload", request);
- }
-
- try {
- // Validate that the request is correctly authenticated before going any further.
- if (!searchService.validateRequest(headers, request, ApiUtils.Action.POST,
- ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, "Authentication failure.");
-
- return buildResponse(HttpStatus.FORBIDDEN.value(), "Authentication failure.", request);
- }
- } catch (Exception e) {
- // This is a catch all for any unexpected failure trying to perform the authentication.
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE,
- "Unexpected authentication failure - cause: " + e.getMessage());
- if (logger.isDebugEnabled()) {
- logger.debug(MSG_STACK_TRACE + e.getStackTrace());
- }
-
- return buildResponse(HttpStatus.FORBIDDEN.value(), "Authentication failure - cause " + e.getMessage(),
- request);
- }
-
- // Marshal the supplied json string into a Java object.
- ObjectMapper mapper = new ObjectMapper();
- BulkRequest[] requests = null;
- try {
- requests = mapper.readValue(operations, BulkRequest[].class);
- } catch (IOException e) {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, "Failed to marshal operations list: " + e.getMessage());
- if (logger.isDebugEnabled()) {
- logger.debug(MSG_STACK_TRACE + e.getStackTrace());
- }
- // Populate the result code and entity string for our HTTP response
- // and return the response to the client..
- return buildResponse(HttpStatus.BAD_REQUEST.value(), "Unable to marshal operations: " + e.getMessage(),
- request);
- }
-
- // Verify that our parsed operations list actually contains some valid operations.
- if (requests.length == 0) {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, "Empty operations list in bulk request");
-
- // Populate the result code and entity string for our HTTP response
- // and return the response to the client..
- return buildResponse(HttpStatus.BAD_REQUEST.value(), "Empty operations list in bulk request", request);
- }
-
- int resultCode;
- String resultString;
-
- try {
- // Now, forward the set of bulk operations to the DAO for processing.
- OperationResult result = documentStore.performBulkOperations(requests);
-
- resultCode = result.getResultCode();
- resultString = (result.getFailureCause() == null) ? result.getResult() : result.getFailureCause();
- } catch (DocumentStoreOperationException e) {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE,
- "Unexpected failure communicating with document store: " + e.getMessage());
- if (logger.isDebugEnabled()) {
- logger.debug(MSG_STACK_TRACE + e.getStackTrace());
- }
-
- resultCode = HttpStatus.INTERNAL_SERVER_ERROR.value();
- resultString = "Unexpected failure processing bulk operations: " + e.getMessage();
- }
-
- ResponseEntity<String> response =
- ResponseEntity.status(resultCode).contentType(MediaType.APPLICATION_JSON).body(resultString);
-
- if ((response.getStatusCodeValue() >= 200) && (response.getStatusCodeValue() < 300)) {
- logger.info(SearchDbMsgs.PROCESSED_BULK_OPERATIONS);
- } else {
- logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, response.getBody());
- }
-
- return buildResponse(resultCode, resultString, request);
- }
-
- /**
- * This method generates an audit log and returns an HTTP response object.
- *
- * @param resultCode - The result code to report.
- * @param resultString - The result string to report.
- * @param request - The HTTP request to extract data from for the audit log.
- * @return - An HTTP response object.
- */
- private ResponseEntity<String> buildResponse(int resultCode, String resultString, HttpServletRequest request) {
- ResponseEntity<String> response =
- ResponseEntity.status(resultCode).contentType(MediaType.APPLICATION_JSON).body(resultString);
-
- // Generate our audit log.
- String unknownLogField = "Unknown";
- auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
- new LogFields().setField(LogLine.DefinedFields.RESPONSE_CODE, resultCode)
- .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, ApiUtils.getHttpStatusString(resultCode)),
- (request != null) ? request.getMethod() : unknownLogField,
- (request != null) ? request.getRequestURL().toString() : unknownLogField,
- (request != null) ? request.getRemoteHost() : unknownLogField,
- Integer.toString(response.getStatusCodeValue()));
-
- // Clear the MDC context so that no other transaction inadvertently
- // uses our transaction id.
- ApiUtils.clearMdcContext();
-
- return response;
- }
-}
Code Review / aai / search-data-service.git / blobdiff