Dropwizard082 basiccallbak

.travis.yml

@@ -0,0 +1,6 @@
+language: java
+jdk:
+  - oraclejdk7
+  - openjdk7
+  - oraclejdk8
+

NOTICE

@@ -60,6 +60,7 @@ This project includes:
   Jetty :: Utilities under Apache Software License - Version 2.0 or Eclipse Public License - Version 1.0
   Jetty Orbit :: Servlet API under Apache Software License - Version 2.0 or Eclipse Public License - Version 1.0
   Joda time under Apache 2
+  JSch under Revised BSD
   JUL to SLF4J bridge under MIT License
   JUnit under Common Public License Version 1.0
   Log4j Implemented Over SLF4J under Apache Software Licenses
@@ -74,8 +75,7 @@ This project includes:
   Metrics Servlet under Apache License 2.0
   Mockito under The MIT License
   Objenesis under Apache 2
-  octopus under Apache License, Version 2.0
-  Octopus Job Webservice under Apache License, Version 2.0
+  Xenon under Apache License, Version 2.0
   powermock-api-mockito under The Apache Software License, Version 2.0
   powermock-api-support under The Apache Software License, Version 2.0
   powermock-core under The Apache Software License, Version 2.0
@@ -84,3 +84,5 @@ This project includes:
   powermock-reflect under The Apache Software License, Version 2.0
   SLF4J API Module under MIT License
 
+
+

README.rst

@@ -1,48 +1,42 @@
-joblauncher
-===========
+Osmium
+======
 
-Web service to submit jobs via a Octopus supported scheduler.
+|TravisCILink|_
+
+.. |TravisCILink| image:: https://travis-ci.org/NLeSC/osmium.png
+.. _TravisCILink: https://travis-ci.org/NLeSC/osmium
+
+Web service to submit jobs via a Xenon (https://nlesc.github.io/Xenon) supported scheduler.
 
 Submit job to web service using a HTTP POST request.
 Reports status of job to submitter using a callback url.
 
 Requirements
 ------------
 
-- JDK 7 (http://www.java.com)
+- JDK 7 or 8 (http://www.java.com)
 - Maven 3 (http://maven.apache.org)
-- Octopus (https://github.com/NLeSC/octopus)
 
 Install
 -------
 
-1. Build Octopus
+#. Make copy of 'joblauncher.yml-dist' to 'joblauncher.yml'
 
-.. code-block:: bash
+  #. Configure Xenon scheduler
+  #. Configure Xenon sandbox root directory
+  #. Configure optional callback basic credentials
 
-   git clone https://github.com/NLeSC/octopus.git
-   cd octopus
-   ant build -Dversion=-1.0
+2. Build uber-jar or execute from maven.
 
-2. Add Octopus jar to local maven repository, so it can be used as maven dependencies
-
-.. code-block:: bash
-
-   mvn install:install-file -Dfile=dist/octopus-1.0.jar -DartifactId=octopus -Dversion=1.0 -DgroupId=nl.esciencecenter.octopus -Dpackaging=jar -DgeneratePom=true
-
-3. Make copy of 'joblauncher.yml-dist' to 'joblauncher.yml'
-3.1 Configure Octopus scheduler
-3.2 Configure Octopus sandbox root directory
-3.3 Configure optional MAC id/key
-4. Build uber-jar or execute from maven.
-4.1. Uber-jar, to start on other machine the `octopus-job-ws-2.0.jar` and `joblauncher.yml` files must be copied.
+2.1. Uber-jar, to start on other machine the `osmium-3.0.2.jar` and `joblauncher.yml` files must be copied.
 
 .. code-block:: bash
 
    mvn package
-   java -jar target/octopus-job-ws-2.0.jar server joblauncher.yml
+   java -jar target/osmium-3.0.2.jar server joblauncher.yml
 
-4.2 Execute from maven
+
+2.2. Execute from maven
 
 .. code-block:: bash
 
@@ -67,14 +61,15 @@ Create a json file (query.json)
 .. code-block:: json
 
    {
-      "jobdir": "<absolute path to myjob directory>/",
+      "launcher": <optional non-default launcher name>,
+      "jobdir": "<absolute path to myjob directory>",
       "executable": "/bin/sh",
       "prestaged": ["runme.sh", "input_file"],
       "poststaged": ["output_file"],
       "stderr": "stderr.txt",
       "stdout": "stdout.txt",
       "arguments": ["runme.sh"],
-      "status_callback_url": "http://localhost/job/myjob/status"
+      "status_callback_url": "<optional url where job status is PUT to>"
    }
 
 The `status_callback_url` value is the url where the web service will send the job status with a http PUT request.
@@ -88,7 +83,7 @@ Then submit it
 
    HTTP/1.1 201 Created
    Date: Thu, 23 May 2013 11:50:28 GMT
-   Location: http://localhost:9998/job/bc66cd43-9d16-4270-813f-734e864e3552
+   Location: http://localhost:9998/job/local-1234
    Content-Type: application/json
    Content-Length: 0
 
@@ -98,8 +93,8 @@ The `Location` header value is the url where the job can be queried for it's sta
 Callback authentication
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-The status callbacks uses MAC Access Authentication.
-The MAC key indentifier and MAC key must be obtained from the provider.
+The status callbacks can use basic http authentication.
+The credentials must be added to the config file or can be given in the `status_callback_url` of the job submission request.
 
 Status
 ^^^^^^
@@ -108,14 +103,15 @@ In the submit response the url is a relative url to the job.
 
 .. code-block:: bash
 
-   curl -H "Content-Type: application/json" -H 'Accept: application/json' http://localhost:9998/job/bc66cd43-9d16-4270-813f-734e864e3552
+   curl -H "Content-Type: application/json" -H 'Accept: application/json' http://localhost:9998/job/local-1234
 
 Example response when job is running:
 
 .. code-block:: json
 
    {
        "request": {
+           "launcher": "local",
            "jobdir": "/tmp/jobdir",
            "executable": "/bin/sh",
            "stderr": "stderr.txt",
@@ -145,6 +141,7 @@ Example response when job is done:
 
    {
        "request": {
+           "launcher": "local",
            "jobdir": "/tmp/jobdir",
            "executable": "/bin/sh",
            "stderr": "stderr.txt",
@@ -174,6 +171,7 @@ Example response when job has been canceled (see below for cancel command):
 
    {
       "request": {
+         "launcher": "local",
          "jobdir": "/tmp/myjob",
          "status_callback_url": null,
          "poststaged": [
@@ -208,7 +206,7 @@ Deletes any generated output in the sandbox where the job was running.
 
 .. code-block:: bash
 
-   curl -H "Content-Type: application/json" -H 'Accept: application/json' -X DELETE http://localhost:9998/job/bc66cd43-9d16-4270-813f-734e864e3552
+   curl -H "Content-Type: application/json" -H 'Accept: application/json' -X DELETE http://localhost:9998/job/local-1234
 
 Documentation
 -------------
@@ -223,9 +221,6 @@ A maven site can be generated with
 Integration tests
 -----------------
 
-Running the integration tests requires a configuration file called `src/test/resources/integration.props`.
-An example configuration is available as `src/test/resources/integration.props-dist`.
-
 Run integration tests with
 
 .. code-block:: bash

joblauncher.yml-dist

@@ -1,17 +1,39 @@
 # Example configuration make copy of me
-#macs:
-#- id: <MAC key identifier>
-#  key: <MAC key>
-#  scope: <URL where MAC key should be used>
-octopus:
-  scheduler: local:///
-  queue: multi
-  sandboxRoot: file:///tmp/
+#callback:
+#  useInsecureSSL: false
+#  httpClient:
+#    keepAlive: "5m"
+#  basicCredentials:
+#    -
+#      username: "someone"
+#      password: "mypassword"
+#      hostname: "example.com"
+#      scheme: "https"
+#      port: 443
+xenon:
+  launchers:
+    local:
+      scheduler:
+        scheme: local
+        location: /
+        queue: multi
+      sandbox:
+        scheme: file
+        location: /
+        path: /tmp
+  defaultLauncher: local
   preferences:
-    octopus.adaptors.local.queue.multi.maxConcurrentJobs: 4
+    xenon.adaptors.local.queue.multi.maxConcurrentJobs: 4
   poll:
    interval: 30000  # 30 seconds
    cancelTimeout: 3600000  # 1 hour
    deleteTimeout: 43200000  # 12 hour
-http:
-  port: 9998
+server:
+  applicationConnectors:
+    - type: http
+      port: 9998
+      bindHost: localhost
+  adminConnectors:
+    - type: http
+      port: 9999
+      bindHost: localhost