1 files changed, 379 insertions, 0 deletions
diff --git a/src/main/java/org/onap/aai/sa/rest/IndexApi.java b/src/main/java/org/onap/aai/sa/rest/IndexApi.java
new file mode 100644
index 0000000..4e89fb9
--- /dev/null
+++ b/src/main/java/org/onap/aai/sa/rest/IndexApi.java
@@ -0,0 +1,379 @@
+/**
+ * ============LICENSE_START=======================================================
+ * org.onap.aai
+ * ================================================================================
+ * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright © 2017 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=========================================================
+ *
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+package org.onap.aai.sa.rest;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+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.openecomp.cl.api.LogFields;
+import org.openecomp.cl.api.LogLine;
+import org.openecomp.cl.api.Logger;
+import org.openecomp.cl.eelf.LoggerFactory;
+import org.onap.aai.sa.rest.DocumentFieldSchema;
+import org.onap.aai.sa.rest.DocumentSchema;
+
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.Response;
+
+
+/**
+ * This class encapsulates the REST end points associated with manipulating
+ * indexes in the document store.
+ */
+public class IndexApi {
+
+  protected SearchServiceApi searchService = null;
+
+  /**
+   * Configuration for the custom analyzers that will be used for indexing.
+   */
+  protected AnalysisConfiguration analysisConfig;
+
+  // 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 IndexApi(SearchServiceApi searchService) {
+    this.searchService = searchService;
+    init();
+  }
+
+
+  /**
+   * Initializes the end point.
+   *
+   * @throws FileNotFoundException
+   * @throws IOException
+   * @throws DocumentStoreOperationException
+   */
+  public void init() {
+
+    // Instantiate our analysis configuration object.
+    analysisConfig = new AnalysisConfiguration();
+  }
+
+
+  /**
+   * Processes client requests to create a new index and document type in the
+   * document store.
+   *
+   * @param documentSchema - The contents of the request body which is expected
+   *                       to be a JSON structure which corresponds to the
+   *                       schema defined in document.schema.json
+   * @param index          - The name of the index to create.
+   * @return - A Standard REST response
+   */
+  public Response processCreateIndex(String documentSchema,
+                                     HttpServletRequest request,
+                                     HttpHeaders headers,
+                                     String index,
+                                     DocumentStoreInterface documentStore) {
+
+    int resultCode = 500;
+    String resultString = "Unexpected 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.POST, ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
+        logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index, "Authentication failure.");
+        return errorResponse(Response.Status.FORBIDDEN, "Authentication failure.", request);
+      }
+
+    } catch (Exception e) {
+
+      logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index,
+          "Unexpected authentication failure - cause: " + e.getMessage());
+      return errorResponse(Response.Status.FORBIDDEN, "Authentication failure.", request);
+    }
+
+
+    // We expect a payload containing the document schema.  Make sure
+    // it is present.
+    if (documentSchema == null) {
+      logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index, "Missing document schema payload");
+      return errorResponse(Response.Status.fromStatusCode(resultCode), "Missing payload", request);
+    }
+
+    try {
+
+      // Marshal the supplied json string into a document schema object.
+      ObjectMapper mapper = new ObjectMapper();
+      DocumentSchema schema = mapper.readValue(documentSchema, DocumentSchema.class);
+
+      // Now, ask the DAO to create the index.
+      OperationResult result = documentStore.createIndex(index, schema);
+
+      // Extract the result code and string from the OperationResult
+      // object so that we can use them to generate a standard REST
+      // response.
+      // Note that we want to return a 201 result code on a successful
+      // create, so if we get back a 200 from the document store,
+      // translate that int a 201.
+      resultCode = (result.getResultCode() == 200) ? 201 : result.getResultCode();
+      resultString = (result.getFailureCause() == null)
+          ? result.getResult() : result.getFailureCause();
+
+    } catch (com.fasterxml.jackson.core.JsonParseException
+        | com.fasterxml.jackson.databind.JsonMappingException e) {
+
+      // We were unable to marshal the supplied json string into a valid
+      // document schema, so return an appropriate error response.
+      resultCode = javax.ws.rs.core.Response.Status.BAD_REQUEST.getStatusCode();
+      resultString = "Malformed schema: " + e.getMessage();
+
+    } catch (IOException e) {
+
+      // We'll treat this is a general internal error.
+      resultCode = javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR.getStatusCode();
+      resultString = "IO Failure: " + e.getMessage();
+    }
+
+    Response response = Response.status(resultCode).entity(resultString).build();
+
+    // Log the result.
+    if ((response.getStatus() >= 200) && (response.getStatus() < 300)) {
+      logger.info(SearchDbMsgs.CREATED_INDEX, index);
+    } else {
+      logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index, resultString);
+    }
+
+    // Generate our audit log.
+    auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
+        new LogFields()
+            .setField(LogLine.DefinedFields.RESPONSE_CODE, resultCode)
+            .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION,
+                Response.Status.fromStatusCode(resultCode).toString()),
+        (request != null) ? request.getMethod() : "Unknown",
+        (request != null) ? request.getRequestURL().toString() : "Unknown",
+        (request != null) ? request.getRemoteHost() : "Unknown",
+        Integer.toString(response.getStatus()));
+
+    // Clear the MDC context so that no other transaction inadvertently
+    // uses our transaction id.
+    ApiUtils.clearMdcContext();
+
+    // Finally, return the response.
+    return response;
+  }
+
+
+  /**
+   * Processes a client request to remove an index from the document store.
+   * Note that this implicitly deletes all documents contained within that index.
+   *
+   * @param index - The index to be deleted.
+   * @return - A standard REST response.
+   */
+  public Response processDelete(String index,
+                                HttpServletRequest request,
+                                HttpHeaders headers,
+                                DocumentStoreInterface documentStore) {
+
+    // Initialize the MDC Context for logging purposes.
+    ApiUtils.initMdcContext(request, headers);
+
+    // Set a default response in case something unexpected goes wrong.
+    Response response = Response.status(javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR)
+        .entity("Unknown")
+        .build();
+
+    // Validate that the request is correctly authenticated before going
+    // any further.
+    try {
+
+      if (!searchService.validateRequest(headers, request, ApiUtils.Action.POST,
+          ApiUtils.SEARCH_AUTH_POLICY_NAME)) {
+        logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index, "Authentication failure.");
+        return errorResponse(Response.Status.FORBIDDEN, "Authentication failure.", request);
+      }
+
+    } catch (Exception e) {
+
+      logger.warn(SearchDbMsgs.INDEX_CREATE_FAILURE, index,
+          "Unexpected authentication failure - cause: " + e.getMessage());
+      return errorResponse(Response.Status.FORBIDDEN, "Authentication failure.", request);
+    }
+
+
+    try {
+      // Send the request to the document store.
+      response = responseFromOperationResult(documentStore.deleteIndex(index));
+
+    } catch (DocumentStoreOperationException e) {
+      response = Response.status(javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR)
+          .entity(e.getMessage())
+          .build();
+    }
+
+
+    // Log the result.
+    if ((response.getStatus() >= 200) && (response.getStatus() < 300)) {
+      logger.info(SearchDbMsgs.DELETED_INDEX, index);
+    } else {
+      logger.warn(SearchDbMsgs.INDEX_DELETE_FAILURE, index, (String) response.getEntity());
+    }
+
+    // Generate our audit log.
+    auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
+        new LogFields()
+            .setField(LogLine.DefinedFields.RESPONSE_CODE, response.getStatus())
+            .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION,
+                response.getStatusInfo().getReasonPhrase()),
+        (request != null) ? request.getMethod() : "Unknown",
+        (request != null) ? request.getRequestURL().toString() : "Unknown",
+        (request != null) ? request.getRemoteHost() : "Unknown",
+        Integer.toString(response.getStatus()));
+
+    // Clear the MDC context so that no other transaction inadvertently
+    // uses our transaction id.
+    ApiUtils.clearMdcContext();
+
+    return response;
+  }
+
+
+  /**
+   * This method takes a JSON format document schema and produces a set of
+   * field mappings in the form that Elastic Search expects.
+   *
+   * @param documentSchema - A document schema expressed as a JSON string.
+   * @return - A JSON string expressing an Elastic Search mapping configuration.
+   * @throws com.fasterxml.jackson.core.JsonParseException
+   * @throws com.fasterxml.jackson.databind.JsonMappingException
+   * @throws IOException
+   */
+  public String generateDocumentMappings(String documentSchema)
+      throws com.fasterxml.jackson.core.JsonParseException,
+      com.fasterxml.jackson.databind.JsonMappingException, IOException {
+
+    // Unmarshal the json content into a document schema object.
+    ObjectMapper mapper = new ObjectMapper();
+    DocumentSchema schema = mapper.readValue(documentSchema, DocumentSchema.class);
+
+    // Now, generate the Elastic Search mapping json and return it.
+    StringBuilder sb = new StringBuilder();
+    sb.append("{");
+    sb.append("\"properties\": {");
+
+    boolean first = true;
+    for (DocumentFieldSchema field : schema.getFields()) {
+
+      if (!first) {
+        sb.append(",");
+      } else {
+        first = false;
+      }
+
+      sb.append("\"").append(field.getName()).append("\": {");
+
+      // The field type is mandatory.
+      sb.append("\"type\": \"").append(field.getDataType()).append("\"");
+
+      // If the index field was specified, then append it.
+      if (field.getSearchable() != null) {
+        sb.append(", \"index\": \"").append(field.getSearchable()
+            ? "analyzed" : "not_analyzed").append("\"");
+      }
+
+      // If a search analyzer was specified, then append it.
+      if (field.getSearchAnalyzer() != null) {
+        sb.append(", \"search_analyzer\": \"").append(field.getSearchAnalyzer()).append("\"");
+      }
+
+      // If an indexing analyzer was specified, then append it.
+      if (field.getIndexAnalyzer() != null) {
+        sb.append(", \"analyzer\": \"").append(field.getIndexAnalyzer()).append("\"");
+      } else {
+        sb.append(", \"analyzer\": \"").append("whitespace").append("\"");
+      }
+
+      sb.append("}");
+    }
+
+    sb.append("}");
+    sb.append("}");
+
+    logger.debug("Generated document mappings: " + sb.toString());
+
+    return sb.toString();
+  }
+
+
+  /**
+   * Converts an {@link OperationResult} to a standard REST {@link Response}
+   * object.
+   *
+   * @param result - The {@link OperationResult} to be converted.
+   * @return - The equivalent {@link Response} object.
+   */
+  public Response responseFromOperationResult(OperationResult result) {
+
+    if ((result.getResultCode() >= 200) && (result.getResultCode() < 300)) {
+      return Response.status(result.getResultCode()).entity(result.getResult()).build();
+    } else {
+      if (result.getFailureCause() != null) {
+        return Response.status(result.getResultCode()).entity(result.getFailureCause()).build();
+      } else {
+        return Response.status(result.getResultCode()).entity(result.getResult()).build();
+      }
+    }
+  }
+
+  public Response errorResponse(Response.Status status, String msg, HttpServletRequest request) {
+
+    // Generate our audit log.
+    auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
+        new LogFields()
+            .setField(LogLine.DefinedFields.RESPONSE_CODE, status.getStatusCode())
+            .setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, status.getReasonPhrase()),
+        (request != null) ? request.getMethod() : "Unknown",
+        (request != null) ? request.getRequestURL().toString() : "Unknown",
+        (request != null) ? request.getRemoteHost() : "Unknown",
+        Integer.toString(status.getStatusCode()));
+
+    // Clear the MDC context so that no other transaction inadvertently
+    // uses our transaction id.
+    ApiUtils.clearMdcContext();
+
+    return Response.status(status)
+        .entity(msg)
+        .build();
+  }
+
+
+}