src/main/java/org/onap/aai/sa/rest/AnalyzerApi.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   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
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  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=========================================================
  20  */
  21 package org.onap.aai.sa.rest;
  22
  23 import java.util.concurrent.atomic.AtomicBoolean;
  24 import javax.servlet.http.HttpServletRequest;
  25 import org.onap.aai.cl.api.LogFields;
  26 import org.onap.aai.cl.api.LogLine;
  27 import org.onap.aai.cl.api.Logger;
  28 import org.onap.aai.cl.eelf.LoggerFactory;
  29 import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.ElasticSearchHttpController;
  30 import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
  31 import org.springframework.beans.factory.annotation.Qualifier;
  32 import org.springframework.http.HttpHeaders;
  33 import org.springframework.http.HttpStatus;
  34 import org.springframework.http.MediaType;
  35 import org.springframework.http.ResponseEntity;
  36 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
  37 import org.springframework.stereotype.Component;
  38 import org.springframework.web.bind.annotation.RequestHeader;
  39 import org.springframework.web.bind.annotation.RequestMapping;
  40 import org.springframework.web.bind.annotation.RequestMethod;
  41 import org.springframework.web.bind.annotation.RestController;
  42
  43 @Component
  44 @EnableWebSecurity
  45 @RestController
  46 @RequestMapping("/services/search-data-service/v1/analyzers/search")
  47 public class AnalyzerApi {
  48
  49   private SearchServiceApi searchService = null;
  50
  51   // Set up the loggers.
  52   private static Logger logger = LoggerFactory.getInstance().getLogger(IndexApi.class.getName());
  53     private static Logger auditLogger = LoggerFactory.getInstance().getAuditLogger(IndexApi.class.getName());
  54
  55   public AnalyzerApi( @Qualifier("searchServiceApi") SearchServiceApi searchService) {
  56     this.searchService = searchService;
  57   }
  58
  59     @RequestMapping(method = RequestMethod.GET, consumes = {"application/json"}, produces = {"application/json"})
  60     public ResponseEntity<String> processGet(HttpServletRequest request, @RequestHeader HttpHeaders headers,
  61                                            ApiUtils apiUtils) {
  62
  63     HttpStatus responseCode = HttpStatus.INTERNAL_SERVER_ERROR;
  64         String responseString;
  65
  66     // Initialize the MDC Context for logging purposes.
  67     ApiUtils.initMdcContext(request, headers);
  68
  69     // Validate that the request is correctly authenticated before going
  70     // any further.
  71     try {
  72
  73             if (!searchService.validateRequest(headers, request, ApiUtils.Action.GET,
  74                     ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
  75         logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE, "Authentication failure.");
  76                 return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType(MediaType.APPLICATION_JSON)
  77                         .body("Authentication failure.");
  78       }
  79
  80     } catch (Exception e) {
  81
  82       logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
  83           "Unexpected authentication failure - cause: " + e.getMessage());
  84             return ResponseEntity.status(HttpStatus.FORBIDDEN).contentType(MediaType.APPLICATION_JSON)
  85                     .body("Authentication failure.");
  86     }
  87
  88
  89     // Now, build the list of analyzers.
  90     try {
  91             responseString = buildAnalyzerList(ElasticSearchHttpController.getInstance().getAnalysisConfig());
  92       responseCode = HttpStatus.OK;
  93     } catch (Exception e) {
  94       logger.warn(SearchDbMsgs.GET_ANALYZERS_FAILURE,
  95           "Unexpected failure retrieving analysis configuration - cause: " + e.getMessage());
  96       responseString = "Failed to retrieve analysis configuration.  Cause: " + e.getMessage();
  97     }
  98
  99     // Build the HTTP response.
 100         ResponseEntity<String> response =
 101                 ResponseEntity.status(responseCode).contentType(MediaType.APPLICATION_JSON).body(responseString);
 102
 103     // Generate our audit log.
 104     auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
 105                 new LogFields().setField(LogLine.DefinedFields.RESPONSE_CODE, responseCode.value())
 106             .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, responseCode.value()),
 107         (request != null) ? request.getMethod() : "Unknown",
 108         (request != null) ? request.getRequestURL ().toString () : "Unknown",
 109         (request != null) ? request.getRemoteHost () : "Unknown",
 110         Integer.toString(response.getStatusCodeValue ()));
 111
 112     // Clear the MDC context so that no other transaction inadvertently
 113     // uses our transaction id.
 114     ApiUtils.clearMdcContext();
 115
 116     return response;
 117   }
 118
 119   /**
 120      * This method takes a list of analyzer objects and generates a simple json structure to enumerate them.
 121    *
 122      * <p>
 123      * Note, this includes only the aspects of the analyzer object that we want to make public to an external client.
 124    *
 125      * @param analysisConfig - The analysis configuration object to extract the analyzers from.
 126    * @return - A json string enumerating the defined analyzers.
 127    */
 128   private String buildAnalyzerList(AnalysisConfiguration analysisConfig) {
 129
 130     StringBuilder sb = new StringBuilder();
 131
 132     sb.append("{");
 133     AtomicBoolean firstAnalyzer = new AtomicBoolean(true);
 134     for (AnalyzerSchema analyzer : analysisConfig.getAnalyzers()) {
 135
 136       if (!firstAnalyzer.compareAndSet(true, false)) {
 137         sb.append(", ");
 138       }
 139
 140       sb.append("{");
 141       sb.append("\"name\": \"").append(analyzer.getName()).append("\", ");
 142       sb.append("\"description\": \"").append(analyzer.getDescription()).append("\", ");
 143       sb.append("\"behaviours\": [");
 144       AtomicBoolean firstBehaviour = new AtomicBoolean(true);
 145       for (String behaviour : analyzer.getBehaviours()) {
 146         if (!firstBehaviour.compareAndSet(true, false)) {
 147           sb.append(", ");
 148         }
 149         sb.append("\"").append(behaviour).append("\"");
 150       }
 151       sb.append("]");
 152       sb.append("}");
 153     }
 154     sb.append("}");
 155
 156     return sb.toString();
 157   }
 158 }