upload project changes

README.md

@@ -8,7 +8,7 @@
 4. [Create Process](#create-process)
 5. [Run Application (MAVEN)](#run-application-maven)
 6. [Run Application (DOCKER)](#run-application-docker)
-6. [How to use Application](#how-to-use-application)
+7. [How to use Application](#how-to-use-application)
 
 ## Set up Application
 Camunda Spring Boot Application created with [Camunda Platform Initializr].
@@ -43,7 +43,7 @@ Also added [GSON] dependency for parsing JSON objects to `pom.xml`.
 > **_INFO:_**  Used version `2.8.4`, because other failed with spring boot.
 
 ### Additional Settings
-Enabled process application to disables the `SpringProcessEngineConfiguration` auto-deploy feature. 
+Enabled process application to disable the `SpringProcessEngineConfiguration` auto-deploy feature. 
 > **_INFO:_**  Without `@EnableProcessApplication` using embedded forms always failed.
 
 ```sh
@@ -64,32 +64,32 @@ Got free [Alpha Vantage] API Key:
 
 ## Create Process
 Created camunda BPMN process as described in [BPT Moodle Course]. 
-- Start Event
+- Start Event `End of Month`
   - End of month as manually triggered Start-Event
-- First User Task
+- First User Task `Set Company Name`
   - User enters into a dialog (HTML form: [company_form.html]) a company name, of which their company own stocks. 
   - The step stores the name in a process variable `stock`.
-- First Service Task
+- First Service Task `Get Symbol`
   - System queries a REST-WebService at https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=IBM&apikey=VPNHOQPE0AOJ8BEP 
     - The Search Endpoint for `stock`. 
   - The step stores the resulting symbol in a process variable `symbol`.
   - Used the `Java Delegate` class for implementation.
     - Connecting the delegate class [SymbolSearchDelegate.java] with the service task takes place selecting `Java Class` instead of `Expression` and entering the full classpath.
-- Second Service Task
+- Second Service Task `Get Price and Change`
   - System queries a REST-WebService at https://www.alphavantage.co/query?function=GLOBAL_QUOTE&symbol=IBM&apikey=VPNHOQPE0AOJ8BEP
     - The Quote Endpoint stores the current price in a process variable `price` and the change in a process variable `change`.
   - Used the `Java Delegate` class for implementation.
     - Connecting the delegate class [GlobalQuoteDelegate.java] with the service task takes place selecting `Java Class` instead of `Expression` and entering the full classpath.
-- Gateway
+- Gateway `Sell?`
   - Gateway decides by price and change for a sell recommendation 
     - if `price<1 and change negative`, the system should execute the second user task.
     - else, the system leads to second end event
-- Second User Task
+- Second User Task `Sell Stock`
   - System displays to the user a dialog (HTML form: [sell_form.html]) with `symbol`, `price`, `change` and a button `Sell` and a button `Cancel`.
   - There are no functions implemented for the buttons!
-- First End Event
+- First End Event `Stock sold`
   - The process terminates.
-- Second End Event
+- Second End Event `Stock kept`
   - The process terminates.
   - Set to `default` sequence flow.
 
@@ -110,7 +110,7 @@ Run Spring-Boot Application:
 ```sh
 mvn spring-boot:run
 ```
-Application starts on port 9999. Open in Browser:
+Application starts on port `9999`. Open in Browser:
 ```sh
 localhost:9999
 ```
@@ -122,7 +122,7 @@ docker run -p 9999:9999 kebidge/stock-asset-review:jib
 ```
 > **_INFO:_**  Do not run container in detached mode! Otherwise you will not see application logs.
 
-Application starts on port 9999. Open in Browser:
+Application starts on port `9999`. Open in Browser:
 ```sh
 localhost:9999
 ```

src/main/java/de/kebidge/camunda/GlobalQuoteDelegate.java

@@ -27,8 +27,8 @@ public class GlobalQuoteDelegate implements JavaDelegate {
     public void execute(DelegateExecution execution) throws Exception {
 
         // process variables
-        String stock_process = "stock";
-        String stock_value = (String) execution.getVariable(stock_process);
+        String symbol_process = "symbol";
+        String symbol_value = (String) execution.getVariable(symbol_process);
         String quote_value = "";
         String price_process = "price";
         String change_process = "change";
@@ -45,7 +45,7 @@ public class GlobalQuoteDelegate implements JavaDelegate {
         // https://www.alphavantage.co/support/#api-key
         String key = "VPNHOQPE0AOJ8BEP";
 
-        LOGGER.info("Processing request by '" + stock_value + "'...");
+        LOGGER.info("Processing request by '" + symbol_value + "'...");
 
         // build GET Request
         // GET https://www.alphavantage.co/query?function=GLOBAL_QUOTE&symbol=IBM&apikey=VPNHOQPE0AOJ8BEP
@@ -53,7 +53,7 @@ public class GlobalQuoteDelegate implements JavaDelegate {
         String queryEndpoint = "query?function=GLOBAL_QUOTE&symbol=";
         String apiKey = "&apikey=" + key;
 
-        String uri_string = apiURL + queryEndpoint + stock_value + apiKey;
+        String uri_string = apiURL + queryEndpoint + symbol_value + apiKey;
 
         // set HTTP Client
         HttpClient vClient = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(20))
@@ -140,7 +140,7 @@ public class GlobalQuoteDelegate implements JavaDelegate {
                         } else {
                             
                             // symbol item is null
-                            LOGGER.info("JSON is empty... Sorry your Key is just for demo purposes. Use symbol=\"IBM\" instead!");
+                            LOGGER.info("JSON is empty...");
                             LOGGER.info(quote_value);
                         }                        
                     }

src/main/java/de/kebidge/camunda/SymbolSearchDelegate.java

@@ -12,6 +12,11 @@ import java.time.Duration;
 import java.util.logging.Logger;
 import javax.servlet.http.HttpServletResponse;
 
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import com.google.gson.JsonArray;
+
 import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.JavaDelegate;
 
@@ -23,10 +28,12 @@ public class SymbolSearchDelegate implements JavaDelegate {
     public void execute(DelegateExecution execution) throws Exception {
 
         // process variables
-        //String stock_process = "stock";
-        String stock_value = (String) execution.getVariable("stock");
+        String stock_process = "stock";
+        String stock_value = (String) execution.getVariable(stock_process);
         String symbol_process = "symbol";
         String symbol_value = "";
+        String name_process = "name";
+        String name_value = "";
 
         // set alphavantage key here
         // https://www.alphavantage.co/support/#api-key
@@ -67,15 +74,84 @@ public class SymbolSearchDelegate implements JavaDelegate {
                 
                 // requested resource is available (200)
 
-                // get symbol value from REST API
-                symbol_value = vResponse.body();
-
-                // set symbol value to process variable
-                execution.setVariable(symbol_process, symbol_value);
-
-                // log success and symbol value
-                LOGGER.info("HttpServletResponse succeed...");
-                //LOGGER.info("Set variable symbol = " + symbol_value);
+                // get symbol resonse from REST API -> save to best matches string
+                String best_matches = vResponse.body();
+
+                /* parse SYMBOL_SEARCH JSON 
+
+                Example:
+
+
+                {
+                    "bestMatches": [
+                        {
+                            "1. symbol": "IBM",
+                            "2. name": "International Business Machines Corp",
+                            "3. type": "Equity",
+                            "4. region": "United States",
+                            "5. marketOpen": "09:30",
+                            "6. marketClose": "16:00",
+                            "7. timezone": "UTC-04",
+                            "8. currency": "USD",
+                            "9. matchScore": "1.0000"
+                        },
+                        { 
+                            ...
+                        }
+                    }                      
+                */
+                
+                // parse JSON object
+                JsonParser jsonParser = new JsonParser();                
+                JsonElement jsonTree = jsonParser.parse(best_matches);
+
+                if(jsonTree.isJsonObject()) {
+                    
+                    JsonObject jsonObject = jsonTree.getAsJsonObject();
+                    //LOGGER.info("jsonObject=" + jsonObject);
+
+                    JsonElement best_maches_element = jsonObject.get("bestMatches");
+                    //LOGGER.info("best_maches_element=" + best_maches_element);
+
+                    if(best_maches_element.isJsonArray()){
+
+                        // get json object (bestMatches) as json array
+                        JsonArray symbol_array = best_maches_element.getAsJsonArray();
+                        //LOGGER.info("JSON Parser: symbol_array=" + symbol_array);
+                        
+                        // get first array item as json object
+                        JsonObject symbol_json_object = symbol_array.get(0).getAsJsonObject();
+                        //LOGGER.info("JSON Parser: symbol_json_object=" + symbol_json_object);
+
+                        // get symbol value from REST API
+                        symbol_value = symbol_json_object.get("1. symbol").getAsString();
+                        LOGGER.info("JSON Parser: symbol=" + symbol_value);
+
+                        // get company name value from REST API
+                        name_value = symbol_json_object.get("2. name").getAsString();
+                        LOGGER.info("JSON Parser: name=" + name_value);
+
+                        // set symbol value to process variable
+                        execution.setVariable(symbol_process, symbol_value);
+
+                        // set company name value to process variable
+                        execution.setVariable(name_process, name_value);
+
+                        // log success and symbol value
+                        LOGGER.info("HttpServletResponse succeed...");
+                    } else {
+                            
+                        // not a json array
+                        LOGGER.info("NOT a JSON Array...");
+                        LOGGER.info(best_maches_element.toString());
+                    }
+                } else {
+
+                    // quote_value is not a JSON object
+                    LOGGER.info("JSON Parser failed...");
+                    LOGGER.info("Not a JSON Object");
+                    LOGGER.info(best_matches);
+                }
             }
         } catch (IOException | InterruptedException e) {
                 

src/main/resources/static/forms/sell_form.html

@@ -2,7 +2,7 @@
     <div class="form-group">
         <label for="symbol">Company Name</label>
         <input id="symbol" required
-            cam-variable-name="stock"
+            cam-variable-name="name"
             cam-variable-type="String"
             class="form-control"><br>
 

target/classes/static/forms/sell_form.html

@@ -2,7 +2,7 @@
     <div class="form-group">
         <label for="symbol">Company Name</label>
         <input id="symbol" required
-            cam-variable-name="stock"
+            cam-variable-name="name"
             cam-variable-type="String"
             class="form-control"><br>
 

target/maven-archiver/pom.properties

 #Generated by Maven
-#Tue Nov 23 02:26:49 CET 2021
+#Wed Dec 01 00:32:44 CET 2021
 groupId=de.kebidge.camunda
 artifactId=stock-asset-review
 version=1.0.0-SNAPSHOT