Quickstart

docker run -it --rm -p 1836:1836 -p 1837:1837 openksavi/sponge -c services/remote/remote.xml -Dsponge.serviceDir=examples/standalone/remote_service

curl -i -k -X POST -H "Content-type:application/json" http://localhost:1836/call -d '{"params":{"name":"HelloWorld","args":["User"]}}'

{"jsonrpc":"2.0","result":{"value":"Hello World! Hello User!"},"id":null}

mkdir remote_service
cd remote_service

vi service.py

class MyHelloWorld(Action):
    def onConfigure(self):
        self.withLabel("My hello world").withDescription("Returns a greeting text.")
        self.withArg(StringType("name").withLabel("Your name").withDescription("Type your name."))
        self.withResult(StringType().withLabel("Greeting").withDescription("The greeting text."))
    def onCall(self, name):
        return "My Hello World! Hello {}!".format(name)

docker run -it --rm -p 1836:1836 -p 1837:1837 -v `pwd`:/opt/service openksavi/sponge -c services/remote/remote.xml -Dsponge.serviceDir=/opt/service

curl -i -k -X POST -H "Content-type:application/json" http://localhost:1836/call -d '{"params":{"name":"MyHelloWorld","args":["User"]}}'

{"jsonrpc":"2.0","result":{"value":"My Hello World! Hello User!"},"id":null}

vi service.py

class GetDiskSpaceInfo(Action):
    def onConfigure(self):
        self.withLabel("Get disk space info").withDescription("Returns the disk space info.")
        self.withNoArgs().withResult(StringType().withFormat("console").withLabel("Disk space info"))
        self.withFeature("icon", "console")
    def onCall(self):
        return sponge.process("df", "-h").outputAsString().run().outputString

curl -i -k -X POST -H "Content-type:application/json" http://localhost:1836/call -d '{"params":{"name":"EngineReload"}}'

{"jsonrpc":"2.0","result":{"value":null},"id":null}

curl -s -X POST -H "Content-type:application/json" http://localhost:1836/call -d '{"params":{"name":"GetDiskSpaceInfo"}}' | jq -r '.result.value'

Filesystem      Size  Used Avail Use% Mounted on
overlay          63G   47G   14G  78% /
tmpfs            64M     0   64M   0% /dev
osxfs           932G  867G   51G  95% /opt/service
/dev/vda1        63G   47G   14G  78% /etc/hosts

<dependency>
    <groupId>org.openksavi.sponge</groupId>
    <artifactId>sponge-jython</artifactId>
    <version>1.16.5</version>
</dependency>

SpongeEngine engine = DefaultSpongeEngine.builder().config("examples/script/py/triggers_hello_world.xml").build(); (1)
engine.startup(); (2)

SpongeEngine engine = DefaultSpongeEngine.builder().knowledgeBase("knowledgeBaseName", "examples/script/py/triggers_hello_world.py").build(); (1)
engine.startup();

kill -HUP <pid>

kill -TERM <pid>

./sponge -k ../examples/standalone/trigger_simple.py -i

> sponge.event("alarm").send()

Sound the alarm!

> def printHello():\
>     print("Hello")

class HelloWorldAction(Action): (1)
    def onConfigure(self): (2)
        self.withLabel("Hello world").withDescription("Returns a greeting text.") (3)
        self.withArg(StringType("name").withLabel("Your name").withDescription("Type your name.")) (4)
        self.withResult(StringType().withLabel("Greeting").withDescription("The greeting text.")) (5)
    def onCall(self, name): (6)
        return "Hello World! Hello {}!".format(name)

def onStartup(): (7)
    sponge.logger.info("{}", sponge.call("HelloWorldAction", ["Sponge user"])) (8)

class HelloWorldAction(Action):
    def onCall(self, name):
        return "Hello World! Hello {}!".format(name)

./sponge -k ../examples/script/py/actions_hello_world.py

sponge.enable(ActionBuilder("HelloWorldAction").withOnCall(lambda action, name: "Hello World! Hello {}!".format(name)))

class HelloWorldAction < Action (1)
    def onConfigure (2)
        self.withLabel("Hello world").withDescription("Returns a greeting text.")" (3)
        self.withArg(StringType.new("name").withLabel("Your name").withDescription("Type your name.")) (4)
        self.withResult(StringType.new().withLabel("Greeting").withDescription("The greeting text.")) (5)
    end
    def onCall(name) (6)
        return "Hello World! Hello %s!" % [name]
    end
end

def onStartup (7)
    $sponge.logger.info("{}", $sponge.call("HelloWorldAction", ["Sponge user"])) (8)
end

./sponge -k ../examples/script/rb/actions_hello_world.rb

class HelloWorldAction extends Action { (1)
    void onConfigure() { (2)
        this.withLabel("Hello world").withDescription("Returns a greeting text.") (3)
        this.withArg(new StringType("name").withLabel("Your name").withDescription("Type your name.")) (4)
        this.withResult(new StringType().withLabel("Greeting").withDescription("The greeting text.")) (5)
    }

    String onCall(String name) { (6)
        return "Hello World! Hello $name!"
    }
}

void onStartup() { (7)
    sponge.logger.info("{}", sponge.call("HelloWorldAction", ["Sponge user"])) (8)
}

./sponge -k ../examples/script/groovy/actions_hello_world.groovy

var HelloWorldAction = Java.extend(Action, { (1)
    onConfigure: function(self) { (2)
        self.withLabel("Hello world").withDescription("Returns a greeting text."); (3)
        self.withArg(new StringType("name").withLabel("Your name").withDescription("Type your name.")); (4)
        self.withResult(new StringType().withLabel("Greeting").withDescription("The greeting text.")); (5)
    },
    onCall: function(self, args) { (6)
        // The onCall method in JS always gets an array of arguments. Dynamic onCall callback methods are not supported.
        return "Hello World! Hello " + args[0] + "!";
    }
});

function onStartup() { (7)
    sponge.logger.info("{}", sponge.call("HelloWorldAction", ["Sponge user"])) (8)
}

./sponge -k ../examples/script/js/actions_hello_world.js

class HelloWorldTrigger(Trigger): (1)
    def onConfigure(self): (2)
        self.withEvent("helloEvent") (3)
    def onRun(self, event): (4)
        print event.get("say") (5)

def onStartup(): (6)
    sponge.event("helloEvent").set("say", "Hello World!").send() (7)

./sponge -k ../examples/script/py/triggers_hello_world.py

Hello World!

class HelloWorldTrigger < Trigger (1)
    def onConfigure (2)
        self.withEvent("helloEvent") (3)
    end

    def onRun(event) (4)
        puts event.get("say") (5)
    end
end

def onStartup (6)
    $sponge.event("helloEvent").set("say", "Hello World!").send() (7)
end

./sponge -k ../examples/script/rb/triggers_hello_world.rb

class HelloWorldTrigger extends Trigger { (1)
    void onConfigure() { (2)
        this.withEvent("helloEvent") (3)
    }
    void onRun(Event event) { (4)
        println event.get("say") (5)
    }
}

void onStartup() { (6)
    sponge.event("helloEvent").set("say", "Hello World!").send() (7)
}

./sponge -k ../examples/script/groovy/triggers_hello_world.groovy

var HelloWorldTrigger = Java.extend(Trigger, { (1)
    onConfigure: function(self) { (2)
        self.withEvent("helloEvent"); (3)
    },
    onRun: function(self, event) { (4)
        print(event.get("say")); (5)
    }
});

function onStartup() { (6)
    sponge.event("helloEvent").set("say", "Hello World!").send(); (7)
}

./sponge -k ../examples/script/js/triggers_hello_world.js

# Sounds the alarm when heartbeat event stops happening at most every 2 seconds.
class HeartbeatRule(Rule): (1)
    def onConfigure(self): (2)
        self.withEvents(["heartbeat h1", "heartbeat h2 :none"]) (3)
        self.withCondition("h2", lambda rule, event: rule.firstEvent.get("source") == event.get("source")) (4)
        self.withDuration(Duration.ofSeconds(2)) (5)
    def onRun(self, event): (6)
        sponge.event("alarm").set("severity", 1).send() (7)

class AlarmTrigger(Trigger): (8)
    def onConfigure(self):
        self.withEvent("alarm")
    def onRun(self, event):
        print "Sound the alarm!"

./sponge -k ../examples/script/py/rules_heartbeat.py

Sound the alarm!

# Sounds the alarm when heartbeat event stops happening at most every 2 seconds.
class HeartbeatRule < Rule (1)
    def onConfigure (2)
        self.withEvents(["heartbeat h1", "heartbeat h2 :none"]) (3)
        self.withCondition("h2", lambda { |rule, event|
            return rule.firstEvent.get("source") == event.get("source")
        }) (4)
        self.withDuration(Duration.ofSeconds(2)) (5)
    end
    def onRun(event) (6)
        $sponge.event("alarm").set("severity", 1).send() (7)
    end
end

class AlarmTrigger < Trigger (8)
    def onConfigure
        self.withEvent("alarm")
    end
    def onRun(event)
        puts "Sound the alarm!"
    end
end

./sponge -k ../examples/script/rb/rules_heartbeat.rb

Sound the alarm!

// Sounds the alarm when heartbeat event stops happening at most every 2 seconds.
class HeartbeatRule extends Rule { (1)
    void onConfigure() { (2)
        this.withEvents(["heartbeat h1", "heartbeat h2 :none"]) (3)
        this.withCondition("h2", { rule, event ->
            return rule.firstEvent.get("source") == event.get("source")
        }) (4)
        this.withDuration(Duration.ofSeconds(2)) (5)
    }
    void onRun(Event event) { (6)
        sponge.event("alarm").set("severity", 1).send() (7)
    }
}

class AlarmTrigger extends Trigger { (8)
    void onConfigure() {
        this.withEvent("alarm")
    }
    void onRun(Event event) {
        println "Sound the alarm!"
    }
}

./sponge -k ../examples/script/groovy/rules_heartbeat.groovy

Sound the alarm!

// Sounds the alarm when heartbeat event stops happening at most every 2 seconds.
var HeartbeatRule = Java.extend(Rule, { (1)
    onConfigure: function(self) { (2)
        self.withEvents(["heartbeat h1", "heartbeat h2 :none"]); (3)
        self.withCondition("h2", function(rule, event) {
            return rule.firstEvent.get("source") == event.get("source");
        }); (4)
        self.withDuration(Duration.ofSeconds(2)); (5)
    },
    onRun: function(self, event) { (6)
        sponge.event("alarm").set("severity", 1).send(); (7)
    }
});

var AlarmTrigger = Java.extend(Trigger, { (8)
    onConfigure: function(self) {
        self.withEvent("alarm");
    },
    onRun: function(self, event) {
        print("Sound the alarm!");
    }
});

./sponge -k ../examples/script/js/rules_heartbeat.js

Sound the alarm!