Clojure SDK
Software Development Kit for Conductor, written on and providing support for Clojure.
The code for the Clojure SDk is available on Github. Please feel free to file PRs, issues, etc. there.
Get the SDK
https://clojars.org/io.orkes/conductor-clojure
Quick Guide
- Create connection options
(def options {
:url "{{ server_host }}{{ api_prefix }}/" ;; Conductor Server Path
:app-key "THIS-IS-SOME-APP-KEY" ;; Optional if using Orkes Conductor
:app-secret "THIS-IS-SOME-APP-SECRET" ;; Optional if using Orkes Conductor
} )
(ns some.namespace
(:require [io.orkes.metadata :as metadata])
;; Will Create a task. returns nil
(metadata/register-tasks options [{
:name "cool_clj_task"
:description "some description"
:ownerEmail "somemail@mail.com"
:retryCount 3
:timeoutSeconds 300
:responseTimeoutSeconds 180 }])
)
- Creating a Workflow that uses the task
(ns some.namespace
(:require [io.orkes.metadata :as metadata])
;; Will Register a workflow that uses the above task returns nil
(metadata/register-workflow-def options {
:name "cool_clj_workflow"
:description "created programatically from clj"
:version 1
:tasks [ {
:name "cool_clj_task"
:taskReferenceName "cool_clj_task_ref"
:inputParameters {}
:type "SIMPLE"
} ]
:inputParameters []
:outputParameters {:message "${clj_prog_task_ref.output.:message}"}
:schemaVersion 2
:restartable true
:ownerEmail "owner@yahoo.com"
:timeoutSeconds 0
}))
;; Creates a worker and starts polling for work. will return an instance of Runner which can then be used to shutdown
(def instance (runner-executor-for-workers
(list {
:name "cool_clj_task"
:execute (fn [someData]
[:completed {:message "Hi From Clj i was created programatically"}])
})
options ))
;; Shutsdown the polling for the workers defined above
(.shutdown instance)
Options
Options are a map with optional paremeters
(def options {
:url "{{ server_host }}{{ api_prefix }}/" ;; Api url (Optional will default to "{{ server_host }}")
:app-key "THIS-IS-SOME-APP-KEY" ;; Application Key (This is only relevant if you are using Orkes Conductor)
:app-secret "THIS-IS-SOME-APP-SECRET" ;; Application Secret (This is only relevant if you are using Orkes Conductor)
} )
Metadata namespace
Holds the functions to register workflows and tasks.
(:require [conductor.metadata :as metadata])
Registering tasks
Takes the option map and a list/vector of tasks to register. on success it will return nil
(metadata/register-tasks options [{
:name "cool_clj_task_b"
:description "some description"
:ownerEmail "mail@gmail.com"
:retryCount 3
:timeoutSeconds 300
:responseTimeoutSeconds 180 },
{
:name "cool_clj_task_z"
:description "some description"
:ownerEmail "mail@gmail.com"
:retryCount 3
:timeoutSeconds 300
:responseTimeoutSeconds 180 }
{
:name "cool_clj_task_x"
:description "some description"
:ownerEmail "mail@gmail.com"
:retryCount 3
:timeoutSeconds 300
:responseTimeoutSeconds 180 }
])
Registering a workspace
(metadata/register-workflow-def options {
:name "cool_clj_workflow_2"
:description "created programatically from clj"
:version 1
:tasks [ {
:name "cool_clj_task_b"
:taskReferenceName "cool_clj_task_ref"
:inputParameters {}
:type "SIMPLE"
},
{
:name "someting",
:taskReferenceName "other"
:inputParameters {}
:type "FORK_JOIN"
:forkTasks [[
{
:name "cool_clj_task_z"
:taskReferenceName "cool_clj_task_z_ref"
:inputParameters {}
:type "SIMPLE"
}
]
[
{
:name "cool_clj_task_x"
:taskReferenceName "cool_clj_task_x_ref"
:inputParameters {}
:type "SIMPLE"
}
]
]
}
{
:name "join"
:type "JOIN"
:taskReferenceName "join_ref"
:joinOn [ "cool_clj_task_z", "cool_clj_task_x"]
}
]
:inputParameters []
:outputParameters {"message" "${clj_prog_task_ref.output.:message}"}
:schemaVersion 2
:restartable true
:ownerEmail "mail@yahoo.com"
:timeoutSeconds 0
:timeoutPolicy "ALERT_ONLY"
})
Client namespace
The client namespace holds the function to start a workflow and running a worker
[io.orkes.client :as conductor]
;; Creates a worker and starts polling for work. will return an instance of Runner which can then be used to shutdown
(def instance (runner-executor-for-workers
(list {
:name "cool_clj_task"
:execute (fn [someData]
[:completed {:message "Hi From Clj i was created programatically"}])
})
options ))
;; Shutsdown the polling for the workers defined above
(.shutdown instance)
Mapper-Utils namespace
The [io.orkes.mapper-utils :as mapper-utils] namespace holds the functions to map to java object which are mostly not necesary.
The mapper-utils/java-map->clj-map protocol
Will map a java map to a clojure map which may come in handy for workers implementation. for example consider a worker that sums two input parameters. For a workflow defined like this :
(metadata/register-workflow-def options {:name "simple_wf"
:description "created programatically from clj"
:version 1
:tasks [{:name "simplest_task"
:taskReferenceName "repl_task_ref"
:inputParameters {"firstNumber" "${workflow.input.firstNumber}"
"secondNumber" "${workflow.input.secondNumber}"}
:type "SIMPLE"}]
:inputParameters ["firstNumber" "secondNumber"]
:outputParameters {"result" "${repl_task_ref.output.:result}"}
:schema-version 2
:restartable true
:ownerEmail "mail@yahoo.com"
:timeoutSeconds 0
:timeoutPolicy "ALERT_ONLY"})
To be able to use the input params you would need to use the string names like this:
(def instance (conductor/runner-executor-for-workers
(list {:name "simplest_task"
:execute (fn [someData]
[:completed {"result" (+ (get someData "firstNumber") (get someData "secondNumber"))}])})
options))
A more clojure friendly way would be to convert to clojure our map :