Open Source

Author: c9r

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.DS_Store
+.idea
+.gradle
+.vscode
+build
+out

README.md

@@ -0,0 +1,11 @@
+# Swim Tutorial
+
+Swim is a completely integrated solution for building scalable, end-to-end streaming applications. Instead of requiring separate message brokers, app servers, and databases, Swim applications consist of just two pieces:
+
+- A **Swim server** with *built-in* persistence, messaging, scheduling, clustering, replication, introspection, and security
+
+- A **user interface** that uses Swim's streaming UI frameworks to visualize data from Swim servers in real-time
+
+Visit [server](https://github.com/swimos/swim-tutorial/blob/master/server) to learn how to stand up your data in a Swim server.
+
+Then, visit [ui](https://github.com/swimos/swim-tutorial/blob/master/ui) to see this data like never before.

server/README.md

@@ -0,0 +1,43 @@
+# Swim Server
+
+Swim unifies the traditionally disparate roles of database, message broker, job manager, and application server, into a few simple constructs.
+
+## Web Agents
+
+Swim implements a general purpose distributed object model. The "objects" in this model are **Web Agents**.
+
+[Creating a class](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L13) that extends `swim.api.agent.AbstractAgent` defines a *template* for Web Agents (though not a useful one until we add some [lanes](#lanes)).
+
+Visit the [documentation](https://developer.swim.ai/concepts/agents/) for further details about Web Agents.
+
+## Lanes
+
+If Web Agents are objects, then **lanes** serve as the "fields" of those objects. Lanes come in many flavors, e.g. value lanes, map lanes, and command lanes.
+
+Continuing our analogy, *lane callback* functions serve as the "methods" of Web Agents.
+
+Each lane type defines a set of overridable (default no-op) lifecycle callbacks. For example, [sending a command message](#sending-data-do-swim) to any command lane will trigger its [`onCommand` callback](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L51-L54). On the other hand, [setting a value lane](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L53) will trigger its `willSet` callback, then update its value, then trigger its [`didSet` callback](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/UnitAgent.java#L40-L47).
+
+Visit the [documentation](https://developer.swim.ai/concepts/lanes/) for further details about lanes.
+
+## Standing a Swim Server
+
+A Swim server is loaded with a **plane**, which provides the runtime for Web Agents and routes messages to the correct lanes.
+
+A plane must [declare an `AgentType` field](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L13-L14) for each Web Agent type.
+
+Use the `ServerLoader` utility class to [load a plane into a Swim server](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L18). Note that your module must [`provide` `swim.api.plane.Plane` with your custom plane class](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/module-info.java#L8).
+
+Visit the [documentation](https://developer.swim.ai/concepts) for further details about these concepts.
+
+## Populating a Swim Server With Your Data
+
+Every Swim server can be written to and read from by external processes using the Swim API. The simplest way to utilize this API is to use a **Swim client** instance to [send commands to command lanes](http://github.com/swimos/swim-tutorial/tree/master/server/src/main/java/swim/tutorial/TutorialPlane.java#L40).
+
+Visit the [documentation](https://developer.swim.ai/concepts) for further details about these concepts.
+
+## Subscribing to Swim Server Data
+
+Swim client instances use Swim **links** to pull data from a Swim lanes. Like their corresponding lanes, links have overridable callback functions that can be used to [populate UIs](http://github.com/swimos/swim-tutorial/tree/master/ui/index.html#L111-L133).
+
+Visit the [documentation](https://developer.swim.ai/concepts/links/) for further details about links.

server/build.gradle

@@ -0,0 +1,143 @@
+import java.util.regex.Matcher
+
+buildscript {
+  repositories {
+    maven { url 'https://plugins.gradle.org/m2/' }
+  }
+  dependencies {
+    classpath 'com.netflix.nebula:gradle-ospackage-plugin:6.1.1'
+  }
+}
+
+apply plugin: 'java'
+apply plugin: 'java-library'
+apply plugin: 'application'
+apply plugin: 'nebula.ospackage-application'
+
+group = 'ai.swim'
+description = 'tutorial Web Agents'
+ext.moduleName = 'swim.tutorial'
+sourceCompatibility = 1.9
+version = project.property('application.version')
+mainClassName = 'swim.tutorial.TutorialPlane'
+
+//def moduleName = 'swim.tutorial'
+def jvmVersion = System.getProperty('java.version').split('\\.')[0] as Integer
+def useModules = jvmVersion >= 9 && !project.hasProperty('no-modules')
+
+repositories {
+  jcenter()
+  maven {
+    url "https://oss.sonatype.org/content/repositories/snapshots/"
+  }
+
+}
+
+dependencies {
+  compile 'ai.swim:swim-loader:3.9.1-SNAPSHOT'
+  compile 'ai.swim:swim-server:3.9.1-SNAPSHOT'
+  compile 'ai.swim:swim-client:3.9.1-SNAPSHOT'
+}
+
+afterEvaluate {
+  compileJava {
+    if (useModules) {
+      doFirst {
+        options.compilerArgs += [
+          '--module-path', classpath.asPath,
+        ]
+        classpath = files()
+      }
+    }
+    options.compilerArgs += ['-Xlint']
+    options.encoding = 'UTF-8'
+  }
+
+  jar {
+    inputs.property('moduleName', moduleName)
+    manifest {
+      attributes(
+        'Implementation-Title': moduleName,
+        'Implementation-Version': version,
+        'Main-Class': mainClassName)
+    }
+  }
+
+  tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+    if (!useModules) {
+      exclude '*module-info*'
+    }
+  }
+
+  run {
+    dependsOn jar
+    doFirst {
+      jvmArgs += [
+        '--module-path', files(configurations.runtimeClasspath, jar.archivePath).asPath,
+        '--module', "${moduleName}/${mainClassName}"
+      ]
+      classpath = files()
+    }
+  }
+
+  startScripts {
+    inputs.property("moduleName", moduleName)
+    doFirst {
+      classpath = files()
+      defaultJvmOpts = [
+        '-Dswim.config=/etc/swim-tutorial/server.recon',
+        '-Xms3g',
+        '-Xmx3g',
+        '--module-path', 'APP_HOME_LIBS',
+        '--module', "${moduleName}/${mainClassName}"
+      ]
+    }
+    doLast {
+      def bashFile = new File(outputDir, applicationName)
+      String bashContent = bashFile.text
+      bashFile.text = bashContent.replaceFirst('APP_HOME_LIBS', Matcher.quoteReplacement('$APP_HOME/lib'))
+
+      def batFile = new File(outputDir, applicationName + ".bat")
+      String batContent = batFile.text
+      batFile.text = batContent.replaceFirst('APP_HOME_LIBS', Matcher.quoteReplacement('%APP_HOME%\\lib'))
+    }
+  }
+
+  ospackage {
+    release '1'
+    prefix '/opt/swim-tutorial'
+  }
+
+  task packageDeb(type: Deb) {
+    maintainer = 'developer@swim.ai'
+
+    configurationFile("/etc/sysconfig/${project.name}")
+    preInstall "addgroup --quiet --system ${project.name}"
+    preInstall "adduser --quiet --system --ingroup ${project.name} --no-create-home --disabled-password ${project.name}"
+    postInstall "systemctl preset ${project.name} > /dev/null 2>&1"
+    postInstall "systemctl start ${project.name} > /dev/null 2>&1"
+    preUninstall  "systemctl disable ${project.name} > /dev/null 2>&1"
+    preUninstall  "systemctl stop ${project.name} > /dev/null 2>&1"
+    postUninstall "systemctl daemon-reload > /dev/null 2>&1"
+
+    from('pkg') {
+      into '/etc/systemd/system'
+      include '*.service'
+      addParentDirs false
+      expand project.properties
+      user 'root'
+      permissionGroup 'root'
+      fileMode = 0644
+    }
+
+    from('pkg') {
+      into '/etc/sysconfig'
+      include "${project.name}"
+      user 'root'
+      permissionGroup 'root'
+      fileMode = 0644
+      fileType CONFIG | NOREPLACE
+    }
+  }
+}

server/gradle.properties

@@ -0,0 +1 @@
+application.version=3.9.0

server/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists