aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/sa/rest/AnalyzerApi.java
blob: de7ba59e7d0436c325db69c523b3afb2ef6479fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
 * ============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 org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.ElasticSearchHttpController;
import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
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.springframework.beans.factory.annotation.Qualifier;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

//@Path("/analyzers")
@RestController
@RequestMapping("/services/search-db-service/v1/analyzers")
public class AnalyzerApi {

  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());

  public AnalyzerApi( @Qualifier("searchServiceApi") SearchServiceApi searchService) {
    this.searchService = searchService;
  }

  @GET
  public ResponseEntity<String> processGet(@Context HttpServletRequest request,
                             @Context HttpHeaders headers,
                             ApiUtils apiUtils) {

    HttpStatus responseCode = HttpStatus.INTERNAL_SERVER_ERROR;
    String responseString = "Undefined error";

    // Initialize the MDC Context for logging purposes.
    ApiUtils.initMdcContext(request, headers);

    // Validate that the request is correctly authenticated before going
    // any further.
    try {

      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.");
      }

    } 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("Authentication failure.");
    }


    // 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();
    }

    // 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(", ");
        }
        sb.append("\"").append(behaviour).append("\"");
      }
      sb.append("]");
      sb.append("}");
    }
    sb.append("}");

    return sb.toString();
  }
}