Merge "Fix javadoc"
authorRob Daugherty <rd472p@att.com>
Wed, 7 Mar 2018 18:32:31 +0000 (18:32 +0000)
committerGerrit Code Review <gerrit@onap.org>
Wed, 7 Mar 2018 18:32:31 +0000 (18:32 +0000)
22 files changed:
adapters/mso-requests-db-adapter/src/main/java/org/openecomp/mso/adapters/requestsdb/MsoRequestsDbAdapterImpl.java
adapters/mso-vfc-adapter/src/main/java/org/openecomp/mso/adapters/vfc/VfcAdapterRest.java
adapters/mso-vfc-adapter/src/main/java/org/openecomp/mso/adapters/vfc/exceptions/ApplicationException.java
adapters/mso-vfc-adapter/src/main/java/org/openecomp/mso/adapters/vfc/util/ValidateUtil.java
adapters/mso-vfc-adapter/src/test/java/org/openecomp/mso/adapters/vfc/VfcAdapterTest.java
adapters/mso-vnf-adapter/src/main/java/org/openecomp/mso/adapters/vnf/MsoVnfAdapterAsyncImpl.java
adapters/mso-vnf-adapter/src/main/java/org/openecomp/mso/vdu/utils/VduPlugin.java
asdc-controller/src/main/java/org/openecomp/mso/asdc/client/ASDCGlobalController.java
bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/bpmn/common/util/CryptoUtils.java
bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/client/appc/ApplicationControllerSupport.java
bpmn/MSOCommonBPMN/src/main/java/org/openecomp/mso/client/sdno/SDNOValidator.java
bpmn/MSOCommonBPMN/src/test/java/org/openecomp/mso/bpmn/common/WorkflowTest.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/PropertyConfiguration.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/PropertyConfigurationSetup.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/domain/VnfResource.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/json/JsonUtils.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/mybatis/URNMapping.java
bpmn/MSOCoreBPMN/src/main/java/org/openecomp/mso/bpmn/core/xml/XmlTool.java
bpmn/MSORESTClient/src/main/java/org/openecomp/mso/rest/RESTClient.java
mso-api-handlers/mso-requests-db/src/main/java/org/openecomp/mso/requestsdb/RequestsDatabase.java
mso-catalog-db/src/main/java/org/openecomp/mso/db/catalog/CatalogDatabase.java
mso-catalog-db/src/main/java/org/openecomp/mso/db/catalog/beans/ModelRecipe.java

index 0b404d7..99f6e86 100644 (file)
@@ -333,7 +333,7 @@ public class MsoRequestsDbAdapterImpl implements MsoRequestsDbAdapter {
      * 
      * @param serviceId
      * @param operationId
-     * @param resourceUUID
+     * @param resourceTemplateUUID
      * @return
      * @throws MsoRequestsDbException
      * @since   ONAP Amsterdam Release
@@ -350,7 +350,7 @@ public class MsoRequestsDbAdapterImpl implements MsoRequestsDbAdapter {
      * 
      * @param serviceId
      * @param operationId
-     * @param resourceUUID
+     * @param resourceTemplateUUID
      * @param operationType
      * @param resourceInstanceID
      * @param jobId
@@ -363,13 +363,13 @@ public class MsoRequestsDbAdapterImpl implements MsoRequestsDbAdapter {
      */
     @Override
     public void updateResourceOperationStatus(String serviceId, String operationId, String resourceTemplateUUID,
-            String operType, String resourceInstanceID, String jobId, String status, String progress,
+            String operationType, String resourceInstanceID, String jobId, String status, String progress,
             String errorCode, String statusDescription) throws MsoRequestsDbException {
          ResourceOperationStatus resStatus = new ResourceOperationStatus();
          resStatus.setServiceId(serviceId);
          resStatus.setOperationId(operationId);
          resStatus.setResourceTemplateUUID(resourceTemplateUUID);
-         resStatus.setOperType(operType);
+         resStatus.setOperType(operationType);
          resStatus.setResourceInstanceID(resourceInstanceID);
          resStatus.setJobId(jobId);
          resStatus.setStatus(status);
index 48da1ab..5f779dd 100644 (file)
@@ -60,7 +60,7 @@ public class VfcAdapterRest {
     /**
      * Create a NS <br>
      * 
-     * @param servletReq the http request
+     * @param data the http request
      * @return
      * @since ONAP Amsterdam Release
      */
index 61966d0..30d42ae 100644 (file)
@@ -39,7 +39,7 @@ public class ApplicationException extends Exception {
      * </p>
      * 
      * @param errorCode error status
-     * @param errorDetail error detail
+     * @param errorMsg error detail
      * @since ONAP Amsterdam Release 2017-9-6
      */
     public ApplicationException(int errorCode, String errorMsg) {
index c79d09e..13727bd 100644 (file)
@@ -47,7 +47,7 @@ public class ValidateUtil {
    * Assert String parameter.<br/>\r
    * \r
    * @param paramValue parameter data\r
-   * @param name of parameter\r
+   * @param paramName parameter name\r
    * @since ONAP Amsterdam Release 2017-9-6\r
    */\r
   public static void assertStringNotNull(String paramValue, String paramName)\r
index 95d3bf6..759ceed 100644 (file)
@@ -60,7 +60,7 @@ public class VfcAdapterTest {
     /**
      * mock get request body <br>
      * 
-     * @param request
+     * @param fileName
      * @return
      * @since ONAP Amsterdam Release
      */
@@ -71,7 +71,6 @@ public class VfcAdapterTest {
     /**
      * Mock the request body form a file <br>
      * 
-     * @param fileName
      * @since ONAP Amsterdam Release
      */
     private void mockRestfulUtil() {
index 4842580..5c65429 100644 (file)
@@ -371,8 +371,9 @@ public class MsoVnfAdapterAsyncImpl implements MsoVnfAdapterAsync {
      * @param cloudSiteId CLLI code of the cloud site in which to delete
      * @param tenantId Openstack tenant identifier
      * @param vnfName VNF Name or Openstack ID
+     * @param messageId
      * @param msoRequest Request tracking information for logs
-     * @param notificationURL the target URL for asynchronous response
+     * @param notificationUrl the target URL for asynchronous response
      */
     @Override
     public void deleteVnfA (String cloudSiteId,
index 3452a10..856b713 100755 (executable)
@@ -145,7 +145,7 @@ public interface VduPlugin {
      * @param tenantId The cloud tenant in which to delete the VDU.
      * @param vduInstanceId The unique id of the deployment to delete.
      * @param timeoutMinutes Timeout after which the delete action will be cancelled
-     * @param deleteBlueprint Flag to also delete the blueprint
+     * @param keepBlueprintLoaded Flag to also delete the blueprint
      * 
      * @return A VduInfo object, representing the state of the instance just prior to deletion.
      * 
index 295dddd..430bd10 100644 (file)
@@ -78,7 +78,7 @@ public class ASDCGlobalController {
     
     /**
      * Check that controllers list needs to be updated or not.
-     * @param return true if the list has been updated
+     * return true if the list has been updated
      */
     private boolean updateControllersListIfNeeded ()  {
        boolean updateNeeded=false;
index 5972c76..2ad1e30 100644 (file)
@@ -38,11 +38,10 @@ public class CryptoUtils {
     public static final String AES = "AES";\r
 \r
     /**\r
-    * encrypt a value and generate a keyfile\r
+     * encrypt a value and generate a keyfile\r
      * if the keyfile is not found then a new one is created\r
-    * @throws GeneralSecurityException\r
-     * @throws IOException\r
-     */\r
+     * @throws GeneralSecurityException\r
+     * */\r
     public static String encrypt(String value, String keyString) throws GeneralSecurityException\r
     {\r
         SecretKeySpec sks = getSecretKeySpec(keyString);\r
@@ -53,9 +52,8 @@ public class CryptoUtils {
     }\r
 \r
     /**\r
-    * decrypt a value\r
+     * decrypt a value\r
      * @throws GeneralSecurityException\r
-     * @throws IOException\r
      */\r
     public static String decrypt(String message, String keyString) throws GeneralSecurityException\r
     {\r
index 765bf61..f7db52b 100644 (file)
@@ -71,7 +71,7 @@ public class ApplicationControllerSupport {
        }
 
        /**
-        * @param inputClass
+        * @param action
         * @return
         * @throws ClassNotFoundException
         * @throws InstantiationException
index c746c0d..df30e43 100644 (file)
@@ -27,8 +27,8 @@ public interface SDNOValidator {
        /**
         * Issues a health diagnostic request for a given vnf to SDN-O
         * 
-        * @param vnfName
-        * @param uuid
+        * @param vnfId
+        * @param requestingUserId
         * @throws IOException
         * @throws Exception
         */
index b71f708..6f0095f 100644 (file)
@@ -1829,7 +1829,7 @@ public class WorkflowTest {
                /**\r
                 * Constructor\r
                 * @param contentType the HTTP content type (optional)\r
-                * @param type the callback message type (optional)\r
+                * @param messageType the callback message type (optional)\r
                 * @param content the content\r
                 */\r
                public CallbackData(String contentType, String messageType, String content) {\r
index 6059a35..b627205 100644 (file)
@@ -238,7 +238,6 @@ public class PropertyConfiguration {
         * Reads properties from the specified file, updates the property file cache, and
         * returns the properties in a map.
         * @param file the file to read
-        * @param reload true if this is a reload event
         * @return a map of properties
         */
        private Map<String, String> readProperties(File file) throws IOException {
index b972d6a..a1719a9 100644 (file)
@@ -176,7 +176,7 @@ public class PropertyConfigurationSetup {
         * PropertyConfiguration, just like they do when a property file is updated on
         * a real MSO system. This method will optionally wait for the new properties
         * to be loaded.  Timeout results in an IOException.
-        * @param values new properties
+        * @param properties new properties
         * @param wait maximum amount of time to wait for new properties to be loaded,
         *             in milliseconds.  A value of zero means, "Do not wait."
         * @throws IOException
index a09f5a7..20903c0 100644 (file)
@@ -146,7 +146,6 @@ public class VnfResource extends Resource {
         * \r
         * default setter for this field deprecated\r
         * @param modelName << serviceResources.modelInfo.modelName\r
-        * @param modelInstanceName\r
         */\r
        public void constructVnfType(String modelName) {\r
                this.vnfType = modelName.concat("/").concat(this.modelInfo.getModelInstanceName());\r
index 2612c38..b0152a1 100644 (file)
@@ -117,7 +117,7 @@ public class JsonUtils {
         * to convert a JSONObject to an XML Doc. The intent of this is to\r
         * correctly generate XML from JSON including TAGs for JSONArrays\r
         *\r
-        * @param  jsonObj      org.json.JSON object to be converted to XML\r
+        * @param  obj object to be converted to XML\r
         * @param  tagName      optional XML tagname supplied primarily during recursive calls\r
         * @return String containing the XML translation\r
         */\r
@@ -913,7 +913,7 @@ public class JsonUtils {
         * and puts it in a Java List<String>.\r
         *\r
         * @param execution\r
-        * @param stringArray - the getJsonValue of a json array of strings\r
+        * @param jsonArrayOfStrings - the getJsonValue of a json array of strings\r
         *\r
         * @return List - a java list containing the strings\r
         *\r
index 177fafc..c48b671 100644 (file)
@@ -93,7 +93,7 @@ public class URNMapping {
         * aai:endpoint becomes URN_aai_endpoint <br/>
         * ae:internal-reporting becomes URN_ae_internal_reporting <br/>
         * 
-        * @param name the URN
+        * @param urn the URN
         * @return a normalized identifier
         */
        public static String createIdentifierFromURN(String urn) {
index f5b9f8d..1fc43ba 100644 (file)
@@ -130,7 +130,7 @@ public final class XmlTool {
 
        /**
         * Encodes a value so it can be used inside an XML text element.
-        * @param s the string to encode
+        * @param value the string to encode
         * @return the encoded string
         */
        public static String encode(Object value) {
@@ -171,7 +171,7 @@ public final class XmlTool {
        
        /**
         * Encodes a value so it can be used inside an XML attribute.
-        * @param s the string to encode
+        * @param value the string to encode
         * @return the encoded string
         */
        public static String encodeAttr(Object value) {
index 87f5786..3170e49 100644 (file)
@@ -242,16 +242,16 @@ public class RESTClient {
     /**
      * Creates a RESTClient with the RESTConfig object.
      *
-     * @param RESTConfig config to use for sending request
+     * @param restConfig config to use for sending request
      *
      * @throws RESTException if unable to create a RESTClient
      */
-    public RESTClient(RESTConfig cfg) throws RESTException {
+    public RESTClient(RESTConfig restConfig) throws RESTException {
         this.headers = new LinkedHashMap<>();
         this.parameters = new LinkedHashMap<>();
-        this.URL = cfg.getURL();
-        this.proxyHost = cfg.getProxyHost();
-        this.proxyPort = cfg.getProxyPort();
+        this.URL = restConfig.getURL();
+        this.proxyHost = restConfig.getProxyHost();
+        this.proxyPort = restConfig.getProxyPort();
     }
 
     /**
index 7f2f78d..d6b0b6b 100644 (file)
@@ -699,7 +699,7 @@ public class RequestsDatabase {
      * update the resource operation
      * <br>
      * 
-     * @param operstatus the resource operation object
+     * @param operStatus the resource operation object
      * @since ONAP Amsterdam Release
      */
     public void updateResOperStatus(ResourceOperationStatus operStatus) {
index bd3b988..c556dda 100644 (file)
@@ -1638,7 +1638,7 @@ public class CatalogDatabase implements Closeable {
      * Return the VnfResourceCustomization object identified by the given modelCustomizationUuid 1707
      * Note that the corresponding VnfResource Object will be put in the VnfResourceCustomization bean
      *
-     * @param getVnfResourceCustomizationByModelVersionId
+     * @param modelVersionId
      * @return VnfResourceCustomization or null if not found
      */
     public VnfResourceCustomization getVnfResourceCustomizationByModelVersionId(String modelVersionId) {
@@ -1920,7 +1920,7 @@ public class CatalogDatabase implements Closeable {
      * Return the VnfResourceCustomization object identified by the given modelCustomizationUuid 1707
      * Note that the corresponding VnfResource Object will be put in the VnfResourceCustomization bean
      *
-     * @param modelCustomizationUuid
+     * @param modelUuid
      * @return VnfResourceCustomization or null if not found
      */
     public VnfResource getVnfResourceByModelUuid(String modelUuid) {
@@ -2828,7 +2828,7 @@ public class CatalogDatabase implements Closeable {
      * Return a VNF Module List that matches a given VNF_TYPE, VF_MODULE_MODEL_NAME,
      * ASDC_SERVICE_MODEL_VERSION, MODEL_VERSION, and ACTION
      *
-     * @param vnfModuleType
+     * @param vfModuleType
      * @parm modelCustomizationUuid
      * @param asdcServiceModelVersion
      * @param modelVersion
@@ -3366,7 +3366,9 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a ServiceToResourceCustomization object 
      * 
-     * @param vfModuleModelUuid, heatFilesArtifactUuid
+     * @param serviceModelUuid
+     * @param resourceModelCustomizationUuid
+     * @param modelType
      * @return VfModuleToHeatFiles or null if none found
      */ 
     public ServiceToResourceCustomization getServiceToResourceCustomization(String serviceModelUuid, String resourceModelCustomizationUuid, String modelType) {
@@ -3392,7 +3394,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a Map<String, HeatFiles> for returning the heat files associated with a vfModule 1707
      * 
-     * @param parentHeatTemplateId
+     * @param vfModuleModelUuid
      * @return Map<String,Object> or null if none found
      */ 
     public Map <String, HeatFiles> getHeatFilesForVfModule(String vfModuleModelUuid) {
@@ -3608,7 +3610,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Retrieves a Heat environment from DB based on its unique key. 1707
      *
-     * @param name the environment artifact name
+     * @param artifactUuid the environment artifact name
      * @param version the environment resource version
      * @return the heat environment from DB or null if not found
      */
@@ -3841,7 +3843,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return the newest version of a specific Tosca CSAR Record resource (queried by Name).
      *
-     * @param ToscaCsar
+     * @param artifactChecksum
      * @return ToscaCsar object or null if none found
      */
     public ToscaCsar getToscaCsar (String artifactChecksum) {
@@ -4404,9 +4406,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a Network Resource that matches the Network Customization defined by given MODEL_CUSTOMIZATION_UUID
      *
-     * @param networkType
-     * @param action
-     * @param serviceType
+     * @param modelUUID
      * @return NetworkRecipe object or null if none found
      */
     public NetworkResource getNetworkResourceByModelUuid(String modelUUID) {
@@ -4588,9 +4588,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a Network Resource that matches the Network Customization defined by given MODEL_CUSTOMIZATION_UUID
      *
-     * @param networkType
-     * @param action
-     * @param serviceType
+     * @param modelCustomizationUuid
      * @return NetworkRecipe object or null if none found
      */
     public NetworkResource getNetworkResourceByModelCustUuid(String modelCustomizationUuid) {
@@ -4679,7 +4677,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a VnfComponents recipe that matches a given VF_MODULE_ID, VNF_COMPONENT_TYPE, ACTION
      *
-     * @param vfModuleId
+     * @param vfModuleModelUUId
      * @param vnfComponentType
      * @param action
      * @return VnfComponentsRecipe object or null if none found
@@ -4801,7 +4799,7 @@ public class CatalogDatabase implements Closeable {
     /**
      * Return a VfModule record that matches a given MODEL_NAME
      *
-     * @param modelName
+     * @param modelUUID
      * @return VfModule object or null if none found
      */
     public VfModule getVfModuleByModelUUID (String modelUUID) {
index 7f8c3db..7ef5a4a 100644 (file)
@@ -89,7 +89,7 @@ public class ModelRecipe extends MavenLikeVersioning implements Serializable {
        }
 
        /**
-        * @param versionStr the versionStr to set
+        * @param schemaVersion the versionStr to set
         */
        public void setSchemaVersion(String schemaVersion) {
                this.schemaVersion = schemaVersion;