2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017 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 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.onap.aai.sparky.util;
25 import javax.servlet.http.HttpServletResponse;
27 import org.onap.aai.cl.api.Logger;
28 import org.onap.aai.restclient.client.OperationResult;
29 import org.onap.aai.sparky.logging.AaiUiMsgs;
30 import org.onap.aai.sparky.search.SearchServiceAdapter;
31 import org.restlet.Response;
32 import org.restlet.data.MediaType;
33 import org.restlet.data.Status;
35 public class RestletUtils {
37 * Returns an HttpServletResponse based on values from a Restlet Response
39 * @param restletResponse Restlet Response to be converted to an HttpServletResponse
40 * @return An HttpServletResponse object built from the values of a Restlet Response
42 public HttpServletResponse convertRestletResponseToHttpServletResponse(Response restletResponse) {
43 return org.restlet.ext.servlet.ServletUtils.getResponse(restletResponse);
49 * @param logger The logger
50 * @param search The searchAdapter
51 * @param response The response
52 * @param requestUrl The request URL
53 * @param requestJsonPayload The request JSON payload
54 * @return The operation result
56 public OperationResult executePostQuery(Logger logger, SearchServiceAdapter search,
57 Response response, String requestUrl, String requestJsonPayload) {
59 OperationResult opResult = search.doPost(requestUrl, requestJsonPayload, "application/json");
61 if (opResult.getResultCode() > 300) {
62 setRestletResponse(logger, true, opResult.getResultCode(), response, opResult.getResult());
64 response.setStatus(new Status(opResult.getResultCode()));
71 * Generate JSON error response
73 * @param message The error message
74 * @return The error message formatted as a JSON string
76 public String generateJsonErrorResponse(String message) {
77 return String.format("{ \"errorMessage\" : \"%s\" }", message);
81 * Log Restlet exceptions/errors & prepare Response object with exception/errors info
83 * @param logger The logger
84 * @param errorMsg The error message
85 * @param exc The exception
86 * @param response The response
88 public void handleRestletErrors(Logger logger, String errorMsg, Exception exc,
90 String errorLogMsg = (exc == null ? errorMsg : errorMsg + ". Error:" + exc.getLocalizedMessage());
91 logger.error(AaiUiMsgs.ERROR_GENERIC, errorLogMsg);
92 response.setEntity(generateJsonErrorResponse(errorMsg), MediaType.APPLICATION_JSON);
96 * Sets the Restlet response
98 * @param logger The logger
99 * @param isError The error
100 * @param responseCode The response code
101 * @param response The response
102 * @param postPayload The post payload
104 public void setRestletResponse(Logger logger, boolean isError, int responseCode,
105 Response response, String postPayload) {
108 logger.error(AaiUiMsgs.ERROR_GENERIC, postPayload);
111 response.setStatus(new Status(responseCode));
113 if (postPayload != null) {
114 response.setEntity(postPayload, MediaType.APPLICATION_JSON);