Fix minor code smells
[aai/search-data-service.git] / src / main / java / org / onap / aai / sa / rest / AnalyzerApi.java
index de7ba59..bf6f17c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/**
  * ============LICENSE_START=======================================================
  * org.onap.aai
  * ================================================================================
  */
 package org.onap.aai.sa.rest;
 
-import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.ElasticSearchHttpController;
-import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
+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.rest.AnalyzerSchema;
-
-import java.util.concurrent.atomic.AtomicBoolean;
-import javax.servlet.http.HttpServletRequest;
-import javax.ws.rs.GET;
-import javax.ws.rs.Path;
-import javax.ws.rs.core.Context;
-
-import org.springframework.beans.factory.annotation.Autowired;
+import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.ElasticSearchHttpController;
+import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.http.HttpStatus;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.stereotype.Component;
+import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RestController;
 
-//@Path("/analyzers")
+@Component
+@EnableWebSecurity
 @RestController
-@RequestMapping("/services/search-db-service/v1/analyzers")
+@RequestMapping("/services/search-data-service/v1/analyzers/search")
 public class AnalyzerApi {
 
-  private SearchServiceApi searchService = null;
+    private SearchServiceApi searchService = null;
 
-  // Set up the loggers.
-  private static Logger logger = LoggerFactory.getInstance().getLogger(IndexApi.class.getName());
-  private static Logger auditLogger = LoggerFactory.getInstance()
-      .getAuditLogger(IndexApi.class.getName());
+    // Set up the loggers.
+    private static Logger logger = LoggerFactory.getInstance().getLogger(IndexApi.class.getName());
+    private static Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(IndexApi.class.getName());
 
-  public AnalyzerApi( @Qualifier("searchServiceApi") SearchServiceApi searchService) {
-    this.searchService = searchService;
-  }
+    private static final String MSG_AUTHENTICATION_FAILURE = "Authentication failure.";
 
-  @GET
-  public ResponseEntity<String> processGet(@Context HttpServletRequest request,
-                             @Context HttpHeaders headers,
-                             ApiUtils apiUtils) {
+    public AnalyzerApi(@Qualifier("searchServiceApi") SearchServiceApi searchService) {
+        this.searchService = searchService;
+    }
 
-    HttpStatus responseCode = HttpStatus.INTERNAL_SERVER_ERROR;
-    String responseString = "Undefined error";
+    @RequestMapping(method = RequestMethod.GET, consumes = {"application/json"}, produces = {"application/json"})
+    public ResponseEntity<String> processGet(HttpServletRequest request, @RequestHeader HttpHeaders headers,
+            ApiUtils apiUtils) {
 
-    // Initialize the MDC Context for logging purposes.
-    ApiUtils.initMdcContext(request, headers);
+        HttpStatus responseCode = HttpStatus.INTERNAL_SERVER_ERROR;
+        String responseString;
 
-    // Validate that the request is correctly authenticated before going
-    // any further.
-    try {
+        // Initialize the MDC Context for logging purposes.
+        ApiUtils.initMdcContext(request, headers);
 
-      if (!searchService.validateRequest(headers, request,
-          ApiUtils.Action.GET, ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
-        logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE, "Authentication failure.");
-        return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType ( MediaType.APPLICATION_JSON ).body("Authentication failure.");
-      }
+        // Validate that the request is correctly authenticated before going
+        // any further.
+        try {
 
-    } catch (Exception e) {
+            if (!searchService.validateRequest(headers, request, ApiUtils.Action.GET,
+                    ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
+                logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE, MSG_AUTHENTICATION_FAILURE);
+                return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType(MediaType.APPLICATION_JSON)
+                        .body(MSG_AUTHENTICATION_FAILURE);
+            }
 
-      logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
-          "Unexpected authentication failure - cause: " + e.getMessage());
-      return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType ( MediaType.APPLICATION_JSON ).body("Authentication failure.");
-    }
+        } catch (Exception e) {
 
+            logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
+                    "Unexpected authentication failure - cause: " + e.getMessage());
+            return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType(MediaType.APPLICATION_JSON)
+                    .body(MSG_AUTHENTICATION_FAILURE);
+        }
 
-    // Now, build the list of analyzers.
-    try {
-      responseString = buildAnalyzerList(ElasticSearchHttpController.getInstance()
-          .getAnalysisConfig());
-      responseCode = HttpStatus.OK;
 
-    } catch (Exception e) {
+        // Now, build the list of analyzers.
+        try {
+            responseString = buildAnalyzerList(ElasticSearchHttpController.getInstance().getAnalysisConfig());
+            responseCode = HttpStatus.OK;
+        } catch (Exception e) {
+            logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
+                    "Unexpected failure retrieving analysis configuration - cause: " + e.getMessage());
+            responseString = "Failed to retrieve analysis configuration.  Cause: " + e.getMessage();
+        }
 
-      logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
-          "Unexpected failure retrieving analysis configuration - cause: " + e.getMessage());
-      responseString = "Failed to retrieve analysis configuration.  Cause: " + e.getMessage();
+        // Build the HTTP response.
+        ResponseEntity<String> response =
+                ResponseEntity.status(responseCode).contentType(MediaType.APPLICATION_JSON).body(responseString);
+
+        // Generate our audit log.
+        String unknownLogField = "Unknown";
+        auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
+                new LogFields().setField(LogLine.DefinedFields.RESPONSE_CODE, responseCode.value())
+                        .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, responseCode.value()),
+                (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;
     }
 
-    // Build the HTTP response.
-    ResponseEntity response = ResponseEntity.status(responseCode).contentType ( MediaType.APPLICATION_JSON ).body(responseString);
-
-    // Generate our audit log.
-    auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
-        new LogFields()
-            .setField(LogLine.DefinedFields.RESPONSE_CODE, responseCode.value ())
-            .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, responseCode.value()),
-        (request != null) ? request.getMethod() : "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;
-  }
-
-
-  /**
-   * This method takes a list of analyzer objects and generates a simple json
-   * structure to enumerate them.
-   *
-   * <p>Note, this includes only the aspects of the analyzer object that we want
-   * to make public to an external client.
-   *
-   * @param analysisConfig - The analysis configuration object to extract the
-   *                       analyzers from.
-   * @return - A json string enumerating the defined analyzers.
-   */
-  private String buildAnalyzerList(AnalysisConfiguration analysisConfig) {
-
-    StringBuilder sb = new StringBuilder();
-
-    sb.append("{");
-    AtomicBoolean firstAnalyzer = new AtomicBoolean(true);
-    for (AnalyzerSchema analyzer : analysisConfig.getAnalyzers()) {
-
-      if (!firstAnalyzer.compareAndSet(true, false)) {
-        sb.append(", ");
-      }
-
-      sb.append("{");
-      sb.append("\"name\": \"").append(analyzer.getName()).append("\", ");
-      sb.append("\"description\": \"").append(analyzer.getDescription()).append("\", ");
-      sb.append("\"behaviours\": [");
-      AtomicBoolean firstBehaviour = new AtomicBoolean(true);
-      for (String behaviour : analyzer.getBehaviours()) {
-        if (!firstBehaviour.compareAndSet(true, false)) {
-          sb.append(", ");
+    /**
+     * This method takes a list of analyzer objects and generates a simple json structure to enumerate them.
+     *
+     * <p>
+     * Note, this includes only the aspects of the analyzer object that we want to make public to an external client.
+     *
+     * @param analysisConfig - The analysis configuration object to extract the analyzers from.
+     * @return - A json string enumerating the defined analyzers.
+     */
+    private String buildAnalyzerList(AnalysisConfiguration analysisConfig) {
+
+        StringBuilder sb = new StringBuilder();
+
+        sb.append("{");
+        AtomicBoolean firstAnalyzer = new AtomicBoolean(true);
+        for (AnalyzerSchema analyzer : analysisConfig.getAnalyzers()) {
+
+            if (!firstAnalyzer.compareAndSet(true, false)) {
+                sb.append(", ");
+            }
+
+            sb.append("{");
+            sb.append("\"name\": \"").append(analyzer.getName()).append("\", ");
+            sb.append("\"description\": \"").append(analyzer.getDescription()).append("\", ");
+            sb.append("\"behaviours\": [");
+            AtomicBoolean firstBehaviour = new AtomicBoolean(true);
+            for (String behaviour : analyzer.getBehaviours()) {
+                if (!firstBehaviour.compareAndSet(true, false)) {
+                    sb.append(", ");
+                }
+                sb.append("\"").append(behaviour).append("\"");
+            }
+            sb.append("]");
+            sb.append("}");
         }
-        sb.append("\"").append(behaviour).append("\"");
-      }
-      sb.append("]");
-      sb.append("}");
-    }
-    sb.append("}");
+        sb.append("}");
 
-    return sb.toString();
-  }
+        return sb.toString();
+    }
 }