Fwf 1383 (#3)

* Delete installationAutomation.bat

* Removed author label from classes and included comments above each class to indicate its functionality.

* Remove author label from classes and include comments above each class to indicate its functionality

Co-authored-by: Alan Raju <[email protected]>
Co-authored-by: abhilash-aot <[email protected]>

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/CamundaApplication.java

@@ -23,6 +23,7 @@
 
 
 /**
+ * Camunda Application.
  * The Camunda Showcase Spring Boot application.
  */
 @EnableConfigurationProperties

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/config/AppConfig.java

@@ -10,6 +10,11 @@
 
 import javax.annotation.PostConstruct;
 
+/**
+ * AppConfig
+ * Configuration data for API.
+ */
+
 @Configuration
 public class AppConfig {
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/AccessHandlerFactory.java

@@ -4,9 +4,8 @@
 import org.camunda.bpm.extension.commons.connector.support.IAccessHandler;
 
 /**
+ * Access Handler Factory.
  * Factory Definition for getting appropriate access handlers based on the service id.
- *
- * @author [email protected]
  */
 public interface AccessHandlerFactory  {
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/HTTPServiceInvoker.java

@@ -16,9 +16,8 @@
 import java.util.logging.Logger;
 
 /**
- * This class prepares the payload and invokes the respective access handler based on the service ID.
- *
- * @author  [email protected]
+ *  Http Service Invoker.
+ *  This class prepares the payload and invokes the respective access handler based on the service ID.
  */
 @Component("httpServiceInvoker")
 public class HTTPServiceInvoker {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/auth/FormioConfiguration.java

@@ -4,8 +4,8 @@
 import lombok.Data;
 
 /**
- * Configuration data for formio
- * @author Shibin Thomas
+ * Formio Configuration.
+ * Configuration data for formio.
  */
 @Data
 @AllArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/auth/FormioContext.java

@@ -1,9 +1,8 @@
 package org.camunda.bpm.extension.commons.connector.auth;
 
 /**
- * Formio context holding access token.
- *
- * @author Shibin Thomas
+ * Formio Context.
+ * Class for holding and transferring access token data.
  */
 public class FormioContext {
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/auth/FormioContextProvider.java

@@ -16,7 +16,7 @@
 
 
 /**
- * Formio context provider.
+ * Formio Context Provider.
  * Manages access tokens for then Formio REST API.
  */
 public class FormioContextProvider {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/support/ApplicationAccessHandler.java

@@ -17,10 +17,8 @@
 
 
 /**
+ * Application Access Handler.
  * This class serves as gateway for all application service interactions.
- *
- * @author [email protected]
- * @author Shibin Thomas
  */
 @Service("applicationAccessHandler")
 public class ApplicationAccessHandler implements IAccessHandler {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/support/FormAccessHandler.java

@@ -17,9 +17,8 @@
 
 
 /**
+ * Form Access Handler.
  * This class serves as gateway for all formio interactions.
- *
- * @author [email protected]
  */
 @Service("formAccessHandler")
 public class FormAccessHandler extends FormTokenAccessHandler implements IAccessHandler {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/support/FormTokenAccessHandler.java

@@ -15,9 +15,8 @@
 
 
 /**
+ * Form Token Access Handler.
  * This class abstracts  formio token generation logic with the intent to cached & refreshed accordingly.
- * @author [email protected]
- * @author [email protected]
  */
 @Service("formTokenAccessHandler")
 public class FormTokenAccessHandler {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/support/IAccessHandler.java

@@ -6,10 +6,8 @@
 import org.springframework.http.ResponseEntity;
 
 /**
+ * IAccess Handler.
  * This class defines the AccessHandler implementation.
- *
- * @author [email protected]
- * @author Shibin Thomas
  */
 public interface IAccessHandler {
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/connector/support/TextAnalyzerAccessHandler.java

@@ -15,6 +15,12 @@
 
 import static org.springframework.security.oauth2.client.web.reactive.function.client.ServerOAuth2AuthorizedClientExchangeFilterFunction.clientRegistrationId;
 
+/**
+ * Text Analyzer Access Handler.
+ * This class serves as gateway for all text analyzer service interactions.
+ */
+
+
 @Service("textAnalyzerAccessHandler")
 public class TextAnalyzerAccessHandler implements IAccessHandler{
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/exceptions/FormioIdentityException.java

@@ -1,7 +1,8 @@
 package org.camunda.bpm.extension.commons.exceptions;
 
 /**
- * To throw during the identity provider setup / token refresh
+ * Formio Identity Exception.
+ * To throw during the identity provider setup / token refresh.
  */
 public class FormioIdentityException extends RuntimeException{
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/io/event/CamundaEventListener.java

@@ -22,9 +22,8 @@
 
 
 /**
+ * Camunda Event Listener.
  * This class intercepts all camunda task and push socket messages for web tier updates.
- *
- * @author [email protected]
  */
 @Component
 public class CamundaEventListener {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/io/socket/WebSocketConfig.java

@@ -11,9 +11,8 @@
 import java.util.logging.Logger;
 
 /**
+ * Web Socket Config.
  * This class serves the purpose of exposing socket connection for push notifications to & from camunda.
- *
- * @author [email protected]
  */
 @Configuration
 @EnableWebSocketMessageBroker

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/io/socket/message/TaskEventMessage.java

@@ -6,6 +6,11 @@
 
 import java.io.Serializable;
 
+/**
+ * Task Event Message.
+ * Class for holding TaskEvent data.
+ */
+
 @Data
 @NoArgsConstructor
 @ToString

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/io/socket/message/TaskMessage.java

@@ -10,9 +10,8 @@
 import java.util.Map;
 
 /**
- * Transfer object for task
- *
- * @author [email protected]
+ * Task Message.
+ * Class for holding Task data.
  */
 @Data
 @NoArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/ro/req/IRequest.java

@@ -1,4 +1,8 @@
 package org.camunda.bpm.extension.commons.ro.req;
 
+/**
+ * IRequest.
+ * This class defines the Request implementation.
+ */
 public interface IRequest {
 }

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/ro/res/IResponse.java

@@ -1,4 +1,8 @@
 package org.camunda.bpm.extension.commons.ro.res;
 
+/**
+* IResponse.
+* This class defines the Response implementation.
+*/
 public interface IResponse {
 }

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/utils/RestAPIBuilderUtil.java

@@ -2,6 +2,10 @@
 
 import java.text.MessageFormat;
 
+/**
+ * RestAPI Builder Util.
+ * Utility class for storing and transferring data required for Rest API URL.
+ */
 public class RestAPIBuilderUtil {
 
     private static RestAPIBuilderUtil instance;

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/commons/utils/VariableConstants.java

@@ -1,5 +1,9 @@
 package org.camunda.bpm.extension.commons.utils;
 
+/**
+ * Variable Constants.
+ * Utility class for storing variable constants.
+ */
 public class VariableConstants {
 
     public static final String APPLICATION_ID = "applicationId";

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/AdminController.java

@@ -56,9 +56,8 @@
 import net.minidev.json.JSONArray;
 
 /**
+ * Admin Controller.
  * This class assist with admin operations of formsflow.ai: Giving all authorized form details
- *
- * @author [email protected]
  */
 @Controller
 public class AdminController {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/TaskController.java

@@ -29,9 +29,8 @@
 import java.util.logging.Logger;
 
 /**
+ * Task Controller.
  * This class list all task from history tables of camunda.
- *
- * @author  [email protected]
  */
 @Deprecated
 @Controller

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/Authorization.java

@@ -7,6 +7,7 @@
 import java.util.Objects;
 
 /**
+ * Authorization.
  * Mapper associated with querying authorization.
  */
 @Data

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/AuthorizationInfo.java

@@ -8,6 +8,11 @@
 import java.util.List;
 import java.util.Set;
 
+/**
+ * Authorization Info.
+ * Class for holding authorization information data.
+ */
+
 @Data
 @NoArgsConstructor
 @AllArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/AuthorizedAction.java

@@ -5,6 +5,10 @@
 
 import java.util.Objects;
 
+/**
+ * Authorized Action.
+ * Class for holding Authorized Action data.
+ */
 @NoArgsConstructor
 @Data
 public class AuthorizedAction {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/Task.java

@@ -5,6 +5,10 @@
 
 import java.util.List;
 
+/**
+ * Task.
+ * Class for holding Task data.
+ */
 @Data
 public class Task  extends TaskDto {
     private String processInstanceId;

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/TenantAuthorizationDto.java

@@ -6,6 +6,10 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+/**
+ * Tenant Authorization Dto.
+ * Data transfer object for Tenant Authorization.
+ */
 public class TenantAuthorizationDto {
 
 	private String tenantKey;

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/data/Variable.java

@@ -4,6 +4,10 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
+/**
+ * Variable.
+ * Class for holding variable data.
+ */
 @Data
 @AllArgsConstructor
 @NoArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/mapper/AuthorizationMapper.java

@@ -7,6 +7,10 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 
+/**
+ * Authorization Mapper.
+ * Class for mapping authorization result.
+ */
 public final class AuthorizationMapper implements RowMapper<Authorization> {
     public Authorization mapRow(ResultSet rs, int rowNum) throws SQLException {
         Authorization auth = new Authorization();

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/controllers/mapper/TaskResultSetExtractor.java

@@ -13,6 +13,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Task Result Set Extractor.
+ * Class for extracting task result data.
+ */
 @Data
 @NoArgsConstructor
 public class TaskResultSetExtractor implements ResultSetExtractor<Task> {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/delegates/FormDocumentTransformer.java

@@ -13,9 +13,8 @@
 import java.util.logging.Logger;
 
 /**
- * This class transforms all the form document data into CAM variables
- *
- * @author [email protected]
+ * Form Document Transformer.
+ * This class transforms all the form document data into CAM variables.
  */
 @Component
 public class FormDocumentTransformer  implements JavaDelegate {

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/delegates/FormTextAnalysisDelegate.java

@@ -30,6 +30,11 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Form Text Analysis Delegate.
+ * This class copies specific data from text sentiment response data into CAM variables.
+ */
+
 @Component
 public class FormTextAnalysisDelegate implements JavaDelegate {
 

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/delegates/data/TextSentimentData.java

@@ -7,6 +7,11 @@
 
 import java.util.List;
 
+/**
+ * Text Sentiment Data.
+ * Class for holding Text Sentiment Data.
+ */
+
 @Data
 @NoArgsConstructor
 @AllArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/delegates/data/TextSentimentRequest.java

@@ -9,6 +9,11 @@
 import java.io.Serializable;
 import java.util.List;
 
+/**
+ * Text Sentiment Request.
+ * Class for holding Text Sentiment Request data.
+ */
+
 @Data
 @NoArgsConstructor
 @AllArgsConstructor

forms-flow-bpm/src/main/java/org/camunda/bpm/extension/hooks/exceptions/AnalysisServiceException.java

@@ -4,7 +4,8 @@
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 /**
- *
+ * Application Service Exception.
+ * Specialized exception class for analysis calls.
  */
 @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
 public class AnalysisServiceException extends RuntimeException {