Dynamic Traits Cookbook (#28)

Dynamic Traits Cookbook

This commit illustrates Dynamic Traits w.r.t. the Agents, respective properties
and the shared lanes.

Author: Aditya R
Reviewers: Ajay G, Rohit B
Test: Manual
Issue: #24

Author: AdityaRandive

settings.gradle

@@ -57,5 +57,5 @@ project(':auth-policy').projectDir = file('auth_policy')
 include 'web-agents-server-recon'
 project(':web-agents-server-recon').projectDir = file('web_agents_server_recon')
 
-include 'static-traits'
-project(':static-traits').projectDir = file('static_traits')
+include 'traits'
+project(':traits').projectDir = file('traits')

static_traits/README.md

@@ -0,0 +1,13 @@
+# Traits
+
+Code corresponding to the [Traits cookbook](https://swimos.org/tutorials/traits/).
+
+*Read this in other languages: [简体中文](README.zh-cn.md)*
+
+## Running This Demo
+
+This demo only requires running the `swim.liquid.LiquidPlane` class.
+
+Thus, `gradle traits:run` is sufficient for those who pick Option 2 in [`README.md` from the parent directory](../README.md).
+
+For those who pick Option 3, simply execute `gradle traits:build`, unpackage either artifact in `traits/build/distributions`, and run the appropriate script in `bin/`; no file copying/editing is required.

traits/README.md

@@ -1,5 +1,5 @@
 apply from: '../project.gradle'
 
-description = 'Code corresponding to the Static Traits cookbook'
+description = 'Code corresponding to the Traits cookbook'
 ext.moduleName = 'swim.liquid'
 mainClassName = 'swim.liquid.LiquidPlane'

static_traits/build.gradle renamed to traits/build.gradle

@@ -14,24 +14,41 @@
 
 package swim.liquid;
 
+import swim.actor.ActorSpace;
 import swim.api.plane.AbstractPlane;
 import swim.kernel.Kernel;
 import swim.server.ServerLoader;
+import swim.structure.Value;
 
 public class LiquidPlane extends AbstractPlane {
 
   public static void main(String[] args) throws InterruptedException {
     final Kernel kernel = ServerLoader.loadServer();
+    final ActorSpace space = (ActorSpace) kernel.getSpace("liquid");
 
     kernel.start();
-    System.out.println("Running Liquid server...");
+    System.out.println("Running Basic server...");
     kernel.run();
 
-    Thread.sleep(1000);
+    // Dynamic Agent(s)
+    int n = 0;
+    String nodeString = "";
+    final String[] listOfLiquid = new String[]{"black", "pineapple", "tap", "mango"};
+    while (n < 4) {
+      if (n % 2 == 0) {
+        nodeString = "/liquid/dynamic/water/" + listOfLiquid[n];
+      } else {
+        nodeString = "/liquid/dynamic/juice/" + listOfLiquid[n];
+      }
+      space.command(nodeString, "unusedForNow", Value.absent());
+      n++;
+      Thread.sleep(2000);
+    }
 
     System.out.println("Server will shut down in 3 seconds");
     Thread.sleep(3000);
     System.out.println("Sent shutdown signal to server");
     kernel.stop();
   }
+
 }

static_traits/src/main/java/module-info.java renamed to traits/src/main/java/module-info.java

@@ -20,13 +20,17 @@
 
 public class JuiceAgent extends AbstractAgent {
 
+  // Lane utilized for static and dynamic traits.
   @SwimLane("sharedInfo")
   ValueLane<String> sharedInfo;
 
   @Override
   public void didStart() {
-    System.out.println(nodeUri() + " didStart region");
-    pour();
+    System.out.println(nodeUri() + " didStart");
+    pourStatic();
+    if (nodeUri().toString().contains("dynamic")) {
+      pourDynamic();
+    }
     close();
   }
 
@@ -35,19 +39,34 @@ public void willStop() {
     logMessage("willStop");
   }
 
-  // Fetch value of property belonging to the /juice/orange uri.
-  void pour() {
+  // Fetch value of property belonging to the /liquid/static/juice/orange uri.
+  void pourStatic() {
     final String juiceInfo = getProp("juiceType").stringValue(null);
     if (juiceInfo != null) {
-      logMessage("Juice Property '" + juiceInfo + "'");
+      logMessage("Static Juice Property '" + juiceInfo + "'");
+
+      // Set Value for the sharedInfo SwimLane which is shared by Liquid,
+      // Water and Juice Agent.
+      this.sharedInfo.set("Statically shared liquid is '" + juiceInfo + "'");
+    }
+  }
+
+  // Set value of the sharedInfo lane belonging to the /liquid/:trait/:id1/:id2 pattern.
+  void pourDynamic() {
+    final String liquidType = getProp("id1").stringValue(null);
+    final String liquidName = getProp("id2").stringValue(null);
+    if (liquidType != null && liquidName != null) {
+      logMessage("Dynamic Juice Property '" + liquidName + "'");
 
       // Set Value for the sharedInfo SwimLane which is shared by Liquid,
       // Water and Juice Agent.
-      this.sharedInfo.set("Shared liquid is " + juiceInfo);
+      this.sharedInfo.set("Dynamically shared liquid is '" + liquidName + " "
+              + liquidType + "'");
     }
   }
 
   private void logMessage(Object msg) {
     System.out.println(nodeUri() + ": " + msg);
   }
+
 }

static_traits/src/main/java/swim/liquid/LiquidPlane.java renamed to traits/src/main/java/swim/liquid/LiquidPlane.java

@@ -20,13 +20,18 @@
 
 public class LiquidAgent extends AbstractAgent {
 
+  // Lane utilized for static and dynamic traits.
   @SwimLane("sharedInfo")
   ValueLane<String> sharedInfo;
 
   @Override
   public void didStart() {
-    System.out.println(nodeUri() + " didStart region");
-    pour();
+    System.out.println(nodeUri() + " didStart");
+    if (nodeUri().toString().contains("dynamic")) {
+      pourDynamic();
+    } else {
+      pourStatic();
+    }
     close();
   }
 
@@ -36,13 +41,27 @@ public void willStop() {
   }
 
   // Fetch info shared with other agents.
-  void pour() {
+  void pourStatic() {
     // Fetching message via sharedInfo SwimLane.
     final String msg = this.sharedInfo.get();
     logMessage(msg);
   }
 
+  // 1. Fetch value of properties belonging to the /liquid/:trait/:id/:id pattern.
+  // 2. Open agents dynamically.
+  // 2. Fetch value of sharedInfo lane for the opened agents.
+  void pourDynamic() {
+    // Dynamically open either Water or Juice Agent at runtime.
+    if (getProp("id1").stringValue().equals("water")) {
+      openAgent("wAgent", WaterAgent.class);
+    } else if (getProp("id1").stringValue().equals("juice")) {
+      openAgent("jAgent", JuiceAgent.class);
+    }
+    logMessage(this.sharedInfo.get());
+  }
+
   private void logMessage(Object msg) {
     System.out.println(nodeUri() + ": " + msg);
   }
+
 }

static_traits/src/main/java/swim/liquid/agent/JuiceAgent.java renamed to traits/src/main/java/swim/liquid/agent/JuiceAgent.java

@@ -20,13 +20,15 @@
 
 public class WaterAgent extends AbstractAgent {
 
+  // Lane utilized for static and dynamic traits.
   @SwimLane("sharedInfo")
   ValueLane<String> sharedInfo;
 
   @Override
   public void didStart() {
-    System.out.println(nodeUri() + " didStart region");
-    pour();
+    System.out.println(nodeUri() + " didStart");
+    pourStatic();
+    pourDynamic();
     close();
   }
 
@@ -35,19 +37,34 @@ public void willStop() {
     logMessage("willStop");
   }
 
-  // Fetch value of property belonging to the /water/sparkling uri.
-  void pour() {
+  // Fetch value of property belonging to the /liquid/static/water/sparkling uri.
+  void pourStatic() {
     final String waterInfo = getProp("waterType").stringValue(null);
     if (waterInfo != null) {
-      logMessage("Water Property '" + waterInfo + "'");
+      logMessage("Static Water Property '" + waterInfo + "'");
 
       // Set Value for the sharedInfo SwimLane which is shared by Liquid,
       // Water and Juice Agent.
-      this.sharedInfo.set("Shared liquid is " + waterInfo);
+      this.sharedInfo.set("Statically shared liquid is '" + waterInfo + "'");
+    }
+  }
+
+  // Set value of the sharedInfo lane belonging to the /liquid/:trait/:id1/:id2 pattern.
+  void pourDynamic() {
+    final String liquidType = getProp("id1").stringValue(null);
+    final String liquidName = getProp("id2").stringValue(null);
+    if (liquidType != null && liquidName != null) {
+      logMessage("Dynamic Water Property '" + liquidName + "'");
+
+      // Set Value for the sharedInfo SwimLane which is shared by Liquid,
+      // Water and Juice Agent.
+      this.sharedInfo.set("Dynamically shared liquid is '" + liquidName + " "
+              + liquidType + "'");
     }
   }
 
   private void logMessage(Object msg) {
     System.out.println(nodeUri() + ": " + msg);
   }
+
 }

static_traits/src/main/java/swim/liquid/agent/LiquidAgent.java renamed to traits/src/main/java/swim/liquid/agent/LiquidAgent.java

@@ -12,7 +12,7 @@
 liquid: @fabric {
   @plane(class: "swim.liquid.LiquidPlane")
   @node {
-    uri: "/water/sparkling"
+    uri: "/liquid/static/water/sparkling"
     @agent(class: "swim.liquid.agent.WaterAgent") {
       waterType: "Sparkling Water"
     }
@@ -21,12 +21,21 @@ liquid: @fabric {
     }
   }
   @node {
-    uri: "/juice/orange"
+    uri: "/liquid/static/juice/orange"
     @agent(class: "swim.liquid.agent.JuiceAgent") {
       juiceType: "Orange Juice"
     }
     @agent(class: "swim.liquid.agent.LiquidAgent") {
       liquidType: "Juice"
     }
   }
+  @node {
+    pattern: "/liquid/:trait/:id1/:id2"
+    @agent(class: "swim.liquid.agent.WaterAgent") {
+    }
+    @agent(class: "swim.liquid.agent.JuiceAgent") {
+    }
+    @agent(class: "swim.liquid.agent.LiquidAgent") {
+    }
+  }
 }