* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
- * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2017 Amdocs
+ * 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.
* 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.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
-
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+//import javax.ws.rs.core.HttpHeaders;
+//import javax.ws.rs.core.MediaType;
+//import javax.ws.rs.core.Response;
+//import javax.ws.rs.core.Response.Status;
+// Spring Imports
+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.searchdbabstraction.elasticsearch.dao.DocumentStoreDataEntityImpl;
import org.onap.aai.sa.searchdbabstraction.elasticsearch.dao.DocumentStoreInterface;
import org.onap.aai.sa.searchdbabstraction.entity.AggregationResults;
import org.onap.aai.sa.searchdbabstraction.entity.SearchOperationResult;
import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
import org.onap.aai.sa.searchdbabstraction.searchapi.SearchStatement;
-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 javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import javax.ws.rs.core.HttpHeaders;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import javax.ws.rs.core.Response.Status;
+import org.onap.aai.sa.searchdbabstraction.searchapi.SuggestionStatement;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
public class DocumentApi {
private static final String REQUEST_HEADER_RESOURCE_VERSION = "If-Match";
this.searchService = searchService;
}
- public Response processPost(String content, HttpServletRequest request, HttpHeaders headers,
+ public ResponseEntity<String> processPost(String content, HttpServletRequest request, HttpHeaders headers,
HttpServletResponse httpResponse, String index,
DocumentStoreInterface documentStore) {
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_EMPTY);
if (content == null) {
- return handleError(request, content, Status.BAD_REQUEST);
+ return handleError(request, content, HttpStatus.BAD_REQUEST);
}
boolean isValid;
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"DocumentApi.processPost",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
if (httpResponse != null) {
httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
}
- Response response = Response.status(result.getResultCode()).entity(output).build();
- logResult(request, Response.Status.fromStatusCode(response.getStatus()));
+ ResponseEntity response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
+ logResult(request, HttpStatus.valueOf ( response.getStatusCodeValue () ));
+ logResult(request, HttpStatus.valueOf ( response.getStatusCodeValue () ));
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- public Response processPut(String content, HttpServletRequest request, HttpHeaders headers,
+ public ResponseEntity<String> processPut(String content, HttpServletRequest request, HttpHeaders headers,
HttpServletResponse httpResponse, String index,
String id, DocumentStoreInterface documentStore) {
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_EMPTY);
if (content == null) {
- return handleError(request, content, Status.BAD_REQUEST);
+ return handleError(request, content, HttpStatus.BAD_REQUEST);
}
boolean isValid;
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"DocumentApi.processPut",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
- String resourceVersion = headers.getRequestHeaders()
- .getFirst(REQUEST_HEADER_RESOURCE_VERSION);
+ String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
document.setId(id);
if (httpResponse != null) {
httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
}
- Response response = Response.status(result.getResultCode()).entity(output).build();
- logResult(request, Response.Status.fromStatusCode(response.getStatus()));
+ ResponseEntity response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
+ logResult(request, HttpStatus.valueOf ( response.getStatusCodeValue () ));
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- public Response processDelete(String content, HttpServletRequest request, HttpHeaders headers,
+ public ResponseEntity<String> processDelete(String content, HttpServletRequest request, HttpHeaders headers,
HttpServletResponse httpResponse, String index, String id,
DocumentStoreInterface documentStore) {
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"DocumentApi.processDelete",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
- String resourceVersion = headers.getRequestHeaders()
- .getFirst(REQUEST_HEADER_RESOURCE_VERSION);
+ String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
if (resourceVersion == null || resourceVersion.isEmpty()) {
return handleError(request, "Request header 'If-Match' missing",
- javax.ws.rs.core.Response.Status.BAD_REQUEST);
+ HttpStatus.BAD_REQUEST);
}
DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
if (httpResponse != null) {
httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
}
- Response response;
+ ResponseEntity response;
if (output == null) {
- response = Response.status(result.getResultCode()).build();
+ response = ResponseEntity.status(result.getResultCode()).build();
} else {
- response = Response.status(result.getResultCode()).entity(output).build();
+ response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
}
- logResult(request, Response.Status.fromStatusCode(response.getStatus()));
+ logResult(request, HttpStatus.valueOf ( response.getStatusCodeValue () ));
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- public Response processGet(String content, HttpServletRequest request, HttpHeaders headers,
+ public ResponseEntity<String> processGet(String content, HttpServletRequest request, HttpHeaders headers,
HttpServletResponse httpResponse, String index, String id,
DocumentStoreInterface documentStore) {
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"DocumentApi.processGet",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
- String resourceVersion = headers.getRequestHeaders()
- .getFirst(REQUEST_HEADER_RESOURCE_VERSION);
+ String resourceVersion = headers.getFirst(REQUEST_HEADER_RESOURCE_VERSION);
DocumentStoreDataEntityImpl document = new DocumentStoreDataEntityImpl();
document.setId(id);
if (httpResponse != null) {
httpResponse.setHeader(RESPONSE_HEADER_RESOURCE_VERSION, result.getResultVersion());
}
- Response response = Response.status(result.getResultCode()).entity(output).build();
- logResult(request, Response.Status.fromStatusCode(response.getStatus()));
+ ResponseEntity response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
+ logResult(request, HttpStatus.valueOf ( response.getStatusCodeValue () ));
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- public Response processSearchWithGet(String content, HttpServletRequest request,
+ public ResponseEntity<String> processSearchWithGet(String content, HttpServletRequest request,
HttpHeaders headers, String index,
String queryText, DocumentStoreInterface documentStore) {
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"processSearchWithGet",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
SearchOperationResult result = documentStore.search(index, queryText);
? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
: result.getFailureCause();
}
- Response response = Response.status(result.getResultCode()).entity(output).build();
+ ResponseEntity response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
- public Response queryWithGetWithPayload(String content, HttpServletRequest request,
+ public ResponseEntity<String> queryWithGetWithPayload(String content, HttpServletRequest request,
HttpHeaders headers, String index,
DocumentStoreInterface documentStore) {
ApiUtils.initMdcContext(request, headers);
logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "GET", (request != null)
- ? request.getRequestURL().toString() : "");
+ ? request.getRequestURL ().toString () : "");
if (logger.isDebugEnabled()) {
logger.debug("Request Body: " + content);
}
return processQuery(index, content, request, headers, documentStore);
}
- public Response processSearchWithPost(String content, HttpServletRequest request,
+ public ResponseEntity<String> processSearchWithPost(String content, HttpServletRequest request,
HttpHeaders headers, String index,
DocumentStoreInterface documentStore) {
ApiUtils.initMdcContext(request, headers);
logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST", (request != null)
- ? request.getRequestURL().toString() : "");
+ ? request.getRequestURL ().toString () : "");
if (logger.isDebugEnabled()) {
logger.debug("Request Body: " + content);
}
return processQuery(index, content, request, headers, documentStore);
}
+
+ public ResponseEntity<String> processSuggestQueryWithPost(String content, HttpServletRequest request,
+ HttpHeaders headers, String index, DocumentStoreInterface documentStore) {
+
+ // Initialize the MDC Context for logging purposes.
+ ApiUtils.initMdcContext(request, headers);
+
+ logger.info(SearchDbMsgs.PROCESS_PAYLOAD_QUERY, "POST",
+ (request != null) ? request.getRequestURL().toString() : "");
+ if (logger.isDebugEnabled()) {
+ logger.debug("Request Body: " + content);
+ }
+
+ return processSuggestQuery(index, content, request, headers, documentStore);
+ }
+
/**
* Common handler for query requests. This is called by both the GET with
* payload and POST with payload variants of the query endpoint.
* @param headers - The HTTP headers.
* @return - A standard HTTP response.
*/
- private Response processQuery(String index, String content, HttpServletRequest request,
+ private ResponseEntity processQuery(String index, String content, HttpServletRequest request,
HttpHeaders headers, DocumentStoreInterface documentStore) {
try {
// Make sure that we were supplied a payload before proceeding.
if (content == null) {
- return handleError(request, content, Status.BAD_REQUEST);
+ return handleError(request, content, HttpStatus.BAD_REQUEST);
}
// Validate that the request has the appropriate authorization.
logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL,
"processQuery",
e.getMessage());
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
if (!isValid) {
- return handleError(request, content, Status.FORBIDDEN);
+ return handleError(request, content, HttpStatus.FORBIDDEN);
}
SearchStatement searchStatement;
searchStatement = mapper.readValue(content, SearchStatement.class);
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.BAD_REQUEST);
+ return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
}
// Now, submit the search statement, translated into
? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
: result.getFailureCause();
}
- Response response = Response.status(result.getResultCode()).entity(output).build();
+ ResponseEntity response = ResponseEntity.status(result.getResultCode()).contentType ( MediaType.APPLICATION_JSON ).body(output);
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.
return response;
} catch (Exception e) {
- return handleError(request, e.getMessage(), Status.INTERNAL_SERVER_ERROR);
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
}
}
+
+ /**
+ * Common handler for query requests. This is called by both the GET with payload and POST with
+ * payload variants of the query endpoint.
+ *
+ * @param index - The index to be queried against.
+ * @param content - The payload containing the query structure.
+ * @param request - The HTTP request.
+ * @param headers - The HTTP headers.
+ * @return - A standard HTTP response.
+ */
+ private ResponseEntity<String> processSuggestQuery(String index, String content, HttpServletRequest request,
+ HttpHeaders headers, DocumentStoreInterface documentStore) {
+
+ try {
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.setSerializationInclusion(Include.NON_EMPTY);
+
+ // Make sure that we were supplied a payload before proceeding.
+ if (content == null) {
+ return handleError(request, content, HttpStatus.BAD_REQUEST);
+ }
+
+ // Validate that the request has the appropriate authorization.
+ boolean isValid;
+ try {
+ isValid = searchService.validateRequest(headers, request, ApiUtils.Action.POST,
+ ApiUtils.SEARCH_AUTH_POLICY_NAME);
+
+ } catch (Exception e) {
+ logger.info(SearchDbMsgs.EXCEPTION_DURING_METHOD_CALL, "processQuery", e.getMessage());
+ return handleError(request, content, HttpStatus.FORBIDDEN);
+ }
+
+ if (!isValid) {
+ return handleError(request, content, HttpStatus.FORBIDDEN);
+ }
+
+ SuggestionStatement suggestionStatement;
+
+ try {
+ // Marshall the supplied request payload into a search statement
+ // object.
+ suggestionStatement = mapper.readValue(content, SuggestionStatement.class);
+
+ } catch (Exception e) {
+ return handleError(request, e.getMessage(), HttpStatus.BAD_REQUEST);
+ }
+
+ // Now, submit the search statement, translated into
+ // ElasticSearch syntax, to the document store DAO.
+ SearchOperationResult result =
+ documentStore.suggestionQueryWithPayload(index, suggestionStatement.toElasticSearch());
+ String output = null;
+ if (result.getResultCode() >= 200 && result.getResultCode() <= 299) {
+ output = prepareSuggestOutput(mapper, result);
+ } else {
+ output = result.getError() != null
+ ? mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getError())
+ : result.getFailureCause();
+ }
+ ResponseEntity<String> response = ResponseEntity.status(result.getResultCode()).body(output);
+
+ // Clear the MDC context so that no other transaction inadvertently
+ // uses our transaction id.
+ ApiUtils.clearMdcContext();
+
+ return response;
+
+ } catch (Exception e) {
+ return handleError(request, e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
+ }
+ }
/**
* Checks the supplied HTTP headers to see if we should allow the underlying document
boolean createIndexIfNotPresent = false;
String implicitIndexCreationHeader =
- headers.getRequestHeaders().getFirst(REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION);
+ headers.getFirst(REQUEST_HEADER_ALLOW_IMPLICIT_INDEX_CREATION);
if( (implicitIndexCreationHeader != null) && (implicitIndexCreationHeader.equals("true")) ) {
createIndexIfNotPresent = true;
return createIndexIfNotPresent;
}
-
-
+
private String prepareOutput(ObjectMapper mapper, SearchOperationResult result)
- throws JsonProcessingException {
+ throws JsonProcessingException {
+ StringBuffer output = new StringBuffer();
+ output.append("{\r\n\"searchResult\":");
+ output.append(
+ mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSearchResult()));
+ AggregationResults aggs = result.getAggregationResult();
+ if (aggs != null) {
+ output.append(",\r\n\"aggregationResult\":");
+ output.append(mapper.setSerializationInclusion(Include.NON_NULL)
+ .writerWithDefaultPrettyPrinter().writeValueAsString(aggs));
+ }
+ output.append("\r\n}");
+ return output.toString();
+ }
+
+ private String prepareSuggestOutput(ObjectMapper mapper, SearchOperationResult result)
+ throws JsonProcessingException {
StringBuffer output = new StringBuffer();
output.append("{\r\n\"searchResult\":");
- output.append(mapper.writerWithDefaultPrettyPrinter()
- .writeValueAsString(result.getSearchResult()));
+ output.append(
+ mapper.writerWithDefaultPrettyPrinter().writeValueAsString(result.getSuggestResult()));
AggregationResults aggs = result.getAggregationResult();
if (aggs != null) {
output.append(",\r\n\"aggregationResult\":");
output.append(mapper.setSerializationInclusion(Include.NON_NULL)
- .writerWithDefaultPrettyPrinter().writeValueAsString(aggs));
+ .writerWithDefaultPrettyPrinter().writeValueAsString(aggs));
}
output.append("\r\n}");
return output.toString();
}
- private Response handleError(HttpServletRequest request, String message, Status status) {
+ private ResponseEntity handleError( HttpServletRequest request, String message, HttpStatus status) {
logResult(request, status);
- return Response.status(status).entity(message).type(MediaType.APPLICATION_JSON).build();
+ return ResponseEntity.status(status).contentType ( MediaType.APPLICATION_JSON ).body(message);
}
- void logResult(HttpServletRequest request, Response.Status status) {
+ void logResult(HttpServletRequest request, HttpStatus status) {
- logger.info(SearchDbMsgs.PROCESS_REST_REQUEST, (request != null) ? request.getMethod() : "",
- (request != null) ? request.getRequestURL().toString() : "",
- (request != null) ? request.getRemoteHost() : "", Integer.toString(status.getStatusCode()));
+ logger.info(SearchDbMsgs.PROCESS_REST_REQUEST, (request != null) ? request.getMethod().toString () : "",
+ (request != null) ? request.getRequestURL ().toString () : "",
+ (request != null) ? request.getRemoteHost () : "", Integer.toString(status.value ()));
auditLogger.info(SearchDbMsgs.PROCESS_REST_REQUEST,
new LogFields()
- .setField(LogLine.DefinedFields.RESPONSE_CODE, status.getStatusCode())
+ .setField(LogLine.DefinedFields.RESPONSE_CODE, status.value())
.setField(LogLine.DefinedFields.RESPONSE_DESCRIPTION, status.getReasonPhrase()),
- (request != null) ? request.getMethod() : "",
- (request != null) ? request.getRequestURL().toString() : "",
- (request != null) ? request.getRemoteHost() : "", Integer.toString(status.getStatusCode()));
+ (request != null) ? request.getMethod().toString () : "",
+ (request != null) ? request.getRequestURL ().toString () : "",
+ (request != null) ? request.getRemoteHost () : "", Integer.toString(status.value()));
// Clear the MDC context so that no other transaction inadvertently
// uses our transaction id.