From b5effae3fcf7dabcd3194ff27d4ee98ab654ca26 Mon Sep 17 00:00:00 2001
From: SunilB <SB00577584@techmahindra.com>
Date: Fri, 26 Jul 2019 09:37:49 +0530
Subject: Javadoc and logging improvement

Added Javadocs for VnfAdapterVfModuleResources and
VnfTopologyOperationRequestMapper classes

Issue-ID: SO-2052
Signed-off-by: sunilb <sb00577584@techmahindra.com>
Change-Id: Iec6addb415720f63c32b5ab99e63aefe0ef3235a
---
 .../orchestration/VnfAdapterVfModuleResources.java | 34 ++++++++++++++++++++++
 .../mapper/VnfTopologyOperationRequestMapper.java  | 16 ++++++++++
 2 files changed, 50 insertions(+)

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/orchestration/VnfAdapterVfModuleResources.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/orchestration/VnfAdapterVfModuleResources.java
index 0a825b8424..62d6a110f6 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/orchestration/VnfAdapterVfModuleResources.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/orchestration/VnfAdapterVfModuleResources.java
@@ -39,12 +39,33 @@ import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+/**
+ * This class is used for creating and deleting the request for VfModule.
+ *
+ */
 @Component
 public class VnfAdapterVfModuleResources {
 
     @Autowired
     private VnfAdapterVfModuleObjectMapper vnfAdapterVfModuleObjectMapper;
 
+    /**
+     * This method is used for creating the request for the VfModule.
+     *
+     * This method take these parameter and call the VnfAdapterVfModuleObjectMapper to create the request.
+     *
+     * @param requestContext
+     * @param cloudRegion
+     * @param orchestrationContext
+     * @param serviceInstance
+     * @param genericVnf
+     * @param vfModule
+     * @param volumeGroup
+     * @param sdncVnfQueryResponse
+     * @param sdncVfModuleQueryResponse
+     * @throws IOException & MissingValueTagException
+     * @return
+     */
     public CreateVfModuleRequest createVfModuleRequest(RequestContext requestContext, CloudRegion cloudRegion,
             OrchestrationContext orchestrationContext, ServiceInstance serviceInstance, GenericVnf genericVnf,
             VfModule vfModule, VolumeGroup volumeGroup, String sdncVnfQueryResponse, String sdncVfModuleQueryResponse)
@@ -54,6 +75,19 @@ public class VnfAdapterVfModuleResources {
                 sdncVfModuleQueryResponse);
     }
 
+    /**
+     * This method is used for delete the request for the VfModule.
+     *
+     * This method take these parameter and call the VnfAdapterVfModuleObjectMapper to delete the request.
+     *
+     * @param requestContext
+     * @param cloudRegion
+     * @param serviceInstance
+     * @param genericVnf
+     * @param vfModule
+     * @throws IOException
+     * @return
+     */
     public DeleteVfModuleRequest deleteVfModuleRequest(RequestContext requestContext, CloudRegion cloudRegion,
             ServiceInstance serviceInstance, GenericVnf genericVnf, VfModule vfModule) throws IOException {
         return vnfAdapterVfModuleObjectMapper.deleteVfModuleRequestMapper(requestContext, cloudRegion, serviceInstance,
diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/sdnc/mapper/VnfTopologyOperationRequestMapper.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/sdnc/mapper/VnfTopologyOperationRequestMapper.java
index bef4ec3465..fd0af3a4dd 100644
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/sdnc/mapper/VnfTopologyOperationRequestMapper.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/client/sdnc/mapper/VnfTopologyOperationRequestMapper.java
@@ -55,6 +55,22 @@ public class VnfTopologyOperationRequestMapper {
     @Autowired
     private GeneralTopologyObjectMapper generalTopologyObjectMapper;
 
+    /**
+     * This method is used for creating the vnf request.
+     *
+     * By these parameter it will get he detailas and prepare the request.
+     *
+     * @param svcOperation
+     * @param svcAction
+     * @param requestAction
+     * @param vnf
+     * @param serviceInstance
+     * @param customer
+     * @param cloudRegion
+     * @param requestContext
+     * @param homing
+     * @return request
+     */
     public GenericResourceApiVnfOperationInformation reqMapper(SDNCSvcOperation svcOperation, SDNCSvcAction svcAction,
             GenericResourceApiRequestActionEnumeration requestAction, GenericVnf vnf, ServiceInstance serviceInstance,
             Customer customer, CloudRegion cloudRegion, RequestContext requestContext, boolean homing,
-- 
cgit 1.2.3-korg