Merge "Fixed Sonar issues in the onap.clamp.clds.client packages"
authorSébastien Determe <sebastien.determe@intl.att.com>
Tue, 23 Apr 2019 08:14:12 +0000 (08:14 +0000)
committerGerrit Code Review <gerrit@onap.org>
Tue, 23 Apr 2019 08:14:12 +0000 (08:14 +0000)
62 files changed:
src/main/java/org/onap/clamp/clds/Application.java
src/main/java/org/onap/clamp/clds/client/DcaeDispatcherServices.java
src/main/java/org/onap/clamp/clds/client/DcaeInventoryServices.java
src/main/java/org/onap/clamp/clds/client/GuardPolicyDelegate.java
src/main/java/org/onap/clamp/clds/client/GuardPolicyDeleteDelegate.java
src/main/java/org/onap/clamp/clds/config/sdc/SdcSingleControllerConfiguration.java
src/main/java/org/onap/clamp/clds/config/spring/CldsConfiguration.java
src/main/java/org/onap/clamp/clds/config/spring/CldsSdcControllerConfiguration.java
src/main/java/org/onap/clamp/clds/config/spring/SdcControllerConfiguration.java
src/main/java/org/onap/clamp/clds/dao/CldsDao.java
src/main/java/org/onap/clamp/clds/exception/BadRequestException.java
src/main/java/org/onap/clamp/clds/exception/CldsConfigException.java
src/main/java/org/onap/clamp/clds/exception/CldsUsersException.java
src/main/java/org/onap/clamp/clds/exception/ModelBpmnException.java
src/main/java/org/onap/clamp/clds/exception/ModelPropertiesException.java
src/main/java/org/onap/clamp/clds/exception/NotAuthorizedException.java
src/main/java/org/onap/clamp/clds/exception/TcaRequestFormatterException.java
src/main/java/org/onap/clamp/clds/exception/dcae/DcaeDeploymentException.java
src/main/java/org/onap/clamp/clds/exception/policy/PolicyClientException.java
src/main/java/org/onap/clamp/clds/exception/sdc/SdcCommunicationException.java
src/main/java/org/onap/clamp/clds/exception/sdc/controller/CsarHandlerException.java
src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcArtifactInstallerException.java
src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcControllerException.java
src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcDownloadException.java
src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcParametersException.java
src/main/java/org/onap/clamp/clds/filter/ClampCadiFilter.java
src/main/java/org/onap/clamp/clds/model/CldsTemplate.java
src/main/java/org/onap/clamp/clds/model/CldsToscaModelDetails.java
src/main/java/org/onap/clamp/clds/model/CldsToscaModelRevision.java
src/main/java/org/onap/clamp/clds/model/properties/AbstractModelElement.java
src/main/java/org/onap/clamp/clds/model/properties/Holmes.java
src/main/java/org/onap/clamp/clds/model/properties/ModelProperties.java
src/main/java/org/onap/clamp/clds/model/properties/Policy.java
src/main/java/org/onap/clamp/clds/model/properties/PolicyItem.java
src/main/java/org/onap/clamp/clds/model/properties/Tca.java
src/main/java/org/onap/clamp/clds/model/sdc/SdcResource.java
src/main/java/org/onap/clamp/clds/model/sdc/SdcResourceBasicInfo.java
src/main/java/org/onap/clamp/clds/model/sdc/SdcServiceInfo.java
src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintArtifact.java
src/main/java/org/onap/clamp/clds/sdc/controller/installer/BlueprintParser.java
src/main/java/org/onap/clamp/clds/sdc/controller/installer/CsarHandler.java
src/main/java/org/onap/clamp/clds/sdc/controller/installer/MicroService.java
src/main/java/org/onap/clamp/clds/service/CldsDictionaryService.java
src/main/java/org/onap/clamp/clds/service/CldsService.java
src/main/java/org/onap/clamp/clds/service/CldsTemplateService.java
src/main/java/org/onap/clamp/clds/service/CldsToscaService.java
src/main/java/org/onap/clamp/clds/service/SecureServiceBase.java
src/main/java/org/onap/clamp/clds/service/SecureServicePermission.java
src/main/java/org/onap/clamp/clds/service/UserService.java
src/main/java/org/onap/clamp/clds/tosca/ToscaYamlToJsonConvertor.java
src/main/java/org/onap/clamp/clds/transform/XslTransformer.java
src/main/java/org/onap/clamp/clds/util/ClampVersioning.java
src/main/java/org/onap/clamp/clds/util/CryptoUtils.java
src/main/java/org/onap/clamp/clds/util/LogMessages.java
src/main/java/org/onap/clamp/clds/util/LoggingUtils.java
src/main/java/org/onap/clamp/clds/util/XmlTools.java
src/main/java/org/onap/clamp/clds/util/drawing/ClampGraph.java
src/main/java/org/onap/clamp/clds/util/drawing/ClampGraphBuilder.java
src/main/java/org/onap/clamp/clds/util/drawing/ImageBuilder.java
src/main/java/org/onap/clamp/clds/util/drawing/Painter.java
src/test/java/org/onap/clamp/clds/client/req/tca/TcaRequestFormatterTest.java
src/test/java/org/onap/clamp/clds/model/prop/CustomModelElement.java

index 025dbab..c144a14 100644 (file)
@@ -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");
index 024785e..f7aff0e 100644 (file)
@@ -100,7 +100,9 @@ public class DcaeDispatcherServices {
         Date startTime = new Date();\r
         LoggingUtils.setTargetContext("DCAE", "getOperationStatus");\r
         try {\r
-            String responseStr = dcaeHttpConnectionManager.doHttpRequest(statusUrl, "GET", null, null, "DCAE", null, null);\r
+            String responseStr = dcaeHttpConnectionManager.doHttpRequest(statusUrl, "GET", null,\r
+                                                                         null, "DCAE", null,\r
+                                                                         null);\r
             JSONObject jsonObj = parseResponse(responseStr);\r
             String operationType = (String) jsonObj.get("operationType");\r
             String status = (String) jsonObj.get(DCAE_STATUS_FIELD);\r
@@ -157,6 +159,7 @@ public class DcaeDispatcherServices {
 \r
     /***\r
      * Returns status URL for deleteExistingDeployment operation.\r
+     *\r
      * @param deploymentId\r
      *        The deployment ID\r
      * @param serviceTypeId\r
index dcf0542..7f20919 100644 (file)
@@ -70,7 +70,7 @@ public class DcaeInventoryServices {
      */\r
     @Autowired\r
     public DcaeInventoryServices(ClampProperties refProp, CldsDao cldsDao,\r
-               HttpConnectionManager httpConnectionManager) {\r
+                                 HttpConnectionManager httpConnectionManager) {\r
         this.refProp = refProp;\r
         this.cldsDao = cldsDao;\r
         this.httpConnectionManager = httpConnectionManager;\r
@@ -97,8 +97,8 @@ public class DcaeInventoryServices {
         }\r
         try {\r
             // Below are the properties required for calling the dcae inventory\r
-            ModelProperties prop = new ModelProperties(cldsModel.getName(), cldsModel.getControlName(), null, false,\r
-                "{}", cldsModel.getPropText());\r
+            ModelProperties prop = new ModelProperties(cldsModel.getName(), cldsModel.getControlName(), null,\r
+                                                       false, "{}", cldsModel.getPropText());\r
             Global global = prop.getGlobal();\r
             String invariantServiceUuid = global.getService();\r
             List<String> resourceUuidList = global.getResourceVf();\r
index a758716..3229337 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -26,19 +28,15 @@ package org.onap.clamp.clds.client;
 import com.att.eelf.configuration.EELFLogger;
 import com.att.eelf.configuration.EELFManager;
 
-import java.io.UnsupportedEncodingException;
-
 import org.apache.camel.Exchange;
 import org.apache.camel.Handler;
 import org.onap.clamp.clds.client.req.policy.GuardPolicyAttributesConstructor;
 import org.onap.clamp.clds.client.req.policy.PolicyClient;
-import org.onap.clamp.clds.config.ClampProperties;
 import org.onap.clamp.clds.model.properties.ModelProperties;
 import org.onap.clamp.clds.model.properties.Policy;
 import org.onap.clamp.clds.model.properties.PolicyChain;
 import org.onap.clamp.clds.model.properties.PolicyItem;
 import org.onap.clamp.clds.util.LoggingUtils;
-import org.onap.policy.controlloop.policy.builder.BuilderException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
@@ -52,41 +50,32 @@ public class GuardPolicyDelegate {
     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(GuardPolicyDelegate.class);
     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
     private final PolicyClient policyClient;
-    private final ClampProperties refProp;
 
     @Autowired
-    public GuardPolicyDelegate(PolicyClient policyClient, ClampProperties refProp) {
+    public GuardPolicyDelegate(PolicyClient policyClient) {
         this.policyClient = policyClient;
-        this.refProp = refProp;
     }
 
     /**
      * Perform activity. Send Guard Policies info to policy api.
      *
-     * @param camelExchange
-     *        The Camel Exchange object containing the properties
-     * @throws BuilderException
-     *         In case of issues with OperationalPolicyRequestAttributesConstructor
-     * @throws UnsupportedEncodingException
-     *         In case of issues with the Charset encoding
+     * @param camelExchange The Camel Exchange object containing the properties
      */
     @Handler
-    public void execute(Exchange camelExchange) throws BuilderException, UnsupportedEncodingException {
+    public void execute(Exchange camelExchange) {
         ModelProperties prop = ModelProperties.create(camelExchange);
         Policy policy = prop.getType(Policy.class);
         if (policy.isFound()) {
             for (PolicyChain policyChain : prop.getType(Policy.class).getPolicyChains()) {
-                for (PolicyItem policyItem:GuardPolicyAttributesConstructor
+                for (PolicyItem policyItem : GuardPolicyAttributesConstructor
                         .getAllPolicyGuardsFromPolicyChain(policyChain)) {
                     prop.setCurrentModelElementId(policy.getId());
                     prop.setPolicyUniqueId(policyChain.getPolicyId());
                     prop.setGuardUniqueId(policyItem.getId());
                     policyClient.sendGuardPolicy(GuardPolicyAttributesConstructor
-                        .formatAttributes(prop, policyItem), prop, LoggingUtils.getRequestId(), policyItem);
+                            .formatAttributes(prop, policyItem), prop, LoggingUtils.getRequestId(), policyItem);
                 }
             }
         }
     }
-
-
 }
index 941f519..ae962a0 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -30,7 +32,6 @@ import org.apache.camel.Exchange;
 import org.apache.camel.Handler;
 import org.onap.clamp.clds.client.req.policy.GuardPolicyAttributesConstructor;
 import org.onap.clamp.clds.client.req.policy.PolicyClient;
-import org.onap.clamp.clds.config.ClampProperties;
 import org.onap.clamp.clds.model.CldsEvent;
 import org.onap.clamp.clds.model.properties.ModelProperties;
 import org.onap.clamp.clds.model.properties.Policy;
@@ -46,21 +47,19 @@ import org.springframework.stereotype.Component;
 public class GuardPolicyDeleteDelegate {
 
     protected static final EELFLogger logger = EELFManager.getInstance()
-        .getLogger(GuardPolicyDeleteDelegate.class);
+            .getLogger(GuardPolicyDeleteDelegate.class);
     protected static final EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
     private final PolicyClient policyClient;
-    private final ClampProperties refProp;
 
     @Autowired
-    public GuardPolicyDeleteDelegate(PolicyClient policyClient, ClampProperties refProp) {
+    public GuardPolicyDeleteDelegate(PolicyClient policyClient) {
         this.policyClient = policyClient;
-        this.refProp = refProp;
     }
+
     /**
      * Perform activity. Delete Operational Policy via policy api.
      *
-     * @param camelExchange
-     *            The Camel Exchange object containing the properties
+     * @param camelExchange The Camel Exchange object containing the properties
      */
     @Handler
     public void execute(Exchange camelExchange) {
@@ -70,7 +69,7 @@ public class GuardPolicyDeleteDelegate {
         String eventAction = (String) camelExchange.getProperty("eventAction");
         if (!eventAction.equalsIgnoreCase(CldsEvent.ACTION_CREATE) && policy.isFound()) {
             for (PolicyChain policyChain : prop.getType(Policy.class).getPolicyChains()) {
-                for (PolicyItem policyItem:GuardPolicyAttributesConstructor
+                for (PolicyItem policyItem : GuardPolicyAttributesConstructor
                         .getAllPolicyGuardsFromPolicyChain(policyChain)) {
                     prop.setCurrentModelElementId(policy.getId());
                     prop.setPolicyUniqueId(policyChain.getPolicyId());
@@ -80,5 +79,4 @@ public class GuardPolicyDeleteDelegate {
             }
         }
     }
-
 }
index 283d8c5..052ea73 100644 (file)
@@ -203,8 +203,8 @@ public class SdcSingleControllerConfiguration implements IConfiguration {
 
     @Override
     public boolean activateServerTLSAuth() {
-        if (jsonRootNode != null && jsonRootNode.get(ACTIVATE_SERVER_TLS_AUTH) != null &&
-                jsonRootNode.get(ACTIVATE_SERVER_TLS_AUTH).isJsonPrimitive()) {
+        if (jsonRootNode != null && jsonRootNode.get(ACTIVATE_SERVER_TLS_AUTH) != null
+                && jsonRootNode.get(ACTIVATE_SERVER_TLS_AUTH).isJsonPrimitive()) {
             return jsonRootNode.get(ACTIVATE_SERVER_TLS_AUTH).getAsBoolean();
         } else {
             return false;
index e0a804e..1fdc898 100644 (file)
@@ -49,7 +49,7 @@ public class CldsConfiguration {
     /**
      * Clds Identity database DataSource configuration.
      *
-     * @return
+     * @return encoded password data source
      */
     @Bean(name = "cldsDataSource")
     @ConfigurationProperties(prefix = "spring.datasource.cldsdb")
index 3f1403f..92b0272 100644 (file)
@@ -57,6 +57,9 @@ public class CldsSdcControllerConfiguration {
     @Autowired
     protected CsarInstaller csarInstaller;
 
+    /**
+     * Loads SDC controllers configuration.
+     */
     @PostConstruct
     public void loadSdcControllers() {
         SdcControllersConfiguration sdcControllersConfig = getSdcControllersConfiguration();
@@ -67,6 +70,9 @@ public class CldsSdcControllerConfiguration {
         });
     }
 
+    /**
+     * Checks whether all SDC controllers defined are up and running.
+     */
     @Scheduled(fixedRate = 120000)
     public void checkAllSdcControllers() {
         logger.info("Checking that all SDC Controllers defined are up and running");
@@ -82,6 +88,9 @@ public class CldsSdcControllerConfiguration {
         logger.info("SDC Controllers check completed");
     }
 
+    /**
+     * Closes all SDC Controller and the SDC Client.
+     */
     @PreDestroy
     public void killSdcControllers() {
         sdcControllersList.forEach(e -> {
index 2977d1a..55b90cc 100644 (file)
@@ -56,6 +56,9 @@ public class SdcControllerConfiguration {
     @Autowired
     protected CsarInstaller csarInstaller;
 
+    /**
+     * Loads SDC controller configuration.
+     */
     @PostConstruct
     public void loadSdcControllers() {
         SdcControllersConfiguration sdcControllersConfig = getSdcControllersConfiguration();
@@ -66,6 +69,9 @@ public class SdcControllerConfiguration {
         });
     }
 
+    /**
+     * Checks whether all SDC controllers defined are up and running.
+     */
     @Scheduled(fixedRate = 120000)
     public void checkAllSdcControllers() {
         logger.info("Checking that all SDC Controllers defined are up and running");
@@ -81,6 +87,9 @@ public class SdcControllerConfiguration {
         logger.info("SDC Controllers check completed");
     }
 
+    /**
+     * Closes all SDC Controller and the SDC Client.
+     */
     @PreDestroy
     public void killSdcControllers() {
         sdcControllersList.forEach(e -> {
index 8378af8..1cff6bb 100644 (file)
@@ -507,14 +507,14 @@ public class CldsDao {
         SimpleDateFormat sdf = new SimpleDateFormat(DATE_FORMAT);
         List<CldsToscaModel> 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<Map<String, Object>> 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<Map<String, Object>> rows = jdbcTemplateObject.queryForList(dictionarySql);
index c6b0d55..caf525e 100644 (file)
@@ -30,20 +30,20 @@ package org.onap.clamp.clds.exception;
 public class BadRequestException extends RuntimeException {
 
     /**
-        * 
-        */
-       private static final long serialVersionUID = -5738167530541646123L;
+     * The serial version ID.
+     */
+    private static final long serialVersionUID = -5738167530541646123L;
 
-       /**
+    /**
      * This constructor can be used to create a new CldsConfigException.
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public BadRequestException(String message, Throwable e) {
-        super(message, e);
+    public BadRequestException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index c06d101..93d9815 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception;
 public class CldsConfigException extends RuntimeException {
 
     /**
-     * 
+     * The serial version ID.
      */
     private static final long serialVersionUID = 5958873136187918505L;
 
@@ -39,11 +39,11 @@ public class CldsConfigException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public CldsConfigException(String message, Throwable e) {
-        super(message, e);
+    public CldsConfigException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 0f54f3b..270bfa1 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception;
 public class CldsUsersException extends RuntimeException {
 
     /**
-     * 
+     * The serial version ID.
      */
     private static final long serialVersionUID = 933535057227505342L;
 
@@ -39,11 +39,11 @@ public class CldsUsersException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public CldsUsersException(String message, Throwable e) {
-        super(message, e);
+    public CldsUsersException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 02d5703..5892dfc 100644 (file)
@@ -41,11 +41,11 @@ public class ModelBpmnException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public ModelBpmnException(String message, Throwable e) {
-        super(message, e);
+    public ModelBpmnException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index b17616b..8d474fc 100644 (file)
@@ -40,11 +40,11 @@ public class ModelPropertiesException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public ModelPropertiesException(String message, Throwable e) {
-        super(message, e);
+    public ModelPropertiesException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 4ea0503..1bdf18e 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception;
 public class NotAuthorizedException extends RuntimeException {
 
     /**
-     * 
+     * The serial version ID.
      */
     private static final long serialVersionUID = -5738167530541646123L;
 
@@ -39,11 +39,11 @@ public class NotAuthorizedException extends RuntimeException {
      *
      * @param message
      *        A string message detailing the problem
-     * @param e
+     * @param ex
      *        The exception sent by the code
      */
-    public NotAuthorizedException(String message, Throwable e) {
-        super(message, e);
+    public NotAuthorizedException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 92d3663..3bfb5ea 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception;
 public class TcaRequestFormatterException extends RuntimeException {
 
     /**
-     * 
+     * The serial version ID.
      */
     private static final long serialVersionUID = 169875373143236667L;
 
@@ -40,11 +40,11 @@ public class TcaRequestFormatterException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public TcaRequestFormatterException(String message, Throwable e) {
-        super(message, e);
+    public TcaRequestFormatterException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 9e11321..e733da5 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception.dcae;
 public class DcaeDeploymentException extends RuntimeException {
 
     /**
-     * Generated ID
+     * Generated ID.
      */
     private static final long serialVersionUID = 8452294782552680243L;
 
@@ -39,11 +39,11 @@ public class DcaeDeploymentException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public DcaeDeploymentException(String message, Throwable e) {
-        super(message, e);
+    public DcaeDeploymentException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 85695a2..06dcdbf 100644 (file)
@@ -39,11 +39,11 @@ public class PolicyClientException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public PolicyClientException(String message, Throwable e) {
-        super(message, e);
+    public PolicyClientException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 862b213..b70b114 100644 (file)
@@ -30,7 +30,7 @@ package org.onap.clamp.clds.exception.sdc;
 public class SdcCommunicationException extends RuntimeException {
 
     /**
-     * Generated ID
+     * Generated ID.
      */
     private static final long serialVersionUID = 8452294782552680243L;
 
@@ -39,11 +39,11 @@ public class SdcCommunicationException extends RuntimeException {
      * 
      * @param message
      *            A string message detailing the problem
-     * @param e
+     * @param ex
      *            The exception sent by the code
      */
-    public SdcCommunicationException(String message, Throwable e) {
-        super(message, e);
+    public SdcCommunicationException(String message, Throwable ex) {
+        super(message, ex);
     }
 
     /**
index 4e1b8ea..c3ebde1 100644 (file)
@@ -29,25 +29,24 @@ package org.onap.clamp.clds.exception.sdc.controller;
 public class CsarHandlerException extends Exception {
 
     /**
-     * 
+     * The serial version ID.
      */
     private static final long serialVersionUID = -7628640776124409155L;
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new CsarHandlerException.
+     *
+     * @param message The message to dump
      */
     public CsarHandlerException(final String message) {
         super(message);
     }
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new CsarHandlerException.
+     *
+     * @param message The message to dump
+     * @param cause The Throwable cause object
      */
     public CsarHandlerException(final String message, final Throwable cause) {
         super(message, cause);
index eba3263..523766a 100644 (file)
@@ -34,20 +34,19 @@ public class SdcArtifactInstallerException extends Exception {
     private static final long serialVersionUID = 4095937499475915021L;
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcArtifactInstallerException.
+     *
+     * @param message The message to dump
      */
     public SdcArtifactInstallerException(final String message) {
         super(message);
     }
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcArtifactInstallerException.
+     *
+     * @param message The message to dump
+     * @param cause The Throwable cause object
      */
     public SdcArtifactInstallerException(final String message, final Throwable cause) {
         super(message, cause);
index 1a7afd2..d73001d 100644 (file)
@@ -34,20 +34,19 @@ public class SdcControllerException extends Exception {
     private static final long serialVersionUID = -4236006447255525130L;
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcControllerException.
+     *
+     * @param message The message to dump
      */
     public SdcControllerException(final String message) {
         super(message);
     }
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcControllerException.
+     *
+     * @param message The message to dump
+     * @param cause The Throwable cause object
      */
     public SdcControllerException(final String message, final Throwable cause) {
         super(message, cause);
index fa92499..6cd3fb8 100644 (file)
@@ -34,20 +34,19 @@ public class SdcDownloadException extends Exception {
     private static final long serialVersionUID = -5276848693231134901L;
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcDownloadException.
+     *
+     * @param message The message to dump
      */
     public SdcDownloadException(final String message) {
         super(message);
     }
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcDownloadException.
+     *
+     * @param message The message to dump
+     * @param cause The Throwable cause object
      */
     public SdcDownloadException(final String message, final Throwable cause) {
         super(message, cause);
index 8a11a6e..bfe63cb 100644 (file)
@@ -34,20 +34,19 @@ public class SdcParametersException extends RuntimeException {
     private static final long serialVersionUID = 8425657297510362736L;
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcParametersException.
+     *
+     * @param message The message to dump
      */
     public SdcParametersException(final String message) {
         super(message);
     }
 
     /**
-     * @param message
-     *            The message to dump
-     * @param cause
-     *            The Throwable cause object
+     * This constructor can be used to create a new SdcParametersException.
+     *
+     * @param message The message to dump
+     * @param cause The Throwable cause object
      */
     public SdcParametersException(final String message, final Throwable cause) {
         super(message, cause);
index f058a9e..586899a 100644 (file)
@@ -20,6 +20,7 @@
  * ===================================================================
  *
  */
+
 package org.onap.clamp.clds.filter;
 
 import com.att.eelf.configuration.EELFLogger;
index 8f66204..8f34083 100644 (file)
@@ -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
index a4ee734..4ee1deb 100644 (file)
@@ -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 {
 
index 68cd496..b9a7e0d 100644 (file)
@@ -22,8 +22,7 @@
  */
 
 /**
- * Represents a CLDS Tosca model revision
- *
+ * Represents a CLDS Tosca model revision.
  */
 
 package org.onap.clamp.clds.model;
index 73f708c..9c15524 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -36,21 +38,15 @@ public abstract class AbstractModelElement {
 
     protected static final EELFLogger logger = EELFManager.getInstance().getLogger(AbstractModelElement.class);
     protected static final EELFLogger auditLogger = EELFManager.getInstance().getAuditLogger();
-    private final String type;
-    private final ModelBpmn modelBpmn;
     private final String id;
     protected String topicPublishes;
     protected final JsonElement modelElementJsonNode;
-    private boolean isFound;
-    private final ModelProperties modelProp;
+    private final boolean isFound;
 
     /**
      * Perform base parsing of properties for a ModelElement (such as, VesCollector, Policy and Tca).
      */
-    protected AbstractModelElement(String type, ModelProperties modelProp, ModelBpmn modelBpmn, JsonObject modelJson) {
-        this.type = type;
-        this.modelProp = modelProp;
-        this.modelBpmn = modelBpmn;
+    protected AbstractModelElement(String type, ModelBpmn modelBpmn, JsonObject modelJson) {
         this.id = modelBpmn.getId(type);
         this.modelElementJsonNode = modelJson.get(id);
         this.isFound = modelBpmn.isModelElementTypeInList(type);
@@ -58,15 +54,16 @@ public abstract class AbstractModelElement {
 
     /**
      * Get the topic publishes.
+     *
      * @return the topicPublishes
      */
     public String getTopicPublishes() {
         return topicPublishes;
     }
 
-
     /**
      * Get the id.
+     *
      * @return the id
      */
     public String getId() {
@@ -75,6 +72,7 @@ public abstract class AbstractModelElement {
 
     /**
      * Get the isFound flag.
+     *
      * @return the isFound
      */
     public boolean isFound() {
index 63c677d..a93b09c 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -18,7 +20,7 @@
  * limitations under the License.
  * ============LICENSE_END============================================
  * ===================================================================
- * 
+ *
  */
 
 package org.onap.clamp.clds.model.properties;
@@ -30,27 +32,22 @@ import org.onap.clamp.clds.util.JsonUtils;
  * Parse Holmes bpmn parameters json properties.
  * Example json:
  * [{"name":"correlationalLogic","value":"vcwx"},{"name":"configPolicyName","value":"cccc"}]
- *
  */
 public class Holmes extends AbstractModelElement {
 
     private static final String TYPE_HOLMES = "holmes";
 
-    private String              correlationLogic;
-
-    private String              configPolicyName;
+    private String correlationLogic;
+    private String configPolicyName;
 
     /**
      * Default constructor for Holmes Element.
      *
-     * @param modelProp
-     *            The ModelProperties containing the all the info, like bpmn,
-     *            bpmn params, etc ...
      * @param modelBpmn The model bpmn
      * @param modelJson The model json
      */
-    public Holmes(ModelProperties modelProp, ModelBpmn modelBpmn, JsonObject modelJson) {
-        super(TYPE_HOLMES, modelProp, modelBpmn, modelJson);
+    public Holmes(ModelBpmn modelBpmn, JsonObject modelJson) {
+        super(TYPE_HOLMES, modelBpmn, modelJson);
 
         correlationLogic = JsonUtils.getStringValueByName(modelElementJsonNode, "correlationalLogic");
         configPolicyName = JsonUtils.getStringValueByName(modelElementJsonNode, "configPolicyName");
@@ -67,5 +64,4 @@ public class Holmes extends AbstractModelElement {
     public String getConfigPolicyName() {
         return configPolicyName;
     }
-
 }
index 5160e10..9b7f85d 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -118,19 +120,19 @@ public class ModelProperties {
             // Parse the list of base Model Elements and build up the
             // ModelElements
             modelElementClasses.entrySet().stream().parallel()
-                .filter(entry -> (AbstractModelElement.class.isAssignableFrom(entry.getKey())
-                    && missingTypes.contains(entry.getValue())))
-                .forEach(entry -> {
-                    try {
-                        modelElements.put(entry.getValue(),
-                            (entry.getKey().getConstructor(ModelProperties.class, ModelBpmn.class, JsonObject.class)
-                                .newInstance(this, modelBpmn, modelJson)));
-                    } catch (InstantiationException | NoSuchMethodException | IllegalAccessException
-                        | InvocationTargetException e) {
-                        logger.warn("Unable to instantiate a ModelElement " + entry.getValue()
-                            + ", exception follows: ", e);
-                    }
-                });
+                    .filter(entry -> (AbstractModelElement.class.isAssignableFrom(entry.getKey())
+                            && missingTypes.contains(entry.getValue())))
+                    .forEach(entry -> {
+                        try {
+                            modelElements.put(entry.getValue(),
+                                    (entry.getKey().getConstructor(ModelBpmn.class, JsonObject.class)
+                                            .newInstance(modelBpmn, modelJson)));
+                        } catch (InstantiationException | NoSuchMethodException | IllegalAccessException
+                                | InvocationTargetException e) {
+                            logger.warn("Unable to instantiate a ModelElement " + entry.getValue()
+                                    + ", exception follows: ", e);
+                        }
+                    });
         }
     }
 
@@ -277,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("-", "_");
@@ -357,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<? extends AbstractModelElement> modelElementClass,
         String type) {
         if (!modelElementClasses.containsKey(modelElementClass.getClass())) {
index 9cb3635..9537cb9 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -25,9 +27,9 @@ package org.onap.clamp.clds.model.properties;
 
 import com.att.eelf.configuration.EELFLogger;
 import com.att.eelf.configuration.EELFManager;
-
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -51,23 +53,22 @@ import java.util.Map.Entry;
  * "vf3RtPi"]}]]}]
  */
 public class Policy extends AbstractModelElement {
-    protected static final EELFLogger logger      = EELFManager.getInstance().getLogger(Policy.class);
+    protected static final EELFLogger logger = EELFManager.getInstance().getLogger(Policy.class);
     protected static final EELFLogger auditLogger = EELFManager.getInstance().getAuditLogger();
 
-    private List<PolicyChain>         policyChains;
+    private List<PolicyChain> policyChains;
 
-    private static final String       TYPE_POLICY = "policy";
+    private static final String TYPE_POLICY = "policy";
 
     /**
      * Parse Policy given json node.
      *
-     * @param modelProp The model properties.
      * @param modelBpmn The model bpmn
      * @param modelJson The model json
      * @throws IOException The IO Exception
      */
-    public Policy(ModelProperties modelProp, ModelBpmn modelBpmn, JsonObject modelJson) throws IOException {
-        super(TYPE_POLICY, modelProp, modelBpmn, modelJson);
+    public Policy(ModelBpmn modelBpmn, JsonObject modelJson) throws IOException {
+        super(TYPE_POLICY, modelBpmn, modelJson);
 
         // process policies
         if (modelElementJsonNode != null) {
@@ -81,6 +82,7 @@ public class Policy extends AbstractModelElement {
 
     /**
      * Get the policy chains.
+     *
      * @return the policyChains
      */
     public List<PolicyChain> getPolicyChains() {
@@ -90,5 +92,4 @@ public class Policy extends AbstractModelElement {
     public static final String getType() {
         return TYPE_POLICY;
     }
-
 }
index 6d766be..1855468 100644 (file)
@@ -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");
index 0d17b95..efa0188 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -18,7 +20,7 @@
  * limitations under the License.
  * ============LICENSE_END============================================
  * ===================================================================
- * 
+ *
  */
 
 package org.onap.clamp.clds.model.properties;
@@ -27,31 +29,30 @@ import com.att.eelf.configuration.EELFLogger;
 import com.att.eelf.configuration.EELFManager;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+
 import java.util.Map.Entry;
 import java.util.Set;
 
 /**
  * Parse ONAP Tca json properties.
- *
  */
 public class Tca extends AbstractModelElement {
 
-    protected static final EELFLogger logger      = EELFManager.getInstance().getLogger(Tca.class);
+    protected static final EELFLogger logger = EELFManager.getInstance().getLogger(Tca.class);
     protected static final EELFLogger auditLogger = EELFManager.getInstance().getAuditLogger();
 
-    private TcaItem                   tcaItem;
+    private TcaItem tcaItem;
 
-    private static final String       TYPE_TCA    = "tca";
+    private static final String TYPE_TCA = "tca";
 
     /**
      * Parse Tca given json node.
      *
-     * @param modelProp The model properties
      * @param modelBpmn The model bpmn
      * @param modelJson The model json
      */
-    public Tca(ModelProperties modelProp, ModelBpmn modelBpmn, JsonObject modelJson) {
-        super(TYPE_TCA, modelProp, modelBpmn, modelJson);
+    public Tca(ModelBpmn modelBpmn, JsonObject modelJson) {
+        super(TYPE_TCA, modelBpmn, modelJson);
 
         // process Server_Configurations
         if (modelElementJsonNode != null) {
@@ -68,5 +69,4 @@ public class Tca extends AbstractModelElement {
     public static final String getType() {
         return TYPE_TCA;
     }
-
 }
index 2474da0..515e77d 100644 (file)
@@ -126,31 +126,38 @@ public class SdcResource implements Comparable<SdcResource> {
 
     @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);
index e853621..47192a5 100644 (file)
@@ -71,31 +71,38 @@ public class SdcResourceBasicInfo implements Comparable<SdcResourceBasicInfo> {
 
     @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);
index a9c1e64..bb9f3f8 100644 (file)
@@ -146,31 +146,38 @@ public class SdcServiceInfo implements Comparable<SdcServiceInfo> {
 
     @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 {
index 6c7bfbb..35bc909 100644 (file)
  * ===================================================================
  * 
  */
-/**
- * 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;
index 5a8ccca..5dcffd6 100644 (file)
@@ -21,6 +21,7 @@
  * ===================================================================
  *
  */
+
 package org.onap.clamp.clds.sdc.controller.installer;
 
 import com.google.gson.Gson;
index 65d5592..5a21a1f 100644 (file)
@@ -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);
     }
 
index a785f41..ac4daef 100644 (file)
@@ -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() {
index 0fb1e0f..7641713 100644 (file)
@@ -39,7 +39,7 @@ import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Component;
 
 /**
- * REST services to manage dictionary and dictionary items for Tosca Model
+ * REST services to manage dictionary and dictionary items for Tosca Model.
  */
 @Component
 public class CldsDictionaryService extends SecureServiceBase {
@@ -65,10 +65,10 @@ public class CldsDictionaryService extends SecureServiceBase {
     }
 
     /**
-     * REST Service that creates or Updates a Dictionary
+     * REST Service that creates or Updates a Dictionary.
      * 
-     * @param dictionaryName
-     * @param cldsDictionary
+     * @param dictionaryName dictionary name
+     * @param cldsDictionary clds dictionary
      * @return CldsDictionary that was created in DB.
      */
     public ResponseEntity<CldsDictionary> createOrUpdateDictionary(String dictionaryName,
@@ -90,10 +90,10 @@ public class CldsDictionaryService extends SecureServiceBase {
 
     /**
      * REST Service that creates or Updates a Dictionary Elements for dictionary
-     * in DB
+     * in DB.
      * 
-     * @param dictionaryName
-     * @param dictionaryItem
+     * @param dictionaryName dictionary name
+     * @param dictionaryItem dictionary item
      * @return CldsDictionaryItem A dictionary items that was created or updated
      *         in DB
      */
@@ -111,7 +111,7 @@ public class CldsDictionaryService extends SecureServiceBase {
     }
 
     /**
-     * Rest Service that retrieves all CLDS dictionary in DB
+     * Rest Service that retrieves all CLDS dictionary in DB.
      * 
      * @return CldsDictionary List List of CldsDictionary available in DB
      */
@@ -129,9 +129,9 @@ public class CldsDictionaryService extends SecureServiceBase {
 
     /**
      * Rest Service that retrieves all CLDS dictionary items in DB for a give
-     * dictionary name
+     * dictionary name.
      * 
-     * @param dictionaryName
+     * @param dictionaryName dictionary name
      * @return CldsDictionaryItem list List of CLDS Dictionary items for a given
      *         dictionary name
      */
index b9cce08..2a89b19 100644 (file)
@@ -85,7 +85,7 @@ public class CldsService extends SecureServiceBase {
      * The constant LIST_OF_SDC_SERVICE_INFO_TYPE.
      */
     public static final Type LIST_OF_SDC_SERVICE_INFO_TYPE = new TypeToken<List<SdcServiceInfo>>() {
-    }.getType();
+        }.getType();
     @Produce(uri = "direct:processSubmit")
     private CamelProxy camelProxy;
     /**
@@ -551,7 +551,7 @@ public class CldsService extends SecureServiceBase {
      * UUID. If not authorized, then NotAuthorizedException is thrown.
      *
      * @param model The clds model
-     * @return
+     * @return boolean or throws NotAuthorizedException
      */
     private boolean isAuthorizedForVf(CldsModel model) {
         String vf = ModelProperties.getVf(model);
index d82e7c6..f60c638 100644 (file)
@@ -52,7 +52,7 @@ public class CldsTemplateService extends SecureServiceBase {
     private SecureServicePermission permissionReadTemplate;
     private SecureServicePermission permissionUpdateTemplate;
     @Autowired
-       private HttpServletRequest request;
+    private HttpServletRequest request;
 
     @PostConstruct
     private final void afterConstruction() {
@@ -71,11 +71,11 @@ public class CldsTemplateService extends SecureServiceBase {
      * database. This is subset of the json getModel. This is only expected to
      * be used for testing purposes, not by the UI.
      *
-     * @param templateName
+     * @param templateName template name
      * @return bpmn xml text - content of bpmn given name
      */
     public String getBpmnTemplate(String templateName) {
-       util.entering(request, "CldsTemplateService: GET template bpmn");
+        util.entering(request, "CldsTemplateService: GET template bpmn");
         Date startTime = new Date();
         isAuthorized(permissionReadTemplate);
         logger.info("GET bpmnText for templateName=" + templateName);
@@ -92,11 +92,11 @@ public class CldsTemplateService extends SecureServiceBase {
      * database. This is subset of the json getModel. This is only expected to
      * be used for testing purposes, not by the UI.
      *
-     * @param templateName
+     * @param templateName template name
      * @return image xml text - content of image given name
      */
     public String getImageXml(String templateName) {
-       util.entering(request, "CldsTemplateService: GET template image");
+        util.entering(request, "CldsTemplateService: GET template image");
         Date startTime = new Date();
         isAuthorized(permissionReadTemplate);
         logger.info("GET imageText for templateName=" + templateName);
@@ -111,11 +111,11 @@ public class CldsTemplateService extends SecureServiceBase {
     /**
      * REST service that retrieves a CLDS template by name from the database.
      *
-     * @param templateName
+     * @param templateName template name
      * @return clds template - clds template for the given template name
      */
     public CldsTemplate getTemplate(String templateName) {
-       util.entering(request, "CldsTemplateService: GET template");
+        util.entering(request, "CldsTemplateService: GET template");
         Date startTime = new Date();
         isAuthorized(permissionReadTemplate);
         logger.info("GET model for  templateName=" + templateName);
@@ -131,12 +131,12 @@ public class CldsTemplateService extends SecureServiceBase {
     /**
      * REST service that saves a CLDS template by name in the database.
      *
-     * @param templateName
-     * @param cldsTemplate
+     * @param templateName template name
+     * @param cldsTemplate clds template
      * @return The CldsTemplate modified and saved in DB
      */
     public CldsTemplate putTemplate(String templateName, CldsTemplate cldsTemplate) {
-       util.entering(request, "CldsTemplateService: PUT template");
+        util.entering(request, "CldsTemplateService: PUT template");
         Date startTime = new Date();
         isAuthorized(permissionUpdateTemplate);
         logger.info("PUT Template for  templateName=" + templateName);
@@ -158,7 +158,7 @@ public class CldsTemplateService extends SecureServiceBase {
      * @return template names in JSON
      */
     public List<ValueItem> getTemplateNames() {
-       util.entering(request, "CldsTemplateService: GET template names");
+        util.entering(request, "CldsTemplateService: GET template names");
         Date startTime = new Date();
         isAuthorized(permissionReadTemplate);
         logger.info("GET list of template names");
@@ -171,7 +171,7 @@ public class CldsTemplateService extends SecureServiceBase {
     }
 
     // Created for the integration test
-    public void setLoggingUtil (LoggingUtils utilP) {
+    public void setLoggingUtil(LoggingUtils utilP) {
         util =  utilP;
     }
 }
index adebd78..f2c75ea 100644 (file)
@@ -41,7 +41,7 @@ import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Component;
 
 /**
- * REST services to manage Tosca Model
+ * REST services to manage Tosca Model.
  */
 @Component
 public class CldsToscaService extends SecureServiceBase {
index 522f682..f653089 100644 (file)
@@ -53,7 +53,7 @@ public abstract class SecureServiceBase {
     /**
      * Get the userId from AAF/CSP.
      *
-     * @return
+     * @return user ID
      */
     public String getUserId() {
         return getUserName();
@@ -62,7 +62,7 @@ public abstract class SecureServiceBase {
     /**
      * Get the Full name.
      *
-     * @return
+     * @return user name
      */
     public String getUserName() {
         String name = userNameHandler.retrieveUserName(securityContext);
@@ -76,7 +76,7 @@ public abstract class SecureServiceBase {
     /**
      * Get the principal name.
      *
-     * @return
+     * @return the principal name
      */
     public String getPrincipalName() {
         String principal = ((UserDetails)securityContext.getAuthentication().getPrincipal()).getUsername();
@@ -175,13 +175,16 @@ public abstract class SecureServiceBase {
             // the rest of these don't seem to be required - isUserInRole method
             // appears to take * as a wildcard
         } else if (hasRole(inPermission.getKeyAllInstance())) {
-            securityLogger.info("{} authorized because user has permission with * for instance: {}", getPrincipalName(), inPermission.getKey());
+            securityLogger.info("{} authorized because user has permission with * for instance: {}",
+                                getPrincipalName(), inPermission.getKey());
             authorized = true;
         } else if (hasRole(inPermission.getKeyAllInstanceAction())) {
-            securityLogger.info("{} authorized because user has permission with * for instance and * for action: {}", getPrincipalName(), inPermission.getKey());
+            securityLogger.info("{} authorized because user has permission with * for instance and * for action: {}",
+                                getPrincipalName(), inPermission.getKey());
             authorized = true;
         } else if (hasRole(inPermission.getKeyAllAction())) {
-            securityLogger.info("{} authorized because user has permission with * for action: {}", getPrincipalName(), inPermission.getKey());
+            securityLogger.info("{} authorized because user has permission with * for action: {}",
+                                getPrincipalName(), inPermission.getKey());
             authorized = true;
         } else {
             throw new NotAuthorizedException("");
@@ -196,8 +199,9 @@ public abstract class SecureServiceBase {
         }
 
         for (GrantedAuthority auth : authentication.getAuthorities()) {
-            if (role.equals(auth.getAuthority()))
+            if (role.equals(auth.getAuthority())) {
                 return true;
+            }
         }
 
         return false;
index ae30d2a..a93732c 100644 (file)
@@ -37,10 +37,10 @@ public class SecureServicePermission {
     /**
      * Factory method to create permission given type, instance, and action.
      *
-     * @param type
-     * @param instance
-     * @param action
-     * @return
+     * @param type type of the permission
+     * @param instance instance of the permission
+     * @param action action of the permission
+     * @return instance of SecureServicePermission with type, instance and action
      */
     public static SecureServicePermission create(String type, String instance, String action) {
         return new SecureServicePermission(type, instance, action);
@@ -50,9 +50,9 @@ public class SecureServicePermission {
      * Factory method to create permission given type and instance. Default
      * action to ALL/*.
      *
-     * @param type
-     * @param instance
-     * @return
+     * @param type type of the permission
+     * @param instance instance of the permission
+     * @return instance of SecureServicePermission with type, instance and default action
      */
     public static SecureServicePermission create(String type, String instance) {
         return new SecureServicePermission(type, instance, ALL);
@@ -62,8 +62,8 @@ public class SecureServicePermission {
      * Factory method to create permission given type. Default instance and
      * action to ALL/*.
      *
-     * @param type
-     * @return
+     * @param type type of the permission
+     * @return instance of SecureServicePermission with type and default instance and action
      */
     public static SecureServicePermission create(String type) {
         return new SecureServicePermission(type, ALL, ALL);
@@ -72,9 +72,9 @@ public class SecureServicePermission {
     /**
      * Instantiate permission given type, instance, and action.
      *
-     * @param type
-     * @param instance
-     * @param action
+     * @param type type of the permission
+     * @param instance instance of the permission
+     * @param action action of the permission
      */
     public SecureServicePermission(String type, String instance, String action) {
         this.type = type;
@@ -99,7 +99,7 @@ public class SecureServicePermission {
     }
 
     /**
-     * Override toString - return permission in key format
+     * Override toString - return permission in key format.
      */
     @Override
     public String toString() {
@@ -110,7 +110,7 @@ public class SecureServicePermission {
      * Return Permission in Key format = type, instance, and action separate by
      * pipe character.
      *
-     * @return
+     * @return permission in key format
      */
     public String getKey() {
         return type + "|" + instance + "|" + action;
@@ -120,7 +120,7 @@ public class SecureServicePermission {
      * Return Permission in Key format = type, all instance, and action separate
      * by pipe character.
      *
-     * @return
+     * @return permission in key format
      */
     public String getKeyAllInstance() {
         return type + "|" + ALL + "|" + action;
@@ -130,7 +130,7 @@ public class SecureServicePermission {
      * Return Permission in Key format = type, all instance, and all action
      * separate by pipe character.
      *
-     * @return
+     * @return permission in key format
      */
     public String getKeyAllInstanceAction() {
         return type + "|" + ALL + "|" + ALL;
@@ -140,13 +140,15 @@ public class SecureServicePermission {
      * Return Permission in Key format = type, instance, and all action separate
      * by pipe character.
      *
-     * @return
+     * @return permission in key format
      */
     public String getKeyAllAction() {
         return type + "|" + instance + "|" + ALL;
     }
 
     /**
+     * Returns the permission type.
+     *
      * @return the type
      */
     public String getType() {
@@ -154,14 +156,17 @@ public class SecureServicePermission {
     }
 
     /**
-     * @param type
-     *            the type to set
+     * Sets the type of permission.
+     *
+     * @param type the type to set
      */
     public void setType(String type) {
         this.type = type;
     }
 
     /**
+     * Returns the instance of permission.
+     *
      * @return the instance
      */
     public String getInstance() {
@@ -169,14 +174,17 @@ public class SecureServicePermission {
     }
 
     /**
-     * @param instance
-     *            the instance to set
+     * Sets the instance of permission.
+     *
+     * @param instance the instance to set
      */
     public void setInstance(String instance) {
         this.instance = instance;
     }
 
     /**
+     * Returns the action of permission.
+     *
      * @return the action
      */
     public String getAction() {
@@ -184,8 +192,9 @@ public class SecureServicePermission {
     }
 
     /**
-     * @param action
-     *            the action to set
+     * Sets the action of permission.
+     *
+     * @param action the action to set
      */
     public void setAction(String action) {
         this.action = action;
index cfe50c9..cf8f663 100644 (file)
@@ -35,12 +35,11 @@ import org.springframework.stereotype.Controller;
 @Controller
 public class UserService {
 
-    private SecurityContext           securityContext= SecurityContextHolder.getContext();
+    private SecurityContext           securityContext = SecurityContextHolder.getContext();
 
     /**
      * REST service that returns the username.
      *
-     * @param userName
      * @return the user name
      */
     public String getUser() {
index 16a817e..ea4e097 100644 (file)
@@ -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<String, Object> nodeTypes = new LinkedHashMap<>();
         LinkedHashMap<String, Object> 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<String, Object>) ntPropertiesElement.getValue(),
                                         jsonParentObject);
-                                    LinkedHashMap<String, Object> parentPropertiesMap = (LinkedHashMap<String, Object>) ntPropertiesElement
-                                        .getValue();
+                                    LinkedHashMap<String, Object> parentPropertiesMap =
+                                            (LinkedHashMap<String, Object>) ntPropertiesElement.getValue();
                                     if (parentPropertiesMap.containsKey(ToscaSchemaConstants.TYPE)
                                         && ((String) parentPropertiesMap.get(ToscaSchemaConstants.TYPE))
                                             .contains(ToscaSchemaConstants.TYPE_MAP)
index a8f233e..85b3f5c 100644 (file)
@@ -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);
index 0633009..fd7a9a0 100644 (file)
@@ -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;
     }
index 07c4147..f08bf7b 100644 (file)
@@ -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;
index eaa1b2a..7f4c878 100644 (file)
@@ -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");
index 47b4f9a..08bb976 100644 (file)
@@ -60,14 +60,15 @@ public class LoggingUtils {
     private static final String EMPTY_MESSAGE = "";\r
 \r
     /** Logger delegate. */\r
-    private EELFLogger mLogger;\r
+    private EELFLogger mlogger;\r
     /** Automatic UUID, overrideable per adapter or per invocation. */\r
     private static UUID sInstanceUUID = UUID.randomUUID();\r
+\r
     /**\r
-     * Constructor\r
+     * Constructor.\r
      */\r
     public LoggingUtils(final EELFLogger loggerP) {\r
-        this.mLogger = checkNotNull(loggerP);\r
+        this.mlogger = checkNotNull(loggerP);\r
     }\r
 \r
     /**\r
@@ -173,20 +174,21 @@ public class LoggingUtils {
     /**\r
      * Report <tt>ENTERING</tt> marker.\r
      *\r
-     * @param request non-null incoming request (wrapper).\r
-     * @return this.\r
+     * @param request non-null incoming request (wrapper)\r
+     * @param serviceName service name\r
      */\r
     public void entering(HttpServletRequest request, String serviceName) {\r
         MDC.clear();\r
         checkNotNull(request);\r
         // Extract MDC values from standard HTTP headers.\r
-        final String requestID = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.REQUEST_ID));\r
-        final String invocationID = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.INVOCATION_ID));\r
+        final String requestId = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.REQUEST_ID));\r
+        final String invocationId = defaultToUUID(request.getHeader(ONAPLogConstants.Headers.INVOCATION_ID));\r
         final String partnerName = defaultToEmpty(request.getHeader(ONAPLogConstants.Headers.PARTNER_NAME));\r
 \r
         // Default the partner name to the user name used to login to clamp\r
         if (partnerName.equalsIgnoreCase(EMPTY_MESSAGE)) {\r
-            MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, new DefaultUserNameHandler().retrieveUserName(SecurityContextHolder.getContext()));\r
+            MDC.put(ONAPLogConstants.MDCs.PARTNER_NAME, new DefaultUserNameHandler()\r
+                    .retrieveUserName(SecurityContextHolder.getContext()));\r
         }\r
 \r
         // Set standard MDCs. Override this entire method if you want to set\r
@@ -196,28 +198,31 @@ public class LoggingUtils {
         MDC.put(ONAPLogConstants.MDCs.ENTRY_TIMESTAMP,\r
             ZonedDateTime.now(ZoneOffset.UTC)\r
             .format(DateTimeFormatter.ISO_INSTANT));\r
-        MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestID);\r
-        MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationID);\r
+        MDC.put(ONAPLogConstants.MDCs.REQUEST_ID, requestId);\r
+        MDC.put(ONAPLogConstants.MDCs.INVOCATION_ID, invocationId);\r
         MDC.put(ONAPLogConstants.MDCs.CLIENT_IP_ADDRESS, defaultToEmpty(request.getRemoteAddr()));\r
         MDC.put(ONAPLogConstants.MDCs.SERVER_FQDN, defaultToEmpty(request.getServerName()));\r
         MDC.put(ONAPLogConstants.MDCs.INSTANCE_UUID, defaultToEmpty(sInstanceUUID));\r
 \r
         // Default the service name to the requestURI, in the event that\r
         // no value has been provided.\r
-        if (serviceName == null ||\r
-            serviceName.equalsIgnoreCase(EMPTY_MESSAGE)) {\r
+        if (serviceName == null\r
+                || serviceName.equalsIgnoreCase(EMPTY_MESSAGE)) {\r
             MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, request.getRequestURI());\r
         } else {\r
             MDC.put(ONAPLogConstants.MDCs.SERVICE_NAME, serviceName);\r
         }\r
 \r
-        this.mLogger.info(ONAPLogConstants.Markers.ENTRY);\r
+        this.mlogger.info(ONAPLogConstants.Markers.ENTRY);\r
     }\r
 \r
     /**\r
      * Report <tt>EXITING</tt> marker.\r
      *\r
-     * @return this.\r
+     * @param code response code\r
+     * @param descrption response description\r
+     * @param severity response severity\r
+     * @param status response status code\r
      */\r
     public void exiting(String code, String descrption, Level severity, ONAPLogConstants.ResponseStatus status) {\r
         try {\r
@@ -225,7 +230,7 @@ public class LoggingUtils {
             MDC.put(ONAPLogConstants.MDCs.RESPONSE_DESCRIPTION, defaultToEmpty(descrption));\r
             MDC.put(ONAPLogConstants.MDCs.RESPONSE_SEVERITY, defaultToEmpty(severity));\r
             MDC.put(ONAPLogConstants.MDCs.RESPONSE_STATUS_CODE, defaultToEmpty(status));\r
-            this.mLogger.info(ONAPLogConstants.Markers.EXIT);\r
+            this.mlogger.info(ONAPLogConstants.Markers.EXIT);\r
         }\r
         finally {\r
             MDC.clear();\r
@@ -236,28 +241,29 @@ public class LoggingUtils {
      * Report pending invocation with <tt>INVOKE</tt> marker,\r
      * setting standard ONAP logging headers automatically.\r
      *\r
-     * @param builder request builder, for setting headers.\r
-     * @param sync whether synchronous, nullable.\r
-     * @return invocation ID to be passed with invocation.\r
+     * @param con http URL connection\r
+     * @param targetEntity target entity\r
+     * @param targetServiceName target service name\r
+     * @return invocation ID to be passed with invocation\r
      */\r
     public HttpURLConnection invoke(final HttpURLConnection con, String targetEntity, String targetServiceName) {\r
-        final String invocationID = UUID.randomUUID().toString();\r
+        final String invocationId = UUID.randomUUID().toString();\r
 \r
         // Set standard HTTP headers on (southbound request) builder.\r
         con.setRequestProperty(ONAPLogConstants.Headers.REQUEST_ID,\r
             defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.REQUEST_ID)));\r
         con.setRequestProperty(ONAPLogConstants.Headers.INVOCATION_ID,\r
-            invocationID);\r
+            invocationId);\r
         con.setRequestProperty(ONAPLogConstants.Headers.PARTNER_NAME,\r
             defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME)));\r
 \r
-        invokeContext(targetEntity, targetServiceName, invocationID);\r
+        invokeContext(targetEntity, targetServiceName, invocationId);\r
 \r
         // Log INVOKE*, with the invocationID as the message body.\r
         // (We didn't really want this kind of behavior in the standard,\r
         // but is it worse than new, single-message MDC?)\r
-        this.mLogger.info(ONAPLogConstants.Markers.INVOKE);\r
-        this.mLogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{"+ invocationID +"}");\r
+        this.mlogger.info(ONAPLogConstants.Markers.INVOKE);\r
+        this.mlogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{" + invocationId + "}");\r
         return con;\r
     }\r
 \r
@@ -265,43 +271,47 @@ public class LoggingUtils {
      * Report pending invocation with <tt>INVOKE</tt> marker,\r
      * setting standard ONAP logging headers automatically.\r
      *\r
-     * @param builder request builder, for setting headers.\r
-     * @param sync whether synchronous, nullable.\r
-     * @return invocation ID to be passed with invocation.\r
+     * @param con http URL connection\r
+     * @param targetEntity target entity\r
+     * @param targetServiceName target service name\r
+     * @return invocation ID to be passed with invocation\r
      */\r
     public HttpsURLConnection invokeHttps(final HttpsURLConnection con, String targetEntity, String targetServiceName) {\r
-        final String invocationID = UUID.randomUUID().toString();\r
+        final String invocationId = UUID.randomUUID().toString();\r
 \r
         // Set standard HTTP headers on (southbound request) builder.\r
         con.setRequestProperty(ONAPLogConstants.Headers.REQUEST_ID,\r
             defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.REQUEST_ID)));\r
         con.setRequestProperty(ONAPLogConstants.Headers.INVOCATION_ID,\r
-            invocationID);\r
+            invocationId);\r
         con.setRequestProperty(ONAPLogConstants.Headers.PARTNER_NAME,\r
             defaultToEmpty(MDC.get(ONAPLogConstants.MDCs.PARTNER_NAME)));\r
 \r
-        invokeContext(targetEntity, targetServiceName, invocationID);\r
+        invokeContext(targetEntity, targetServiceName, invocationId);\r
 \r
         // Log INVOKE*, with the invocationID as the message body.\r
         // (We didn't really want this kind of behavior in the standard,\r
         // but is it worse than new, single-message MDC?)\r
-        this.mLogger.info(ONAPLogConstants.Markers.INVOKE);\r
-        this.mLogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{"+ invocationID +"}");\r
+        this.mlogger.info(ONAPLogConstants.Markers.INVOKE);\r
+        this.mlogger.info(ONAPLogConstants.Markers.INVOKE_SYNC + "{" + invocationId + "}");\r
         return con;\r
     }\r
 \r
+    /**\r
+     * Invokes return context.\r
+     */\r
     public void invokeReturn() {\r
         // Add the Invoke-return marker and clear the needed MDC\r
-        this.mLogger.info(ONAPLogConstants.Markers.INVOKE_RETURN);\r
+        this.mlogger.info(ONAPLogConstants.Markers.INVOKE_RETURN);\r
         invokeReturnContext();\r
     }\r
 \r
     /**\r
      * Dependency-free nullcheck.\r
      *\r
-     * @param in to be checked.\r
-     * @param <T> argument (and return) type.\r
-     * @return input arg.\r
+     * @param in to be checked\r
+     * @param <T> argument (and return) type\r
+     * @return input arg\r
      */\r
     private static <T> T checkNotNull(final T in) {\r
         if (in == null) {\r
@@ -313,8 +323,8 @@ public class LoggingUtils {
     /**\r
      * Dependency-free string default.\r
      *\r
-     * @param in to be filtered.\r
-     * @return input string or null.\r
+     * @param in to be filtered\r
+     * @return input string or null\r
      */\r
     private static String defaultToEmpty(final Object in) {\r
         if (in == null) {\r
@@ -326,8 +336,8 @@ public class LoggingUtils {
     /**\r
      * Dependency-free string default.\r
      *\r
-     * @param in to be filtered.\r
-     * @return input string or null.\r
+     * @param in to be filtered\r
+     * @return input string or null\r
      */\r
     private static String defaultToUUID(final String in) {\r
         if (in == null) {\r
@@ -337,13 +347,13 @@ public class LoggingUtils {
     }\r
 \r
     /**\r
-     * Set target related logging variables in thread local data via MDC\r
+     * Set target related logging variables in thread local data via MDC.\r
      *\r
      * @param targetEntity Target entity (an external/sub component, for ex. "sdc")\r
      * @param targetServiceName Target service name (name of API invoked on target)\r
-     * @param invocationId The invocation ID\r
+     * @param invocationID The invocation ID\r
      */\r
-    private void invokeContext (String targetEntity, String targetServiceName, String invocationID) {\r
+    private void invokeContext(String targetEntity, String targetServiceName, String invocationID) {\r
         MDC.put(ONAPLogConstants.MDCs.TARGET_ENTITY, defaultToEmpty(targetEntity));\r
         MDC.put(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME, defaultToEmpty(targetServiceName));\r
         MDC.put(ONAPLogConstants.MDCs.INVOCATIONID_OUT, invocationID);\r
@@ -353,10 +363,9 @@ public class LoggingUtils {
     }\r
 \r
     /**\r
-     * Clear target related logging variables in thread local data via MDC\r
-     *\r
+     * Clear target related logging variables in thread local data via MDC.\r
      */\r
-    private void invokeReturnContext () {\r
+    private void invokeReturnContext() {\r
         MDC.remove(ONAPLogConstants.MDCs.TARGET_ENTITY);\r
         MDC.remove(ONAPLogConstants.MDCs.TARGET_SERVICE_NAME);\r
         MDC.remove(ONAPLogConstants.MDCs.INVOCATIONID_OUT);\r
index 391f008..a812fa1 100644 (file)
@@ -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);
     }
 }
index f49e735..46aa67b 100755 (executable)
@@ -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;
index ef4c4e4..c4ced5e 100755 (executable)
@@ -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;
     }
 
index 4d76581..ce21c4c 100644 (file)
@@ -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) {
index 6263f30..fe2d5cb 100755 (executable)
@@ -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;
index 095df9d..c92cdcf 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2019 Nokia Intellectual Property. All rights
  *                             reserved.
  * ================================================================================
+ * Modifications Copyright (c) 2019 Samsung
+ * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
@@ -31,7 +33,9 @@ import static org.mockito.Mockito.when;
 import com.google.gson.JsonObject;
 import java.io.IOException;
 import org.junit.Test;
+import org.mockito.Mockito;
 import org.onap.clamp.clds.config.ClampProperties;
+import org.onap.clamp.clds.exception.TcaRequestFormatterException;
 import org.onap.clamp.clds.model.properties.ModelProperties;
 import org.onap.clamp.clds.model.properties.Tca;
 import org.onap.clamp.clds.model.properties.TcaItem;
@@ -95,4 +99,18 @@ public class TcaRequestFormatterTest {
         //then
         assertThat(expectedRequest).isEqualTo(policyContent);
     }
+
+    @Test(expected = TcaRequestFormatterException.class)
+    public void shouldThrowTcaRequestFormatterException() throws IOException{
+        //given
+        String service = "TestService";
+        String policy = "TestService_scope.PolicyName";
+        ClampProperties clampProperties =  mock(ClampProperties.class);
+        ModelProperties modelProperties = mock(ModelProperties.class);
+        Tca tca = mock(Tca.class);
+        //when
+        Mockito.when(clampProperties.getJsonTemplate(any(), any())).thenThrow(IOException.class);
+        //then
+        TcaRequestFormatter.createPolicyContent(clampProperties, modelProperties, service, policy, tca);
+    }
 }
\ No newline at end of file
index 871d0a6..31d0be8 100644 (file)
@@ -5,6 +5,8 @@
  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights\r
  *                             reserved.\r
  * ================================================================================\r
+ * Modifications Copyright (c) 2019 Samsung\r
+ * ================================================================================\r
  * Licensed under the Apache License, Version 2.0 (the "License");\r
  * you may not use this file except in compliance with the License.\r
  * You may obtain a copy of the License at\r
@@ -26,7 +28,6 @@ package org.onap.clamp.clds.model.prop;
 import com.google.gson.JsonObject;\r
 import org.onap.clamp.clds.model.properties.AbstractModelElement;\r
 import org.onap.clamp.clds.model.properties.ModelBpmn;\r
-import org.onap.clamp.clds.model.properties.ModelProperties;\r
 import org.onap.clamp.clds.util.JsonUtils;\r
 \r
 /**\r
@@ -40,8 +41,8 @@ public class CustomModelElement extends AbstractModelElement {
     /**\r
      * Main Constructor.\r
      */\r
-    public CustomModelElement(ModelProperties modelProp, ModelBpmn modelBpmn, JsonObject modelJson) {\r
-        super(CUSTOM_TYPE, modelProp, modelBpmn, modelJson);\r
+    public CustomModelElement(ModelBpmn modelBpmn, JsonObject modelJson) {\r
+        super(CUSTOM_TYPE, modelBpmn, modelJson);\r
         topicPublishes = JsonUtils.getStringValueByName(modelElementJsonNode, "topicPublishes");\r
         test = JsonUtils.getStringValueByName(modelElementJsonNode, "test");\r
     }\r