diff options
Diffstat (limited to 'ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client')
3 files changed, 89 insertions, 139 deletions
diff --git a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/HttpStatusAndResponse.java b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/HttpStatusAndResponse.java index 7caba3d8..47a35d4f 100644 --- a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/HttpStatusAndResponse.java +++ b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/HttpStatusAndResponse.java @@ -6,7 +6,7 @@ * =================================================================== * * Unless otherwise specified, all software contained herein is licensed - * under the Apache License, Version 2.0 (the “License”); + * under the Apache License, Version 2.0 (the "License"); * you may not use this software except in compliance with the License. * You may obtain a copy of the License at * @@ -19,7 +19,7 @@ * limitations under the License. * * Unless otherwise specified, all documentation contained herein is licensed - * under the Creative Commons License, Attribution 4.0 Intl. (the “License”); + * under the Creative Commons License, Attribution 4.0 Intl. (the "License"); * you may not use this documentation except in compliance with the License. * You may obtain a copy of the License at * diff --git a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/PortalRestClientBase.java b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/PortalRestClientBase.java index 5ccb715b..2c4da43d 100644 --- a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/PortalRestClientBase.java +++ b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/PortalRestClientBase.java @@ -6,7 +6,7 @@ * =================================================================== * * Unless otherwise specified, all software contained herein is licensed - * under the Apache License, Version 2.0 (the “License”); + * under the Apache License, Version 2.0 (the "License"); * you may not use this software except in compliance with the License. * You may obtain a copy of the License at * @@ -19,7 +19,7 @@ * limitations under the License. * * Unless otherwise specified, all documentation contained herein is licensed - * under the Creative Commons License, Attribution 4.0 Intl. (the “License”); + * under the Creative Commons License, Attribution 4.0 Intl. (the "License"); * you may not use this documentation except in compliance with the License. * You may obtain a copy of the License at * @@ -39,13 +39,9 @@ package org.onap.portalsdk.core.restful.client; import java.io.IOException; import java.net.URI; -import java.net.URISyntaxException; - -import javax.servlet.http.HttpServletResponse; import org.apache.http.Consts; import org.apache.http.HttpEntity; -import org.apache.http.client.ClientProtocolException; import org.apache.http.client.methods.CloseableHttpResponse; import org.apache.http.client.methods.HttpGet; import org.apache.http.client.methods.HttpPost; @@ -56,6 +52,7 @@ import org.apache.http.impl.client.HttpClients; import org.apache.http.util.EntityUtils; import org.onap.portalsdk.core.domain.App; import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; +import org.onap.portalsdk.core.onboarding.exception.CipherUtilException; import org.onap.portalsdk.core.onboarding.util.CipherUtil; import org.onap.portalsdk.core.onboarding.util.PortalApiConstants; import org.onap.portalsdk.core.onboarding.util.PortalApiProperties; @@ -80,7 +77,7 @@ public class PortalRestClientBase { private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(PortalRestClientBase.class); @Autowired - AppService appService; + private AppService appService; /** * Constructs and sends a GET request for the URI, with REST application @@ -89,47 +86,45 @@ public class PortalRestClientBase { * @param uri * URI of the service * @return Result of the get; null if an error happens - * @throws Exception + * @throws CipherUtilException + * If the app password cannot be decrypted + * @throws IOException + * If the remote end cannot be contacted */ - public HttpStatusAndResponse getRestWithCredentials(final URI uri) throws Exception { + public HttpStatusAndResponse getRestWithCredentials(final URI uri) throws CipherUtilException, IOException { String uebKey = PortalApiProperties.getProperty(PortalApiConstants.UEB_APP_KEY); App app = appService.getDefaultApp(); if (uebKey == null || app == null || app.getUsername() == null || app.getAppPassword() == null) - throw new IllegalArgumentException("Missing one or more required properties and/or database entries"); + throw new IllegalArgumentException( + "getRestWithCredentials: Missing one or more required properties and/or database entries"); String decryptedPassword = CipherUtil.decrypt(app.getAppPassword()); CloseableHttpClient httpClient = HttpClients.createDefault(); HttpGet httpGet = new HttpGet(uri); httpGet.setHeader("uebkey", uebKey); httpGet.setHeader("username", app.getUsername()); httpGet.setHeader("password", decryptedPassword); - String responseJson = null; CloseableHttpResponse response = null; + logger.info(EELFLoggerDelegate.debugLogger, "getRestWithCredentials: URL {}", uri); try { - logger.info(EELFLoggerDelegate.debugLogger, "GET from " + uri); response = httpClient.execute(httpGet); - logger.info(EELFLoggerDelegate.debugLogger, "Status is " + response.getStatusLine()); - if (response.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) - logger.info(EELFLoggerDelegate.debugLogger, "Status is " + response.getStatusLine().toString()); + logger.debug(EELFLoggerDelegate.debugLogger, "getRestWithCredentials: status " + response.getStatusLine()); HttpEntity entity = response.getEntity(); if (entity == null) { - logger.info(EELFLoggerDelegate.debugLogger, "Entity is null!"); + logger.debug(EELFLoggerDelegate.debugLogger, "getRestWithCredentials: entity is null!"); } else { // entity content length is never set. // this naively tries to read everything. responseJson = EntityUtils.toString(entity); - logger.info(EELFLoggerDelegate.debugLogger, responseJson); + logger.debug(EELFLoggerDelegate.debugLogger, "getRestWithCredentials: JSON {}", responseJson); EntityUtils.consume(entity); } } finally { if (response != null) response.close(); - if (httpClient != null) - httpClient.close(); } - if (response == null) - return null; + httpClient.close(); return new HttpStatusAndResponse(response.getStatusLine().getStatusCode(), responseJson); } @@ -142,49 +137,49 @@ public class PortalRestClientBase { * @param json * Content to post * @return Result of the post; null if an error happens - * @throws Exception + * @throws CipherUtilException + * If the app password cannot be decrypted + * @throws IOException + * If the remote end cannot be contacted */ - public HttpStatusAndResponse postRestWithCredentials(final URI uri, final String json) throws Exception { + public HttpStatusAndResponse postRestWithCredentials(final URI uri, final String json) + throws CipherUtilException, IOException { String uebKey = PortalApiProperties.getProperty(PortalApiConstants.UEB_APP_KEY); App app = appService.getDefaultApp(); if (uebKey == null || app == null || app.getUsername() == null || app.getAppPassword() == null) - throw new Exception("Missing one or more required properties and/or database entries"); - + throw new IllegalArgumentException( + "postRestWithCredentials: missing one or more required properties and/or database entries"); + String decryptedPassword = CipherUtil.decrypt(app.getAppPassword()); CloseableHttpClient httpClient = HttpClients.createDefault(); HttpPost httpPost = new HttpPost(uri); httpPost.setHeader("uebkey", uebKey); httpPost.setHeader("username", app.getUsername()); - httpPost.setHeader("password", app.getAppPassword()); - + httpPost.setHeader("password", decryptedPassword); StringEntity postEntity = new StringEntity(json, ContentType.create("application/json", Consts.UTF_8)); httpPost.setEntity(postEntity); - String responseJson = null; CloseableHttpResponse response = null; try { - logger.info(EELFLoggerDelegate.debugLogger, "POST to " + uri); + logger.debug(EELFLoggerDelegate.debugLogger, "postRestWithCredentials: POST to {}", uri); response = httpClient.execute(httpPost); - logger.info(EELFLoggerDelegate.debugLogger, "Status is " + response.getStatusLine()); - if (response.getStatusLine().getStatusCode() != HttpServletResponse.SC_OK) - throw new Exception("Status is " + response.getStatusLine().toString()); - + logger.debug(EELFLoggerDelegate.debugLogger, "postRestWithCredentials: status {} ", + response.getStatusLine()); HttpEntity entity = response.getEntity(); if (entity == null) { - logger.info(EELFLoggerDelegate.debugLogger, "Entity is null!"); + logger.debug(EELFLoggerDelegate.debugLogger, "postRestWithCredentials: entity is null!"); } else { // entity content length is never set. // this naively tries to read everything. responseJson = EntityUtils.toString(entity); - logger.info(EELFLoggerDelegate.debugLogger, responseJson); + logger.debug(EELFLoggerDelegate.debugLogger, "postRestWithCredentials: JSON {}", responseJson); EntityUtils.consume(entity); } } finally { if (response != null) response.close(); - if (httpClient != null) - httpClient.close(); } + httpClient.close(); return new HttpStatusAndResponse(response.getStatusLine().getStatusCode(), responseJson); } diff --git a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/SharedContextRestClient.java b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/SharedContextRestClient.java index 89ebbe5a..e58a1957 100644 --- a/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/SharedContextRestClient.java +++ b/ecomp-sdk/epsdk-core/src/main/java/org/onap/portalsdk/core/restful/client/SharedContextRestClient.java @@ -6,7 +6,7 @@ * =================================================================== * * Unless otherwise specified, all software contained herein is licensed - * under the Apache License, Version 2.0 (the “License”); + * under the Apache License, Version 2.0 (the "License"); * you may not use this software except in compliance with the License. * You may obtain a copy of the License at * @@ -19,7 +19,7 @@ * limitations under the License. * * Unless otherwise specified, all documentation contained herein is licensed - * under the Creative Commons License, Attribution 4.0 Intl. (the “License”); + * under the Creative Commons License, Attribution 4.0 Intl. (the "License"); * you may not use this documentation except in compliance with the License. * You may obtain a copy of the License at * @@ -37,23 +37,23 @@ */ package org.onap.portalsdk.core.restful.client; +import java.io.IOException; import java.net.URI; +import java.net.URISyntaxException; +import java.util.ArrayList; import java.util.HashMap; import java.util.List; import org.apache.http.client.utils.URIBuilder; import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate; +import org.onap.portalsdk.core.onboarding.exception.CipherUtilException; import org.onap.portalsdk.core.onboarding.util.PortalApiConstants; import org.onap.portalsdk.core.onboarding.util.PortalApiProperties; import org.onap.portalsdk.core.restful.domain.SharedContext; -import org.onap.portalsdk.core.util.SystemProperties; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; -import com.fasterxml.jackson.core.JsonParseException; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.core.type.TypeReference; -import com.fasterxml.jackson.databind.JsonMappingException; import com.fasterxml.jackson.databind.ObjectMapper; /** @@ -82,13 +82,13 @@ public class SharedContextRestClient extends PortalRestClientBase { * Builds the URl for the shared context service using the portal.properties * value for the AUXAPI endpoint. * - * @throws Exception - * if the ECOMP_REST_URL property is not found + * @throws IllegalArgumentException + * if the ECOMP_REST_URL property is not found */ - private String getSharedContextUrl() throws Exception { + private String getSharedContextUrl() throws IllegalArgumentException { String restUrl = PortalApiProperties.getProperty(PortalApiConstants.ECOMP_REST_URL); if (restUrl == null || restUrl.length() == 0) - throw new Exception("getSharedContextUrl: no property " + PortalApiConstants.ECOMP_REST_URL); + throw new IllegalArgumentException("getSharedContextUrl: no property " + PortalApiConstants.ECOMP_REST_URL); String contextUrl = restUrl + (restUrl.endsWith("/") ? "" : "/") + "context/"; return contextUrl; } @@ -102,6 +102,7 @@ public class SharedContextRestClient extends PortalRestClientBase { * Key for the shared-context entry; e.g., "lastName" * @return SharedContext object; null if not found. * @throws Exception + * If URI cannot be built, host cannot be reached, etc. */ public SharedContext getContextValue(String contextId, String key) throws Exception { HttpStatusAndResponse hsr = getContext("get", contextId, key); @@ -110,16 +111,8 @@ public class SharedContextRestClient extends PortalRestClientBase { logger.error(EELFLoggerDelegate.applicationLogger, "getContextValue: unexpected null response"); return null; } - SharedContext jsonObj = null; - try { - jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "getContextValue: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.info(EELFLoggerDelegate.applicationLogger, - "getContextValue: failed to parse response" + ex.getMessage()); - } + SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); + // Response means no data. if (jsonObj != null && jsonObj.getResponse() != null) return null; return jsonObj; @@ -130,37 +123,28 @@ public class SharedContextRestClient extends PortalRestClientBase { * * @param contextId * An Ecomp Portal session ID - * @return List of SharedContext objects corresponding to the following - * keys: USER_FIRST_NAME, USER_LAST_NAME, USER_EMAIL and - * USER_ORGUSERID; empty if none were found; null if an error - * happens. + * @return List of SharedContext objects corresponding to the following keys: + * USER_FIRST_NAME, USER_LAST_NAME, USER_EMAIL and USER_ORGUSERID; empty + * if none were found; null if an error happens. * @throws Exception + * If URI cannot be built, host cannot be reached, etc. */ public List<SharedContext> getUserContext(String contextId) throws Exception { HttpStatusAndResponse hsr = getContext("get_user", contextId, null); logger.info(EELFLoggerDelegate.debugLogger, "getUserContext: resp is " + hsr); if (hsr == null) { logger.error(EELFLoggerDelegate.applicationLogger, "getUserContext: unexpected null response"); - return null; - } - List<SharedContext> jsonList = null; - try { - TypeReference<List<SharedContext>> typeRef = new TypeReference<List<SharedContext>>() { - }; - jsonList = mapper.readValue(hsr.getResponse(), typeRef); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "getUserContext: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "getUserContext: failed to parse response" + ex.getMessage()); + return new ArrayList<>(); } + TypeReference<List<SharedContext>> typeRef = new TypeReference<List<SharedContext>>() { + }; + List<SharedContext> jsonList = mapper.readValue(hsr.getResponse(), typeRef); return jsonList; } /** - * Checks whether a shared-context entry exists for the specified context ID - * and key. + * Checks whether a shared-context entry exists for the specified context ID and + * key. * * @param contextId * An Ecomp Portal session ID @@ -168,6 +152,7 @@ public class SharedContextRestClient extends PortalRestClientBase { * Key for the shared-context entry; e.g., "lastName" * @return True if the object exists, false otherwise; null on error. * @throws Exception + * If URI cannot be built, host cannot be reached, etc. */ public Boolean checkSharedContext(String contextId, String key) throws Exception { HttpStatusAndResponse hsr = getContext("check", contextId, key); @@ -176,20 +161,11 @@ public class SharedContextRestClient extends PortalRestClientBase { logger.error(EELFLoggerDelegate.applicationLogger, "checkSharedContext: unexpected null response"); return null; } - String response = null; - try { - SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); - response = jsonObj.getResponse(); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "checkSharedContext: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "checkSharedContext: failed to parse response" + ex.getMessage()); - } + SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); + String response = jsonObj.getResponse(); if (response == null) return null; - return ("exists".equals(response)); + return "exists".equals(response); } /** @@ -201,6 +177,7 @@ public class SharedContextRestClient extends PortalRestClientBase { * Key for the shared-context entry; e.g., "lastName" * @return True if the entry was removed, false otherwise; null on error. * @throws Exception + * If URI cannot be built, host cannot be reached, etc. */ public Boolean removeSharedContext(String contextId, String key) throws Exception { HttpStatusAndResponse hsr = getContext("remove", contextId, key); @@ -209,20 +186,11 @@ public class SharedContextRestClient extends PortalRestClientBase { logger.error(EELFLoggerDelegate.applicationLogger, "removeSharedContext: unexpected null response"); return null; } - SharedContext jsonObj = null; - try { - jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "removeSharedContext: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "removeSharedContext: failed to parse response" + ex.getMessage()); - } + SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); if (jsonObj == null) return null; String response = jsonObj.getResponse(); - return ("removed".equals(response)); + return "removed".equals(response); } /** @@ -231,9 +199,10 @@ public class SharedContextRestClient extends PortalRestClientBase { * * @param contextId * An Ecomp Portal session ID - * @return Number of key-value pairs removed; -1 if not found or any - * problems occur. + * @return Number of key-value pairs removed; -1 if not found or any problems + * occur. * @throws Exception + * If URI cannot be built, host cannot be reached, etc. */ public int clearSharedContext(String contextId) throws Exception { HttpStatusAndResponse hsr = getContext("remove", contextId, null); @@ -242,16 +211,7 @@ public class SharedContextRestClient extends PortalRestClientBase { logger.error(EELFLoggerDelegate.applicationLogger, "clearSharedContext: unexpected null response"); return -1; } - SharedContext jsonObj = null; - try { - jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "clearSharedContext: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "clearSharedContext: failed to parse response" + ex.getMessage()); - } + SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); if (jsonObj == null) return -1; String response = jsonObj.getResponse(); @@ -269,9 +229,10 @@ public class SharedContextRestClient extends PortalRestClientBase { * Key for the shared-context entry; e.g., "lastName" * @param value * Value for the entry + * @return True if the object previously existed, false otherwise; null if any + * problem happened. * @throws Exception - * @return True if the object previously existed, false otherwise; null if - * any problem happened. + * If URI cannot be built, host cannot be reached, etc. */ public Boolean setSharedContext(String contextId, String key, String value) throws Exception { String body = buildContext(contextId, key, value); @@ -281,33 +242,28 @@ public class SharedContextRestClient extends PortalRestClientBase { logger.error(EELFLoggerDelegate.applicationLogger, "setSharedContext: unexpected null response"); return null; } - SharedContext jsonObj = null; - try { - jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); - } catch (JsonMappingException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "setSharedContext: failed to map response onto object" + ex.getMessage()); - } catch (JsonParseException ex) { - logger.error(EELFLoggerDelegate.applicationLogger, - "setSharedContext: failed to parse response" + ex.getMessage()); - } + SharedContext jsonObj = mapper.readValue(hsr.getResponse(), SharedContext.class); if (jsonObj == null) return null; String response = jsonObj.getResponse(); - return ("replaced".equals(response)); + return "replaced".equals(response); } /** - * Builds the full URL with the specified parameters, then calls the method - * that adds credentials and GETs. + * Builds the full URL with the specified parameters, then calls the method that + * adds credentials and GETs. * * @param requestPath * @param contextId * @param contextKey * @return HttpStatusAndResponse object; may be null. - * @throws Exception + * @throws URISyntaxException + * @throws IllegalArgumentException + * @throws IOException + * @throws CipherUtilException */ - private HttpStatusAndResponse getContext(String requestPath, String contextId, String contextKey) throws Exception { + private HttpStatusAndResponse getContext(String requestPath, String contextId, String contextKey) + throws IllegalArgumentException, URISyntaxException, CipherUtilException, IOException { URIBuilder uriBuilder = new URIBuilder(getSharedContextUrl() + requestPath); uriBuilder.addParameter("context_id", contextId); if (contextKey != null) @@ -317,16 +273,19 @@ public class SharedContextRestClient extends PortalRestClientBase { } /** - * Builds the full URL, then calls the method that adds credentials and - * POSTs. + * Builds the full URL, then calls the method that adds credentials and POSTs. * * @param requestPath * @param contextId * @param contextKey * @return HttpStatusAndResponse object; may be null. - * @throws Exception + * @throws IOException + * @throws CipherUtilException + * @throws URISyntaxException + * @throws IllegalArgumentException */ - private HttpStatusAndResponse postContext(String requestPath, String json) throws Exception { + private HttpStatusAndResponse postContext(String requestPath, String json) + throws CipherUtilException, IOException, IllegalArgumentException, URISyntaxException { URIBuilder uriBuilder = new URIBuilder(getSharedContextUrl() + requestPath); URI uri = uriBuilder.build(); return postRestWithCredentials(uri, json); @@ -344,8 +303,7 @@ public class SharedContextRestClient extends PortalRestClientBase { * @return JSON block */ private String buildContext(String cxid, String ckey, String cvalue) throws JsonProcessingException { - ObjectMapper mapper = new ObjectMapper(); - HashMap<String, String> stringMap = new HashMap<String, String>(); + HashMap<String, String> stringMap = new HashMap<>(); stringMap.put("context_id", cxid); stringMap.put("ckey", ckey); stringMap.put("cvalue", cvalue); @@ -355,9 +313,6 @@ public class SharedContextRestClient extends PortalRestClientBase { // Simple test scaffold public static void main(String[] args) throws Exception { - // ObjectMapper mapper = new ObjectMapper(); - // SharedContext cxt = mapper.readValue("{ \"response\":\"foo\" }", - // SharedContext.class); SharedContextRestClient client = new SharedContextRestClient(); SharedContext get = client.getContextValue("abc", "123"); System.out.println("Get yields " + get.toString()); |