2 * ============LICENSE_START=======================================================
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.aai.sparky.util;
23 import javax.servlet.http.HttpServletResponse;
25 import org.onap.aai.cl.api.Logger;
26 import org.onap.aai.restclient.client.OperationResult;
27 import org.onap.aai.sparky.logging.AaiUiMsgs;
28 import org.onap.aai.sparky.search.SearchServiceAdapter;
29 import org.restlet.Response;
30 import org.restlet.data.MediaType;
31 import org.restlet.data.Status;
33 public class RestletUtils {
35 * Returns an HttpServletResponse based on values from a Restlet Response
37 * @param restletResponse Restlet Response to be converted to an HttpServletResponse
38 * @return An HttpServletResponse object built from the values of a Restlet Response
40 public HttpServletResponse convertRestletResponseToHttpServletResponse(Response restletResponse) {
41 return org.restlet.ext.servlet.ServletUtils.getResponse(restletResponse);
47 * @param logger The logger
48 * @param search The searchAdapter
49 * @param response The response
50 * @param requestUrl The request URL
51 * @param requestJsonPayload The request JSON payload
52 * @return The operation result
54 public OperationResult executePostQuery(Logger logger, SearchServiceAdapter search,
55 Response response, String requestUrl, String requestJsonPayload) {
57 OperationResult opResult = search.doPost(requestUrl, requestJsonPayload);
59 if (opResult.getResultCode() > 300) {
60 setRestletResponse(logger, true, opResult.getResultCode(), response, opResult.getResult());
62 response.setStatus(new Status(opResult.getResultCode()));
69 * Generate JSON error response
71 * @param message The error message
72 * @return The error message formatted as a JSON string
74 public String generateJsonErrorResponse(String message) {
75 return String.format("{ \"errorMessage\" : \"%s\" }", message);
79 * Log Restlet exceptions/errors & prepare Response object with exception/errors info
81 * @param logger The logger
82 * @param errorMsg The error message
83 * @param exc The exception
84 * @param response The response
86 public void handleRestletErrors(Logger logger, String errorMsg, Exception exc,
88 String errorLogMsg = (exc == null ? errorMsg : errorMsg + ". Error:" + exc.getLocalizedMessage());
89 logger.error(AaiUiMsgs.ERROR_GENERIC, errorLogMsg);
90 response.setEntity(generateJsonErrorResponse(errorMsg), MediaType.APPLICATION_JSON);
94 * Sets the Restlet response
96 * @param logger The logger
97 * @param isError The error
98 * @param responseCode The response code
99 * @param response The response
100 * @param postPayload The post payload
102 public void setRestletResponse(Logger logger, boolean isError, int responseCode,
103 Response response, String postPayload) {
106 logger.error(AaiUiMsgs.ERROR_GENERIC, postPayload);
109 response.setStatus(new Status(responseCode));
111 if (postPayload != null) {
112 response.setEntity(postPayload, MediaType.APPLICATION_JSON);