1 files changed, 175 insertions, 191 deletions
diff --git a/src/main/java/org/onap/aai/sa/rest/BulkApi.java b/src/main/java/org/onap/aai/sa/rest/BulkApi.java
index 0770bf1..bf8f187 100644
--- a/src/main/java/org/onap/aai/sa/rest/BulkApi.java
+++ b/src/main/java/org/onap/aai/sa/rest/BulkApi.java
@@ -41,212 +41,196 @@ import org.springframework.http.ResponseEntity;
 
 
 /**
- * This class encapsulates the REST end points associated with performing
- * bulk operations against the document store.
+ * 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());
-
-
-  /**
-   * 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 apiUtils) {
-
-
-    // Initialize the MDC Context for logging purposes.
-    ApiUtils.initMdcContext(request, headers);
-
-    // Set a default result code and entity string for the request.
-    int resultCode = 500;
-    String resultString = "Unexpected error";
-
-    if (logger.isDebugEnabled()) {
-      logger.debug("SEARCH: Process Bulk Request - operations = ["
-          + operations.replaceAll("\n", "") + " ]");
-    }
+    /**
+     * Indicates whether or not we have performed the one-time static initialization required for performing schema
+     * validation.
+     */
+    protected static AtomicBoolean validationInitialized = new AtomicBoolean(false);
 
-    try {
+    /**
+     * Factory used for importing our payload schema for validation purposes.
+     */
+    protected static JsonSchemaFactory schemaFactory = null;
 
-      // 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.");
+    /**
+     * Imported payload schema that will be used by our validation methods.
+     */
+    protected static JsonSchema schema = null;
 
-        return buildResponse(HttpStatus.FORBIDDEN.value (),
-            "Authentication failure.", request, apiUtils);
-      }
+    protected SearchServiceApi searchService = null;
 
-    } catch (Exception e) {
+    // Instantiate the loggers.
+    private static Logger logger = LoggerFactory.getInstance().getLogger(BulkApi.class.getName());
+    private static Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(BulkApi.class.getName());
 
-      // 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("Stack Trace:\n" + e.getStackTrace());
-      }
 
-      return buildResponse(HttpStatus.FORBIDDEN.value (),
-          "Authentication failure - cause " + e.getMessage(),
-          request,
-          apiUtils);
+    /**
+     * Create a new instance of the BulkApi end point.
+     */
+    public BulkApi(SearchServiceApi searchService) {
+        this.searchService = searchService;
     }
 
-    // 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(resultCode, "Missing payload", request, apiUtils);
-    }
-
-
-    // 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) {
+    /**
+     * 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 apiUtils) {
+
+
+        // Initialize the MDC Context for logging purposes.
+        ApiUtils.initMdcContext(request, headers);
+
+        // Set a default result code and entity string for the request.
+        int resultCode = 500;
+        String resultString = "Unexpected error";
+
+        if (logger.isDebugEnabled()) {
+            logger.debug("SEARCH: Process Bulk Request - operations = [" + operations.replaceAll("\n", "") + " ]");
+        }
+
+        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, apiUtils);
+            }
+
+        } 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("Stack Trace:\n" + e.getStackTrace());
+            }
+
+            return buildResponse(HttpStatus.FORBIDDEN.value(), "Authentication failure - cause " + e.getMessage(),
+                    request, apiUtils);
+        }
+
+        // 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(resultCode, "Missing payload", request, apiUtils);
+        }
+
+
+        // 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("Stack Trace:\n" + 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, apiUtils);
+        }
+
+        // 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,
+                    apiUtils);
+        }
+        try {
+
+            // Now, forward the set of bulk operations to the DAO for processing.
+            OperationResult result = documentStore.performBulkOperations(requests);
+
+            // Populate the result code and entity string for our HTTP response.
+            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("Stack Trace:\n" + e.getStackTrace());
+            }
+
+            // Populate the result code and entity string for our HTTP response.
+            resultCode = HttpStatus.INTERNAL_SERVER_ERROR.value();
+            resultString = "Unexpected failure processing bulk operations: " + e.getMessage();
+        }
 
-      logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE,
-          "Failed to marshal operations list: " + e.getMessage());
-      if (logger.isDebugEnabled()) {
-        logger.debug("Stack Trace:\n" + 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,
-          apiUtils);
+        // Build our HTTP response.
+        ResponseEntity response =
+                ResponseEntity.status(resultCode).contentType(MediaType.APPLICATION_JSON).body(resultString);
+
+        // Log the result.
+        if ((response.getStatusCodeValue() >= 200) && (response.getStatusCodeValue() < 300)) {
+            logger.info(SearchDbMsgs.PROCESSED_BULK_OPERATIONS);
+        } else {
+            logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, (String) response.getBody());
+        }
+
+        // Finally, return the HTTP response to the client.
+        return buildResponse(resultCode, resultString, request, apiUtils);
     }
 
-    // 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,
-          apiUtils);
+    /**
+     * 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,
+            ApiUtils apiUtils) {
+
+        ResponseEntity<String> response =
+                ResponseEntity.status(resultCode).contentType(MediaType.APPLICATION_JSON).body(resultString);
+
+        // Generate our audit log.
+        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().toString() : "Unknown",
+                (request != null) ? request.getRequestURL().toString() : "Unknown",
+                (request != null) ? request.getRemoteHost() : "Unknown",
+                Integer.toString(response.getStatusCodeValue()));
+
+        // Clear the MDC context so that no other transaction inadvertently
+        // uses our transaction id.
+        ApiUtils.clearMdcContext();
+
+        return response;
     }
-    try {
-
-      // Now, forward the set of bulk operations to the DAO for processing.
-      OperationResult result = documentStore.performBulkOperations(requests);
-
-      // Populate the result code and entity string for our HTTP response.
-      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("Stack Trace:\n" + e.getStackTrace());
-      }
-
-      // Populate the result code and entity string for our HTTP response.
-      resultCode = HttpStatus.INTERNAL_SERVER_ERROR.value ();
-      resultString = "Unexpected failure processing bulk operations: " + e.getMessage();
-    }
-
-    // Build our HTTP response.
-    ResponseEntity response = ResponseEntity.status(resultCode).contentType ( MediaType.APPLICATION_JSON ).body(resultString);
-
-    // Log the result.
-    if ((response.getStatusCodeValue () >= 200) && (response.getStatusCodeValue () < 300)) {
-      logger.info(SearchDbMsgs.PROCESSED_BULK_OPERATIONS);
-    } else {
-      logger.warn(SearchDbMsgs.BULK_OPERATION_FAILURE, (String) response.getBody ());
-    }
-
-    // Finally, return the HTTP response to the client.
-    return buildResponse(resultCode, resultString, request, apiUtils);
-  }
-
-
-  /**
-   * 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, ApiUtils apiUtils) {
-
-    ResponseEntity<String> response = ResponseEntity.status(resultCode).contentType ( MediaType.APPLICATION_JSON ) .body(resultString);
-
-    // Generate our audit log.
-    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().toString () : "Unknown",
-        (request != null) ? request.getRequestURL ().toString () : "Unknown",
-        (request != null) ? request.getRemoteHost ()  : "Unknown",
-        Integer.toString(response.getStatusCodeValue ()));
-
-    // Clear the MDC context so that no other transaction inadvertently
-    // uses our transaction id.
-    ApiUtils.clearMdcContext();
-
-    return response;
-  }
 }