Javadoc and logging improvement

Added Javadocs for VnfAdapterCreateTasks and SDNCAssignTasks.

Change-Id: Ifb76e278eb90ba2d4644b649e91c1ffb15c55101
Issue-ID: SO-2052
Signed-off-by: Manamohan <MS00534989@Techmahindra.com>

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnf/tasks/VnfAdapterCreateTasks.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnf/tasks/VnfAdapterCreateTasks.java
index b257e91..9396f9d 100644 (file)
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnf/tasks/VnfAdapterCreateTasks.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/adapter/vnf/tasks/VnfAdapterCreateTasks.java
@@ -59,6 +59,12 @@ public class VnfAdapterCreateTasks {
     @Autowired
     private ExceptionBuilder exceptionUtil;
 
+    /**
+     * This method is used for creating the request for the VolumeGroup.
+     *
+     * @param execution
+     * @return
+     */
     public void createVolumeGroupRequest(BuildingBlockExecution execution) {
         try {
             GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();
@@ -93,6 +99,12 @@ public class VnfAdapterCreateTasks {
     }
 
 
+    /**
+     * This method is used for creating the request for the VfModule.
+     *
+     * @param execution
+     * @return
+     */
     public void createVfModule(BuildingBlockExecution execution) {
         try {
             GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();

diff --git a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/sdnc/tasks/SDNCAssignTasks.java b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/sdnc/tasks/SDNCAssignTasks.java
index ab2647a..1dcdfa9 100644 (file)
--- a/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/sdnc/tasks/SDNCAssignTasks.java
+++ b/bpmn/so-bpmn-tasks/src/main/java/org/onap/so/bpmn/infrastructure/sdnc/tasks/SDNCAssignTasks.java
@@ -52,6 +52,10 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.core.env.Environment;
 import org.springframework.stereotype.Component;
 
+/*
+ * This class is used for creating the service instance, assigning vnf, assigning the Vfmodule & assigning the L3Network
+ * on SDNC.
+ */
 @Component
 public class SDNCAssignTasks extends AbstractSDNCTask {
     private static final Logger logger = LoggerFactory.getLogger(SDNCAssignTasks.class);
@@ -71,6 +75,13 @@ public class SDNCAssignTasks extends AbstractSDNCTask {
     @Autowired
     private Environment env;
 
+    /**
+     * BPMN access method to assigning the service instance in SDNC.
+     *
+     * It will assign the service instance by the service instance id.
+     *
+     * @param execution
+     */
     public void assignServiceInstance(BuildingBlockExecution execution) {
         try {
             GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();
@@ -89,6 +100,13 @@ public class SDNCAssignTasks extends AbstractSDNCTask {
         }
     }
 
+    /**
+     * BPMN access method to assigning the vnf in SDNC.
+     *
+     * It will assign the vnf according to the service instance id and vnf id.
+     *
+     * @param execution
+     */
     public void assignVnf(BuildingBlockExecution execution) {
         try {
             GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();
@@ -111,6 +129,13 @@ public class SDNCAssignTasks extends AbstractSDNCTask {
         }
     }
 
+    /**
+     * BPMN access method to assigning the vfModule in SDNC.
+     *
+     * It will assign the VfModule by the service instance id ,Vnf id and module id.
+     *
+     * @param execution
+     */
     public void assignVfModule(BuildingBlockExecution execution) {
         try {
             GeneralBuildingBlock gBBInput = execution.getGeneralBuildingBlock();