sparkybe-onap-service/src/main/java/org/onap/aai/sparky/util/RestletUtils.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   8  * ============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=====================================================
  21  *
  22  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25 package org.onap.aai.sparky.util;
  26
  27 import javax.servlet.http.HttpServletResponse;
  28
  29 import org.onap.aai.cl.api.Logger;
  30 import org.onap.aai.restclient.client.OperationResult;
  31 import org.onap.aai.sparky.logging.AaiUiMsgs;
  32 import org.onap.aai.sparky.search.SearchServiceAdapter;
  33 import org.restlet.Response;
  34 import org.restlet.data.MediaType;
  35 import org.restlet.data.Status;
  36
  37 public class RestletUtils {
  38   /**
  39    * Returns an HttpServletResponse based on values from a Restlet Response
  40    *
  41    * @param restletResponse Restlet Response to be converted to an HttpServletResponse
  42    * @return An HttpServletResponse object built from the values of a Restlet Response
  43    */
  44   public HttpServletResponse convertRestletResponseToHttpServletResponse(Response restletResponse) {
  45     return org.restlet.ext.servlet.ServletUtils.getResponse(restletResponse);
  46   }
  47
  48   /**
  49    * Execute post query
  50    *
  51    * @param logger The logger
  52    * @param search The searchAdapter
  53    * @param response The response
  54    * @param requestUrl The request URL
  55    * @param requestJsonPayload The request JSON payload
  56    * @return The operation result
  57    */
  58   public OperationResult executePostQuery(Logger logger, SearchServiceAdapter search,
  59       Response response, String requestUrl, String requestJsonPayload) {
  60
  61     OperationResult opResult = search.doPost(requestUrl, requestJsonPayload, "application/json");
  62
  63     if (opResult.getResultCode() > 300) {
  64       setRestletResponse(logger, true, opResult.getResultCode(), response, opResult.getResult());
  65     } else {
  66       response.setStatus(new Status(opResult.getResultCode()));
  67     }
  68
  69     return opResult;
  70   }
  71
  72   /**
  73    * Generate JSON error response
  74    *
  75    * @param message The error message
  76    * @return The error message formatted as a JSON string
  77    */
  78   public String generateJsonErrorResponse(String message) {
  79     return String.format("{ \"errorMessage\" : \"%s\" }", message);
  80   }
  81
  82   /**
  83    * Log Restlet exceptions/errors & prepare Response object with exception/errors info
  84    *
  85    * @param logger The logger
  86    * @param errorMsg The error message
  87    * @param exc The exception
  88    * @param response The response
  89    */
  90   public void handleRestletErrors(Logger logger, String errorMsg, Exception exc,
  91     Response response) {
  92     String errorLogMsg = (exc == null ? errorMsg : errorMsg + ". Error:" + exc.getLocalizedMessage());
  93     logger.error(AaiUiMsgs.ERROR_GENERIC, errorLogMsg);
  94     response.setEntity(generateJsonErrorResponse(errorMsg), MediaType.APPLICATION_JSON);
  95   }
  96
  97   /**
  98    * Sets the Restlet response
  99    *
 100    * @param logger The logger
 101    * @param isError The error
 102    * @param responseCode The response code
 103    * @param response The response
 104    * @param postPayload The post payload
 105    */
 106   public void setRestletResponse(Logger logger, boolean isError, int responseCode,
 107       Response response, String postPayload) {
 108
 109     if (isError) {
 110       logger.error(AaiUiMsgs.ERROR_GENERIC, postPayload);
 111     }
 112
 113     response.setStatus(new Status(responseCode));
 114
 115     if (postPayload != null) {
 116       response.setEntity(postPayload, MediaType.APPLICATION_JSON);
 117     }
 118   }
 119 }