From 5c37ec59dcc9f4dbb6baa3434ba5986d86ff7152 Mon Sep 17 00:00:00 2001 From: Vidyashree Rama Date: Mon, 22 Apr 2019 09:40:50 +0530 Subject: Fix Checkstyle issues Fix Checkstyle issues Issue-ID: CLAMP-328 Change-Id: Ic03e0a00094a5de8b592ecd3ce3b9ae0ecdb59f8 Signed-off-by: Vidyashree Rama --- src/main/java/org/onap/clamp/clds/Application.java | 3 +- .../clamp/clds/client/DcaeDispatcherServices.java | 5 +- .../clamp/clds/client/DcaeInventoryServices.java | 6 +- src/main/java/org/onap/clamp/clds/dao/CldsDao.java | 16 ++-- .../onap/clamp/clds/filter/ClampCadiFilter.java | 1 + .../org/onap/clamp/clds/model/CldsTemplate.java | 2 +- .../clamp/clds/model/CldsToscaModelDetails.java | 3 +- .../clamp/clds/model/CldsToscaModelRevision.java | 3 +- .../clds/model/properties/ModelProperties.java | 10 ++- .../clamp/clds/model/properties/PolicyItem.java | 6 +- .../org/onap/clamp/clds/model/sdc/SdcResource.java | 27 +++--- .../clamp/clds/model/sdc/SdcResourceBasicInfo.java | 27 +++--- .../onap/clamp/clds/model/sdc/SdcServiceInfo.java | 27 +++--- .../controller/installer/BlueprintArtifact.java | 8 +- .../sdc/controller/installer/BlueprintParser.java | 1 + .../clds/sdc/controller/installer/CsarHandler.java | 6 +- .../sdc/controller/installer/MicroService.java | 6 +- .../clamp/clds/tosca/ToscaYamlToJsonConvertor.java | 21 +++-- .../onap/clamp/clds/transform/XslTransformer.java | 10 ++- .../org/onap/clamp/clds/util/ClampVersioning.java | 7 +- .../java/org/onap/clamp/clds/util/CryptoUtils.java | 18 ++-- .../java/org/onap/clamp/clds/util/LogMessages.java | 3 +- .../org/onap/clamp/clds/util/LoggingUtils.java | 99 ++++++++++++---------- .../java/org/onap/clamp/clds/util/XmlTools.java | 17 +++- .../onap/clamp/clds/util/drawing/ClampGraph.java | 7 +- .../clamp/clds/util/drawing/ClampGraphBuilder.java | 8 +- .../onap/clamp/clds/util/drawing/ImageBuilder.java | 33 ++++---- .../org/onap/clamp/clds/util/drawing/Painter.java | 6 ++ 28 files changed, 237 insertions(+), 149 deletions(-) (limited to 'src/main/java') diff --git a/src/main/java/org/onap/clamp/clds/Application.java b/src/main/java/org/onap/clamp/clds/Application.java index 025dbabda..c144a1464 100644 --- a/src/main/java/org/onap/clamp/clds/Application.java +++ b/src/main/java/org/onap/clamp/clds/Application.java @@ -135,7 +135,8 @@ public class Application extends SpringBootServletInitializer { private Connector createRedirectConnector(int redirectSecuredPort) { if (redirectSecuredPort <= 0) { eelfLogger.warn( - "HTTP port redirection to HTTPS is disabled because the HTTPS port is 0 (random port) or -1 (Connector disabled)"); + "HTTP port redirection to HTTPS is disabled because the HTTPS port is 0 (random port) or -1" + + " (Connector disabled)"); return null; } Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol"); diff --git a/src/main/java/org/onap/clamp/clds/client/DcaeDispatcherServices.java b/src/main/java/org/onap/clamp/clds/client/DcaeDispatcherServices.java index f74af49f8..1ea4c4b93 100644 --- a/src/main/java/org/onap/clamp/clds/client/DcaeDispatcherServices.java +++ b/src/main/java/org/onap/clamp/clds/client/DcaeDispatcherServices.java @@ -99,7 +99,9 @@ public class DcaeDispatcherServices { Date startTime = new Date(); LoggingUtils.setTargetContext("DCAE", "getOperationStatus"); try { - String responseStr = dcaeHttpConnectionManager.doHttpRequest(statusUrl, "GET", null, null, "DCAE", null, null); + String responseStr = dcaeHttpConnectionManager.doHttpRequest(statusUrl, "GET", null, + null, "DCAE", null, + null); JSONObject jsonObj = parseResponse(responseStr); String operationType = (String) jsonObj.get("operationType"); String status = (String) jsonObj.get(DCAE_STATUS_FIELD); @@ -156,6 +158,7 @@ public class DcaeDispatcherServices { /*** * Returns status URL for deleteExistingDeployment operation. + * * @param deploymentId * The deployment ID * @param serviceTypeId diff --git a/src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java b/src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java index dcf05423b..7f209199d 100644 --- a/src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java +++ b/src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java @@ -70,7 +70,7 @@ public class DcaeInventoryServices { */ @Autowired public DcaeInventoryServices(ClampProperties refProp, CldsDao cldsDao, - HttpConnectionManager httpConnectionManager) { + HttpConnectionManager httpConnectionManager) { this.refProp = refProp; this.cldsDao = cldsDao; this.httpConnectionManager = httpConnectionManager; @@ -97,8 +97,8 @@ public class DcaeInventoryServices { } try { // Below are the properties required for calling the dcae inventory - ModelProperties prop = new ModelProperties(cldsModel.getName(), cldsModel.getControlName(), null, false, - "{}", cldsModel.getPropText()); + ModelProperties prop = new ModelProperties(cldsModel.getName(), cldsModel.getControlName(), null, + false, "{}", cldsModel.getPropText()); Global global = prop.getGlobal(); String invariantServiceUuid = global.getService(); List resourceUuidList = global.getResourceVf(); diff --git a/src/main/java/org/onap/clamp/clds/dao/CldsDao.java b/src/main/java/org/onap/clamp/clds/dao/CldsDao.java index 8378af8c5..1cff6bb26 100644 --- a/src/main/java/org/onap/clamp/clds/dao/CldsDao.java +++ b/src/main/java/org/onap/clamp/clds/dao/CldsDao.java @@ -507,14 +507,14 @@ public class CldsDao { SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT); List cldsToscaModels = new ArrayList<>(); - String toscaModelSql = new StringBuilder("SELECT tm.tosca_model_name, tm.tosca_model_id, tm.policy_type, " + - "tmr.tosca_model_revision_id, tmr.tosca_model_json, tmr.version, tmr.user_id, tmr.createdTimestamp, " + - "tmr.lastUpdatedTimestamp") - .append(toscaModelName != null ? (", tmr.tosca_model_yaml") : "") + String toscaModelSql = new StringBuilder("SELECT tm.tosca_model_name, tm.tosca_model_id, tm.policy_type, " + + "tmr.tosca_model_revision_id, tmr.tosca_model_json, tmr.version, tmr.user_id, tmr.createdTimestamp," + + "tmr.lastUpdatedTimestamp").append(toscaModelName != null ? (", tmr.tosca_model_yaml") : "") .append(" FROM tosca_model tm, tosca_model_revision tmr WHERE tm.tosca_model_id = tmr.tosca_model_id") .append(toscaModelName != null ? (" AND tm.tosca_model_name = '" + toscaModelName + "'") : "") .append(policyType != null ? (" AND tm.policy_type = '" + policyType + "'") : "") - .append(" AND tmr.version = (select max(version) from tosca_model_revision st where tmr.tosca_model_id=st.tosca_model_id)") + .append(" AND tmr.version = (select max(version) from tosca_model_revision st where tmr.tosca_model_id" + + "=st.tosca_model_id)") .toString(); List> rows = jdbcTemplateObject.queryForList(toscaModelSql); @@ -633,7 +633,7 @@ public class CldsDao { String whereFilter = " WHERE "; if (dictionaryName != null) { whereFilter += "dictionary_name = '" + dictionaryName + "'"; - if (dictionaryId != null){ + if (dictionaryId != null) { whereFilter += " AND dictionary_id = '" + dictionaryId + "'"; } } else if (dictionaryId != null) { @@ -641,8 +641,8 @@ public class CldsDao { } else { whereFilter = ""; } - String dictionarySql = new StringBuilder("SELECT dictionary_id, dictionary_name, created_by, " + - "modified_by, timestamp FROM dictionary") + String dictionarySql = new StringBuilder("SELECT dictionary_id, dictionary_name, created_by, " + + "modified_by, timestamp FROM dictionary") .append(whereFilter).toString(); List> rows = jdbcTemplateObject.queryForList(dictionarySql); diff --git a/src/main/java/org/onap/clamp/clds/filter/ClampCadiFilter.java b/src/main/java/org/onap/clamp/clds/filter/ClampCadiFilter.java index f058a9e6a..586899a13 100644 --- a/src/main/java/org/onap/clamp/clds/filter/ClampCadiFilter.java +++ b/src/main/java/org/onap/clamp/clds/filter/ClampCadiFilter.java @@ -20,6 +20,7 @@ * =================================================================== * */ + package org.onap.clamp.clds.filter; import com.att.eelf.configuration.EELFLogger; diff --git a/src/main/java/org/onap/clamp/clds/model/CldsTemplate.java b/src/main/java/org/onap/clamp/clds/model/CldsTemplate.java index 8f66204bb..8f3408375 100644 --- a/src/main/java/org/onap/clamp/clds/model/CldsTemplate.java +++ b/src/main/java/org/onap/clamp/clds/model/CldsTemplate.java @@ -73,7 +73,7 @@ public class CldsTemplate { * @param name The template name to retrieve * @param okIfNotFound * The flag indicating whether exception will be returned in case nothing is found - * @return + * @return Clds template from DB */ public static CldsTemplate retrieve(CldsDao cldsDao, String name, boolean okIfNotFound) { // get from db diff --git a/src/main/java/org/onap/clamp/clds/model/CldsToscaModelDetails.java b/src/main/java/org/onap/clamp/clds/model/CldsToscaModelDetails.java index a4ee734c7..4ee1debc3 100644 --- a/src/main/java/org/onap/clamp/clds/model/CldsToscaModelDetails.java +++ b/src/main/java/org/onap/clamp/clds/model/CldsToscaModelDetails.java @@ -27,8 +27,7 @@ import java.util.ArrayList; import java.util.List; /** - * Represents a CLDS Tosca model - * + * Represents a CLDS Tosca model. */ public class CldsToscaModelDetails { diff --git a/src/main/java/org/onap/clamp/clds/model/CldsToscaModelRevision.java b/src/main/java/org/onap/clamp/clds/model/CldsToscaModelRevision.java index 68cd49652..b9a7e0d58 100644 --- a/src/main/java/org/onap/clamp/clds/model/CldsToscaModelRevision.java +++ b/src/main/java/org/onap/clamp/clds/model/CldsToscaModelRevision.java @@ -22,8 +22,7 @@ */ /** - * Represents a CLDS Tosca model revision - * + * Represents a CLDS Tosca model revision. */ package org.onap.clamp.clds.model; diff --git a/src/main/java/org/onap/clamp/clds/model/properties/ModelProperties.java b/src/main/java/org/onap/clamp/clds/model/properties/ModelProperties.java index a880893ee..9b7f85d90 100644 --- a/src/main/java/org/onap/clamp/clds/model/properties/ModelProperties.java +++ b/src/main/java/org/onap/clamp/clds/model/properties/ModelProperties.java @@ -279,8 +279,8 @@ public class ModelProperties { /** * Replace all '-' with '_' within policy scope and name. * - * @param inName - * @return + * @param inName policy scope and name + * @return policy scope and name with "-" replaced with "_" */ private String normalizePolicyScopeName(String inName) { return inName.replaceAll("-", "_"); @@ -359,6 +359,12 @@ public class ModelProperties { return global; } + /** + * Registers model element. + * + * @param modelElementClass model element class + * @param type model element type + */ public static final synchronized void registerModelElement(Class modelElementClass, String type) { if (!modelElementClasses.containsKey(modelElementClass.getClass())) { diff --git a/src/main/java/org/onap/clamp/clds/model/properties/PolicyItem.java b/src/main/java/org/onap/clamp/clds/model/properties/PolicyItem.java index 6d766bec7..185546878 100644 --- a/src/main/java/org/onap/clamp/clds/model/properties/PolicyItem.java +++ b/src/main/java/org/onap/clamp/clds/model/properties/PolicyItem.java @@ -83,10 +83,10 @@ public class PolicyItem implements Cloneable { private String guardActiveEnd; /** - * Parse Policy given json node. + * Parse Policy given JSON node. * - * @param item - * @throws IOException + * @param item policy in JSON format + * @throws IOException IO exception */ public PolicyItem(JsonElement item) throws IOException { id = JsonUtils.getStringValueByName(item, "_id"); diff --git a/src/main/java/org/onap/clamp/clds/model/sdc/SdcResource.java b/src/main/java/org/onap/clamp/clds/model/sdc/SdcResource.java index 2474da073..515e77dfe 100644 --- a/src/main/java/org/onap/clamp/clds/model/sdc/SdcResource.java +++ b/src/main/java/org/onap/clamp/clds/model/sdc/SdcResource.java @@ -126,31 +126,38 @@ public class SdcResource implements Comparable { @Override public boolean equals(Object obj) { - if (this == obj) + if (this == obj) { return true; - if (obj == null) + } + if (obj == null) { return false; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; + } SdcResource other = (SdcResource) obj; if (resourceInstanceName == null) { - if (other.resourceInstanceName != null) + if (other.resourceInstanceName != null) { return false; - } else if (!resourceInstanceName.equals(other.resourceInstanceName)) + } + } else if (!resourceInstanceName.equals(other.resourceInstanceName)) { return false; + } if (resourceVersion == null) { - if (other.resourceVersion != null) + if (other.resourceVersion != null) { return false; - } else if (!resourceVersion.equals(other.resourceVersion)) + } + } else if (!resourceVersion.equals(other.resourceVersion)) { return false; + } return true; } /** - * Convert version String into a BigDecimal + * Convert version String into a BigDecimal. * - * @param versionText - * @return + * @param versionText version + * @return version in BigDecimal */ private BigDecimal convertVersion(String versionText) { BigDecimal rtn = BigDecimal.valueOf(0.0); diff --git a/src/main/java/org/onap/clamp/clds/model/sdc/SdcResourceBasicInfo.java b/src/main/java/org/onap/clamp/clds/model/sdc/SdcResourceBasicInfo.java index e853621b4..47192a540 100644 --- a/src/main/java/org/onap/clamp/clds/model/sdc/SdcResourceBasicInfo.java +++ b/src/main/java/org/onap/clamp/clds/model/sdc/SdcResourceBasicInfo.java @@ -71,31 +71,38 @@ public class SdcResourceBasicInfo implements Comparable { @Override public boolean equals(Object obj) { - if (this == obj) + if (this == obj) { return true; - if (obj == null) + } + if (obj == null) { return false; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; + } SdcResourceBasicInfo other = (SdcResourceBasicInfo) obj; if (name == null) { - if (other.name != null) + if (other.name != null) { return false; - } else if (!name.equals(other.name)) + } + } else if (!name.equals(other.name)) { return false; + } if (version == null) { - if (other.version != null) + if (other.version != null) { return false; - } else if (!version.equals(other.version)) + } + } else if (!version.equals(other.version)) { return false; + } return true; } /** - * Convert version String into a BigDecimal + * Convert version String into a BigDecimal. * - * @param version - * @return + * @param version version + * @return version in BigDecimal */ private BigDecimal convertVersion(String version) { BigDecimal rtn = BigDecimal.valueOf(0.0); diff --git a/src/main/java/org/onap/clamp/clds/model/sdc/SdcServiceInfo.java b/src/main/java/org/onap/clamp/clds/model/sdc/SdcServiceInfo.java index a9c1e64da..bb9f3f8a5 100644 --- a/src/main/java/org/onap/clamp/clds/model/sdc/SdcServiceInfo.java +++ b/src/main/java/org/onap/clamp/clds/model/sdc/SdcServiceInfo.java @@ -146,31 +146,38 @@ public class SdcServiceInfo implements Comparable { @Override public boolean equals(Object obj) { - if (this == obj) + if (this == obj) { return true; - if (obj == null) + } + if (obj == null) { return false; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; + } SdcServiceInfo other = (SdcServiceInfo) obj; if (name == null) { - if (other.name != null) + if (other.name != null) { return false; - } else if (!name.equals(other.name)) + } + } else if (!name.equals(other.name)) { return false; + } if (version == null) { - if (other.version != null) + if (other.version != null) { return false; - } else if (!version.equals(other.version)) + } + } else if (!version.equals(other.version)) { return false; + } return true; } /** - * Convert version String into a BigDecimal + * Convert version String into a BigDecimal. * - * @param versionText - * @return + * @param versionText version + * @return version in BigDecimal */ private BigDecimal convertVersion(String versionText) { try { diff --git a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintArtifact.java b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintArtifact.java index 6c7bfbb14..35bc909dc 100644 --- a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintArtifact.java +++ b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintArtifact.java @@ -20,15 +20,15 @@ * =================================================================== * */ -/** - * This class is useful to store the information concerning - * blueprint artifact extracted from SDC CSAR - */ package org.onap.clamp.clds.sdc.controller.installer; import org.onap.sdc.api.notification.IResourceInstance; +/** + * This class is useful to store the information concerning + * blueprint artifact extracted from SDC CSAR. + */ public class BlueprintArtifact { private String dcaeBlueprint; diff --git a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintParser.java b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintParser.java index 5a8ccca91..5dcffd61c 100644 --- a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintParser.java +++ b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintParser.java @@ -21,6 +21,7 @@ * =================================================================== * */ + package org.onap.clamp.clds.sdc.controller.installer; import com.google.gson.Gson; diff --git a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/CsarHandler.java b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/CsarHandler.java index 65d5592a8..5a21a1f8d 100644 --- a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/CsarHandler.java +++ b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/CsarHandler.java @@ -75,10 +75,10 @@ public class CsarHandler { public static final String DATA_DEFINITION_NAME_SUFFIX = "Definitions/data.yml"; public static final String DATA_DEFINITION_KEY = "data_types:"; - public CsarHandler(INotificationData iNotif, String controller, String clampCsarPath) throws CsarHandlerException { - this.sdcNotification = iNotif; + public CsarHandler(INotificationData data, String controller, String clampCsarPath) throws CsarHandlerException { + this.sdcNotification = data; this.controllerName = controller; - this.artifactElement = searchForUniqueCsar(iNotif); + this.artifactElement = searchForUniqueCsar(data); this.csarFilePath = buildFilePathForCsar(artifactElement, clampCsarPath); } diff --git a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/MicroService.java b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/MicroService.java index a785f41ef..ac4daeffb 100644 --- a/src/main/java/org/onap/clamp/clds/sdc/controller/installer/MicroService.java +++ b/src/main/java/org/onap/clamp/clds/sdc/controller/installer/MicroService.java @@ -21,6 +21,7 @@ * =================================================================== * */ + package org.onap.clamp.clds.sdc.controller.installer; import java.util.Objects; @@ -58,8 +59,9 @@ public class MicroService { @Override public String toString() { - return "MicroService{" + "name='" + name + '\'' + ", modelType='" + modelType + '\'' + ", inputFrom='" + inputFrom + '\'' + ", mappedNameJpa='" - + mappedNameJpa + '\'' + ", blueprintName='" + blueprintName + '\'' + '}'; + return "MicroService{" + "name='" + name + '\'' + ", modelType='" + modelType + '\'' + ", inputFrom='" + + inputFrom + '\'' + ", mappedNameJpa='" + mappedNameJpa + '\'' + ", blueprintName='" + + blueprintName + '\'' + '}'; } public String getMappedNameJpa() { diff --git a/src/main/java/org/onap/clamp/clds/tosca/ToscaYamlToJsonConvertor.java b/src/main/java/org/onap/clamp/clds/tosca/ToscaYamlToJsonConvertor.java index 16a817ea4..ea4e097f8 100644 --- a/src/main/java/org/onap/clamp/clds/tosca/ToscaYamlToJsonConvertor.java +++ b/src/main/java/org/onap/clamp/clds/tosca/ToscaYamlToJsonConvertor.java @@ -40,7 +40,7 @@ import org.yaml.snakeyaml.Yaml; /** * Tosca Model Yaml parser and convertor to JSON Schema consumable for JSON - * Editor + * Editor. * */ public class ToscaYamlToJsonConvertor { @@ -68,6 +68,8 @@ public class ToscaYamlToJsonConvertor { } /** + * Returns the CldsDao. + * * @return the cldsDao */ public CldsDao getCldsDao() { @@ -75,13 +77,20 @@ public class ToscaYamlToJsonConvertor { } /** - * @param cldsDao - * the cldsDao to set + * Sets the CldsDao. + * + * @param cldsDao the cldsDao to set */ public void setCldsDao(CldsDao cldsDao) { this.cldsDao = cldsDao; } + /** + * Parses Tosca YAML string. + * + * @param yamlString YAML string + * @return JSON string + */ public String parseToscaYaml(String yamlString) { Yaml yaml = new Yaml(); @@ -91,7 +100,6 @@ public class ToscaYamlToJsonConvertor { } LinkedHashMap nodeTypes = new LinkedHashMap<>(); LinkedHashMap dataNodes = new LinkedHashMap<>(); - JSONObject jsonEditorObject = new JSONObject(); JSONObject jsonParentObject = new JSONObject(); JSONObject jsonTempObject = new JSONObject(); parseNodeAndDataType(loadedYaml, nodeTypes, dataNodes); @@ -99,6 +107,7 @@ public class ToscaYamlToJsonConvertor { if (jsonTempObject.length() > 0) { jsonParentObject = jsonTempObject; } + JSONObject jsonEditorObject = new JSONObject(); jsonEditorObject.put(JsonEditorSchemaConstants.SCHEMA, jsonParentObject); return jsonEditorObject.toString(); } @@ -138,8 +147,8 @@ public class ToscaYamlToJsonConvertor { boolean isListNode = false; parseDescription((LinkedHashMap) ntPropertiesElement.getValue(), jsonParentObject); - LinkedHashMap parentPropertiesMap = (LinkedHashMap) ntPropertiesElement - .getValue(); + LinkedHashMap parentPropertiesMap = + (LinkedHashMap) ntPropertiesElement.getValue(); if (parentPropertiesMap.containsKey(ToscaSchemaConstants.TYPE) && ((String) parentPropertiesMap.get(ToscaSchemaConstants.TYPE)) .contains(ToscaSchemaConstants.TYPE_MAP) diff --git a/src/main/java/org/onap/clamp/clds/transform/XslTransformer.java b/src/main/java/org/onap/clamp/clds/transform/XslTransformer.java index a8f233e43..85b3f5ce4 100644 --- a/src/main/java/org/onap/clamp/clds/transform/XslTransformer.java +++ b/src/main/java/org/onap/clamp/clds/transform/XslTransformer.java @@ -45,6 +45,12 @@ public class XslTransformer { private Templates templates; + /** + * Sets Xsl Resource name. + * + * @param xslResourceName xsl resource name + * @throws TransformerConfigurationException exception if there is configuration error + */ public void setXslResourceName(String xslResourceName) throws TransformerConfigurationException { TransformerFactory tfactory = new TransformerFactoryImpl(); tfactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, ""); @@ -55,8 +61,8 @@ public class XslTransformer { /** * Given xml input, return the transformed result. * - * @param xml - * @throws TransformerException + * @param xml xml string + * @throws TransformerException exception during transformation */ public String doXslTransformToString(String xml) throws TransformerException { StringWriter output = new StringWriter(4096); diff --git a/src/main/java/org/onap/clamp/clds/util/ClampVersioning.java b/src/main/java/org/onap/clamp/clds/util/ClampVersioning.java index 06330091c..fd7a9a0fc 100644 --- a/src/main/java/org/onap/clamp/clds/util/ClampVersioning.java +++ b/src/main/java/org/onap/clamp/clds/util/ClampVersioning.java @@ -43,6 +43,11 @@ public class ClampVersioning { private ClampVersioning() { } + /** + * Returns Clds version from properties. + * + * @return Clds version from properties + */ public static String getCldsVersionFromProps() { String cldsVersion = ""; Properties props = new Properties(); @@ -50,7 +55,7 @@ public class ClampVersioning { props.load(resourceStream); cldsVersion = props.getProperty(CLDS_VERSION_PROPERTY); } catch (Exception ex) { - LOGGER.error("Exception caught during the "+CLDS_VERSION_PROPERTY+" property reading", ex); + LOGGER.error("Exception caught during the " + CLDS_VERSION_PROPERTY + " property reading", ex); } return cldsVersion; } diff --git a/src/main/java/org/onap/clamp/clds/util/CryptoUtils.java b/src/main/java/org/onap/clamp/clds/util/CryptoUtils.java index 07c4147b9..f08bf7b28 100644 --- a/src/main/java/org/onap/clamp/clds/util/CryptoUtils.java +++ b/src/main/java/org/onap/clamp/clds/util/CryptoUtils.java @@ -153,7 +153,7 @@ public final class CryptoUtils { } /** - * Reads SecretKeySpec from file specified by propertiesFileName + * Reads SecretKeySpec from file specified by propertiesFileName. * * @param propertiesFileName * File name with properties @@ -162,15 +162,15 @@ public final class CryptoUtils { private static SecretKeySpec readSecretKeySpec(String propertiesFileName) { Properties props = new Properties(); try { - //Workaround fix to make encryption key configurable. - //System environment variable takes precedence for over clds/key.properties - String encryptionKey = System.getenv(AES_ENCRYPTION_KEY); - if(encryptionKey != null && encryptionKey.trim().length() > 0) { - return getSecretKeySpec(encryptionKey); - } else { - props.load(ResourceFileUtil.getResourceAsStream(propertiesFileName)); + //Workaround fix to make encryption key configurable + // System environment variable takes precedence for over clds/key.properties + String encryptionKey = System.getenv(AES_ENCRYPTION_KEY); + if(encryptionKey != null && encryptionKey.trim().length() > 0) { + return getSecretKeySpec(encryptionKey); + } else { + props.load(ResourceFileUtil.getResourceAsStream(propertiesFileName)); return getSecretKeySpec(props.getProperty(KEY_PARAM)); - } + } } catch (IOException | DecoderException e) { logger.error("Exception occurred during the key reading", e); return null; diff --git a/src/main/java/org/onap/clamp/clds/util/LogMessages.java b/src/main/java/org/onap/clamp/clds/util/LogMessages.java index eaa1b2a94..7f4c8781f 100644 --- a/src/main/java/org/onap/clamp/clds/util/LogMessages.java +++ b/src/main/java/org/onap/clamp/clds/util/LogMessages.java @@ -27,7 +27,8 @@ import com.att.eelf.i18n.EELFResolvableErrorEnum; import com.att.eelf.i18n.EELFResourceManager; public enum LogMessages implements EELFResolvableErrorEnum { - LOGSERVICE_HELLO_MESSAGE, LOGSERVICE_EMAIL_ERROR, LOGSERVICE_EMAIL_CLASS, LOGSERVICE_EMAIL_CLASS_NULL, PROCESS_INSTANCE_ID; + LOGSERVICE_HELLO_MESSAGE, LOGSERVICE_EMAIL_ERROR, LOGSERVICE_EMAIL_CLASS, LOGSERVICE_EMAIL_CLASS_NULL, + PROCESS_INSTANCE_ID; static { EELFResourceManager.loadMessageBundle("logmessages"); diff --git a/src/main/java/org/onap/clamp/clds/util/LoggingUtils.java b/src/main/java/org/onap/clamp/clds/util/LoggingUtils.java index 47b4f9ab1..08bb97608 100644 --- a/src/main/java/org/onap/clamp/clds/util/LoggingUtils.java +++ b/src/main/java/org/onap/clamp/clds/util/LoggingUtils.java @@ -60,14 +60,15 @@ public class LoggingUtils { private static final String EMPTY_MESSAGE = ""; /** Logger delegate. */ - private EELFLogger mLogger; + private EELFLogger mlogger; /** Automatic UUID, overrideable per adapter or per invocation. */ private static UUID sInstanceUUID = UUID.randomUUID(); + /** - * Constructor + * Constructor. */ public LoggingUtils(final EELFLogger loggerP) { - this.mLogger = checkNotNull(loggerP); + this.mlogger = checkNotNull(loggerP); } /** @@ -173,20 +174,21 @@ public class LoggingUtils { /** * Report ENTERING marker. * - * @param request non-null incoming request (wrapper). - * @return this. + * @param request non-null incoming request (wrapper) + * @param serviceName service name */ public void entering(HttpServletRequest request, String serviceName) { MDC.clear(); checkNotNull(request); // Extract MDC values from standard HTTP headers. - final String requestID = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.REQUEST_ID)); - final String invocationID = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.INVOCATION_ID)); + final String requestId = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.REQUEST_ID)); + final String invocationId = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.INVOCATION_ID)); final String partnerName = defaultToEmpty(request.getHeader(ONAPLogConstants.Headers.PARTNER_NAME)); // Default the partner name to the user name used to login to clamp if (partnerName.equalsIgnoreCase(EMPTY_MESSAGE)) { - MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, new DefaultUserNameHandler().retrieveUserName(SecurityContextHolder.getContext())); + MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, new DefaultUserNameHandler() + .retrieveUserName(SecurityContextHolder.getContext())); } // Set standard MDCs. Override this entire method if you want to set @@ -196,28 +198,31 @@ public class LoggingUtils { MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP, ZonedDateTime.now(ZoneOffset.UTC) .format(DateTimeFormatter.ISO_INSTANT)); - MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestID); - MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationID); + MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId); + MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId); MDC.put(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS, defaultToEmpty(request.getRemoteAddr())); MDC.put(ONAPLogConstants.MDCs.SERVER_FQDN, defaultToEmpty(request.getServerName())); MDC.put(ONAPLogConstants.MDCs.INSTANCE_UUID, defaultToEmpty(sInstanceUUID)); // Default the service name to the requestURI, in the event that // no value has been provided. - if (serviceName == null || - serviceName.equalsIgnoreCase(EMPTY_MESSAGE)) { + if (serviceName == null + || serviceName.equalsIgnoreCase(EMPTY_MESSAGE)) { MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, request.getRequestURI()); } else { MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, serviceName); } - this.mLogger.info(ONAPLogConstants.Markers.ENTRY); + this.mlogger.info(ONAPLogConstants.Markers.ENTRY); } /** * Report EXITING marker. * - * @return this. + * @param code response code + * @param descrption response description + * @param severity response severity + * @param status response status code */ public void exiting(String code, String descrption, Level severity, ONAPLogConstants.ResponseStatus status) { try { @@ -225,7 +230,7 @@ public class LoggingUtils { MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, defaultToEmpty(descrption)); MDC.put(ONAPLogConstants.MDCs.RESPONSE_SEVERITY, defaultToEmpty(severity)); MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, defaultToEmpty(status)); - this.mLogger.info(ONAPLogConstants.Markers.EXIT); + this.mlogger.info(ONAPLogConstants.Markers.EXIT); } finally { MDC.clear(); @@ -236,28 +241,29 @@ public class LoggingUtils { * Report pending invocation with INVOKE marker, * setting standard ONAP logging headers automatically. * - * @param builder request builder, for setting headers. - * @param sync whether synchronous, nullable. - * @return invocation ID to be passed with invocation. + * @param con http URL connection + * @param targetEntity target entity + * @param targetServiceName target service name + * @return invocation ID to be passed with invocation */ public HttpURLConnection invoke(final HttpURLConnection con, String targetEntity, String targetServiceName) { - final String invocationID = UUID.randomUUID().toString(); + final String invocationId = UUID.randomUUID().toString(); // Set standard HTTP headers on (southbound request) builder. con.setRequestProperty(ONAPLogConstants.Headers.REQUEST_ID, defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.REQUEST_ID))); con.setRequestProperty(ONAPLogConstants.Headers.INVOCATION_ID, - invocationID); + invocationId); con.setRequestProperty(ONAPLogConstants.Headers.PARTNER_NAME, defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME))); - invokeContext(targetEntity, targetServiceName, invocationID); + invokeContext(targetEntity, targetServiceName, invocationId); // Log INVOKE*, with the invocationID as the message body. // (We didn't really want this kind of behavior in the standard, // but is it worse than new, single-message MDC?) - this.mLogger.info(ONAPLogConstants.Markers.INVOKE); - this.mLogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{"+ invocationID +"}"); + this.mlogger.info(ONAPLogConstants.Markers.INVOKE); + this.mlogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{" + invocationId + "}"); return con; } @@ -265,43 +271,47 @@ public class LoggingUtils { * Report pending invocation with INVOKE marker, * setting standard ONAP logging headers automatically. * - * @param builder request builder, for setting headers. - * @param sync whether synchronous, nullable. - * @return invocation ID to be passed with invocation. + * @param con http URL connection + * @param targetEntity target entity + * @param targetServiceName target service name + * @return invocation ID to be passed with invocation */ public HttpsURLConnection invokeHttps(final HttpsURLConnection con, String targetEntity, String targetServiceName) { - final String invocationID = UUID.randomUUID().toString(); + final String invocationId = UUID.randomUUID().toString(); // Set standard HTTP headers on (southbound request) builder. con.setRequestProperty(ONAPLogConstants.Headers.REQUEST_ID, defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.REQUEST_ID))); con.setRequestProperty(ONAPLogConstants.Headers.INVOCATION_ID, - invocationID); + invocationId); con.setRequestProperty(ONAPLogConstants.Headers.PARTNER_NAME, defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME))); - invokeContext(targetEntity, targetServiceName, invocationID); + invokeContext(targetEntity, targetServiceName, invocationId); // Log INVOKE*, with the invocationID as the message body. // (We didn't really want this kind of behavior in the standard, // but is it worse than new, single-message MDC?) - this.mLogger.info(ONAPLogConstants.Markers.INVOKE); - this.mLogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{"+ invocationID +"}"); + this.mlogger.info(ONAPLogConstants.Markers.INVOKE); + this.mlogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{" + invocationId + "}"); return con; } + /** + * Invokes return context. + */ public void invokeReturn() { // Add the Invoke-return marker and clear the needed MDC - this.mLogger.info(ONAPLogConstants.Markers.INVOKE_RETURN); + this.mlogger.info(ONAPLogConstants.Markers.INVOKE_RETURN); invokeReturnContext(); } /** * Dependency-free nullcheck. * - * @param in to be checked. - * @param argument (and return) type. - * @return input arg. + * @param in to be checked + * @param argument (and return) type + * @return input arg */ private static T checkNotNull(final T in) { if (in == null) { @@ -313,8 +323,8 @@ public class LoggingUtils { /** * Dependency-free string default. * - * @param in to be filtered. - * @return input string or null. + * @param in to be filtered + * @return input string or null */ private static String defaultToEmpty(final Object in) { if (in == null) { @@ -326,8 +336,8 @@ public class LoggingUtils { /** * Dependency-free string default. * - * @param in to be filtered. - * @return input string or null. + * @param in to be filtered + * @return input string or null */ private static String defaultToUUID(final String in) { if (in == null) { @@ -337,13 +347,13 @@ public class LoggingUtils { } /** - * Set target related logging variables in thread local data via MDC + * Set target related logging variables in thread local data via MDC. * * @param targetEntity Target entity (an external/sub component, for ex. "sdc") * @param targetServiceName Target service name (name of API invoked on target) - * @param invocationId The invocation ID + * @param invocationID The invocation ID */ - private void invokeContext (String targetEntity, String targetServiceName, String invocationID) { + private void invokeContext(String targetEntity, String targetServiceName, String invocationID) { MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, defaultToEmpty(targetEntity)); MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, defaultToEmpty(targetServiceName)); MDC.put(ONAPLogConstants.MDCs.INVOCATIONID_OUT, invocationID); @@ -353,10 +363,9 @@ public class LoggingUtils { } /** - * Clear target related logging variables in thread local data via MDC - * + * Clear target related logging variables in thread local data via MDC. */ - private void invokeReturnContext () { + private void invokeReturnContext() { MDC.remove(ONAPLogConstants.MDCs.TARGET_ENTITY); MDC.remove(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME); MDC.remove(ONAPLogConstants.MDCs.INVOCATIONID_OUT); diff --git a/src/main/java/org/onap/clamp/clds/util/XmlTools.java b/src/main/java/org/onap/clamp/clds/util/XmlTools.java index 391f0087d..a812fa127 100644 --- a/src/main/java/org/onap/clamp/clds/util/XmlTools.java +++ b/src/main/java/org/onap/clamp/clds/util/XmlTools.java @@ -37,6 +37,13 @@ import org.w3c.dom.DOMImplementation; import org.w3c.dom.Document; public class XmlTools { + + /** + * Transforms document to XML string. + * + * @param doc XML document + * @return XML string + */ public static String exportXmlDocumentAsString(Document doc) { try { TransformerFactory tf = TransformerFactory.newInstance(); @@ -49,9 +56,15 @@ public class XmlTools { throw new RuntimeException(e); } } + + /** + * Creates empty svg document. + * + * @return Document + */ public static Document createEmptySvgDocument() { DOMImplementation domImplementation = GenericDOMImplementation.getDOMImplementation(); - String svgNS = SVGDOMImplementation.SVG_NAMESPACE_URI; - return domImplementation.createDocument(svgNS, SVGConstants.SVG_SVG_TAG, null); + String svgNs = SVGDOMImplementation.SVG_NAMESPACE_URI; + return domImplementation.createDocument(svgNs, SVGConstants.SVG_SVG_TAG, null); } } diff --git a/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraph.java b/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraph.java index f49e735eb..46aa67b7d 100755 --- a/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraph.java +++ b/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraph.java @@ -34,8 +34,13 @@ public class ClampGraph { this.documentBuilder = documentBuilder; } + /** + * Returns svg string. + * + * @return svg string + */ public String getAsSVG() { - if(Objects.isNull(svg) || svg.isEmpty()) { + if (Objects.isNull(svg) || svg.isEmpty()) { svg = XmlTools.exportXmlDocumentAsString(this.documentBuilder.getGroupingDocument()); } return svg; diff --git a/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraphBuilder.java b/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraphBuilder.java index ef4c4e43d..c4ced5ef6 100755 --- a/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraphBuilder.java +++ b/src/main/java/org/onap/clamp/clds/util/drawing/ClampGraphBuilder.java @@ -40,13 +40,13 @@ public class ClampGraphBuilder { this.painter = painter; } - public ClampGraphBuilder collector(String c) { - collector = c; + public ClampGraphBuilder collector(String collector) { + this.collector = collector; return this; } - public ClampGraphBuilder policy(String p) { - policy = p; + public ClampGraphBuilder policy(String policy) { + this.policy = policy; return this; } diff --git a/src/main/java/org/onap/clamp/clds/util/drawing/ImageBuilder.java b/src/main/java/org/onap/clamp/clds/util/drawing/ImageBuilder.java index 4d76581c3..ce21c4cfd 100644 --- a/src/main/java/org/onap/clamp/clds/util/drawing/ImageBuilder.java +++ b/src/main/java/org/onap/clamp/clds/util/drawing/ImageBuilder.java @@ -57,9 +57,9 @@ public class ImageBuilder { ImageBuilder rectangle(String dataElementId, RectTypes rectType, String text) { Point next = new Point(currentPoint.x + baseLength, currentPoint.y); - Point p = coordinatesForRectangle(currentPoint, next); + Point point = coordinatesForRectangle(currentPoint, next); - handleBasedOnRectType(rectType, text, p, baseLength, rectHeight); + handleBasedOnRectType(rectType, text, point, baseLength, rectHeight); documentBuilder.pushChangestoDocument(g2d, dataElementId); currentPoint = next; @@ -94,36 +94,37 @@ public class ImageBuilder { return documentBuilder; } - private void handleBasedOnRectType(RectTypes rectType, String text, Point p, int w, int h) { - AwtUtils.rectWithText(g2d, text, p, w, h); + private void handleBasedOnRectType(RectTypes rectType, String text, Point point, int width, int height) { + AwtUtils.rectWithText(g2d, text, point, width, height); switch (rectType) { case COLECTOR: - drawVerticalLineForCollector(p, w, h); + drawVerticalLineForCollector(point, width, height); break; case MICROSERVICE: - drawHorizontalLineForMicroService(p, w, h); + drawHorizontalLineForMicroService(point, width, height); break; case POLICY: - drawDiagonalLineForPolicy(p, w, h); + drawDiagonalLineForPolicy(point, width, height); break; } } - private void drawVerticalLineForCollector(Point p, int w, int h) { - g2d.drawLine(p.x + w / COLLECTOR_LINE_RATIO, p.y, p.x + w / COLLECTOR_LINE_RATIO, p.y + h); + private void drawVerticalLineForCollector(Point point, int width, int height) { + g2d.drawLine(point.x + width / COLLECTOR_LINE_RATIO, point.y, point.x + width / COLLECTOR_LINE_RATIO, + point.y + height); } - private void drawHorizontalLineForMicroService(Point p, int w, int h) { - int y = calculateMsHorizontalLineYCoordinate(p,h); - g2d.drawLine(p.x, y, p.x + w, y); + private void drawHorizontalLineForMicroService(Point point, int width, int height) { + int y = calculateMsHorizontalLineYCoordinate(point,height); + g2d.drawLine(point.x, y, point.x + width, y); } - private void drawDiagonalLineForPolicy(Point p, int w, int h) { - g2d.drawLine(p.x, p.y + h / POLICY_LINE_RATIO, p.x + w / POLICY_LINE_RATIO, p.y); + private void drawDiagonalLineForPolicy(Point point, int width, int height) { + g2d.drawLine(point.x, point.y + height / POLICY_LINE_RATIO, point.x + width / POLICY_LINE_RATIO, point.y); } - private int calculateMsHorizontalLineYCoordinate(Point p, int h) { - return (int)(p.y * h * MS_LINE_TO_HEIGHT_RATIO); + private int calculateMsHorizontalLineYCoordinate(Point point, int height) { + return (int)(point.y * height * MS_LINE_TO_HEIGHT_RATIO); } private Point coordinatesForRectangle(Point from, Point next) { diff --git a/src/main/java/org/onap/clamp/clds/util/drawing/Painter.java b/src/main/java/org/onap/clamp/clds/util/drawing/Painter.java index 6263f30ba..fe2d5cb34 100755 --- a/src/main/java/org/onap/clamp/clds/util/drawing/Painter.java +++ b/src/main/java/org/onap/clamp/clds/util/drawing/Painter.java @@ -44,6 +44,12 @@ public class Painter { private static final double RECT_RATIO = 3.0 / 2.0; private static final int CIRCLE_RADIUS = 17; + /** + * Constructor to create instance of Painter. + * + * @param svgGraphics2D svg graphics + * @param documentBuilder document builder + */ public Painter(SVGGraphics2D svgGraphics2D, DocumentBuilder documentBuilder) { this.g2d = svgGraphics2D; this.documentBuilder = documentBuilder; -- cgit 1.2.3-korg