R Service Bus – API

Documentation: Introduction

Mon, 01 Jan 0001 00:00:00 +0000

This is the R Service Bus (RSB) API.

SOAP+MTOM API (Synchronous)

The RSB SOAP+MTOM API is fully described by its WSDL and the related XSDs.

REST API (Asynchronous)

The RSB REST API is documented below. Its micro-format is defined in the following XSDs for XML message definitions:

The JSON equivalents of these XML messages is built following the Jettison conventions as highlighted in this CXF documentation.

The REST API supports a set of HTTP headers:

Content-Type: required, defines the format of the data being sent by the client. Either application/json, application/xml or application/zip.
Accept: optional, defines the micro-format used by RSB when responding to a request. Either: application/vnd.rsb+xml or application/vnd.rsb+json (defaults to the former if absent).
X-RSB-Application-Name: required, a valid RSB application name (ie. must match this regular expression: /w+).
X-RSB-Meta-rScript and X-RSB-Meta-sweaveFile: standard optional job meta information parameters.
for custom job-specific meta information parameters, there are two possible specification types:
- (A) the parameter name is specified in the header field name (legacy method)
```
Field-Name: X-RSB-Meta-<ParameterName>`
Field-Value: <ParameterValue>`
```
  Note: since RSB 6.5 the parameter name is always converted to lower case; use specification type B for support of upper and mixed case names
- (B) the parameter is specified by a name-value pair in the header field value (since RSB 6.5)
```
Field-Name: X-RSB-Meta-#<Identifier>
Field-Value: <ParameterName>= <ParameterValue>`
```
  The identifier (e.g. a number) is required, in order that each HTTP header field name is unique; the identifier has no other meaning.

Any HTTP client that supports the GET, POST and DELETE verbs and HTTP headers can be used to interact with the REST API.

Example Interaction

This interaction will be done using the XML RSB micro-format. Only the significant HTTP headers are shown. Posting XML and JSON jobs is done the same way, only with different content types.

Posting a job

Request:

POST /rsb/api/rest/jobs HTTP/1.1
Content-Type: application/zip
X-RSB-Application-Name: testApp

...ZIP data...

Response:

HTTP/1.1 202 Accepted
Content-Type: application/vnd.rsb+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobToken xmlns="http://rest.rsb.openanalytics.eu/types"
jobId="1f8c8aea-8d90-4bdf-92bb-b8da52f35e58"
applicationName="testApp"
submissionTime="2011-06-28T17:07:03.220Z"
applicationResultsUri="http://localhost:8888/rsb/api/rest/results/testApp"
resultUri="http://localhost:8888/rsb/api/rest/results/testApp/1f8c8aea-8d90-4bdf-92bb-b8da52f35e58"/>

The job token contains the necessary links to either browse all the jobs for the concerned application or to retrieve the result of the current job.

Retrieving a result

Request:

 GET /rsb/api/rest/results/testApp/1f8c8aea-8d90-4bdf-92bb-b8da52f35e58 HTTP/1.1

Response when the result is not ready:


HTTP/1.1 404 Not Found

Response when the result is ready:

HTTP/1.1 200 OK
Content-Type: application/vnd.rsb+xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result xmlns="http://rest.rsb.openanalytics.eu/types"
jobId="1f8c8aea-8d90-4bdf-92bb-b8da52f35e58"
applicationName="testApp"
resultTime="2011-06-28T17:07:03.000Z"
success="true"
type="zip"
selfUri="http://localhost:8888/rsb/api/rest/results/testApp/1f8c8aea-8d90-4bdf-92bb-b8da52f35e58"
dataUri="http://localhost:8888/rsb/api/rest/result/testApp/1f8c8aea-8d90-4bdf-92bb-b8da52f35e58.zip"/>

As you can see, this is only the metadata for a result. The actual result data is reachable, with an HTTP GET, using the the provided data URI.

Deleting a result

Request:

 DELETE /rsb/api/rest/results/testApp/1f8c8aea-8d90-4bdf-92bb-b8da52f35e58 HTTP/1.1

Response:


HTTP/1.1 204 No Content

Browser Client

It is also possible to use the REST API from a browser, using a standard HTML form. In that case the following rules apply:

Content-Type must be multipart/form-data upload.
Accept: must be either application/xml or application/json (content sub-types are not well understood by browsers, hence the usage of the canonical XML and JSON types).
The X-RSB-* headers must be passed as form input field values named after the HTTP header they pass a value for.
File attachments must be passed as form input fields of type ‘file’ that must be named: X-RSB-JobFile[]

Documentation: REST

Mon, 01 Jan 0001 00:00:00 +0000

This API supports a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. The following resources are accessible through the RESTful model:

There is also a WADL document describing the REST API.

Documentation: SOAP

Mon, 01 Jan 0001 00:00:00 +0000

This API is exposed through a set of WSI Basic Profile-compliant SOAP v1.1 endpoints. The API supports XML-binary Optimized Packaging (XOP) and SOAP Message Transmission Optimization Mechanism (MTOM) for transmission of binary data. The SOAP API is fully described by the MtomJobService endpoint which has the following endpoint metadata:

Namespace: http://soap.rsb.openanalytics.eu/jobs
WSDL: soap.wsdl
Mount Point: /soap/MtomJobService

The MtomJobService has a Process method available, with a job input parameter.

The RSB SOAP+MTOM API is fully described by its WSDL and the related XSDs:

The SOAP API is also accessible by client-side libraries that can be downloaded from the Clients page.

Documentation: Data

Mon, 01 Jan 0001 00:00:00 +0000

All endpoints act on a common set of data. The data can be represented in different data formats (i.e. MIME types), depending on the endpoint that consumes and/or produces the data. The data can described by XML Schema, which definitively describes the XML representation of the data, but is also useful for describing the other formats of the data, such as JSON.

This document will describe the data using terms based on XML Schema. Data can be grouped by namespace, with a schema document describing the elements and types of the namespace. Generally speaking, types define the structure of the data and elements are instances of a type. For example, elements are usually produced by (or consumed by) a REST endpoint, and the structure of each element is described by its type.

Data Schemas

id	namespace	schema file
rest-data	`http://rest.rsb.openanalytics.eu/types`	rest-data.xsd
soap-data	`http://soap.rsb.openanalytics.eu/types`	soap-data.xsd

XML Data Elements

namespace rest-data
- catalog
- directory
- errorResult
- jobToken
- nodeInformation
- result
- results
- rServiPools

XML Data Types

namespace rest-data
namespace soap-data

Documentation: REST-data

Mon, 01 Jan 0001 00:00:00 +0000

Namespace: http://rest.rsb.openanalytics.eu/types
XML Schema File: rest-data.xsd

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

catalog
directory
errorResult
jobToken
nodeInformation
result
results
rServiPools

The following types are members of this namespace:

catalogDirectory
catalogFileType
catalogType
directoryType
errorResultType
fileType
jobTokenType
nodeInformationType
resultsType
resultType
rServiPoolsType
rServiPoolType

Element catalog

Type: catalogType

Java class for catalogType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}catalogDirectory" maxOccurs="4" minOccurs="4" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://rest.rsb.openanalytics.eu/types">
  <directory type="..." path="...">
    <file name="..." dataUri="..." />
    <file name="..." dataUri="...">
      <!--...-->
    </file>
    <!--...more "file" elements...-->
  </directory>
  <directory type="..." path="...">
    <!--...-->
  </directory>
  <!--...more "directory" elements...-->
</catalog>

Example JSON

{
  "directory":[
    {
       "type":"...",
       "path":"...",
       "file":[
          {
             "name":"...",
             "dataUri":...
          },
          ...
       ]
    },
    ...
  ]
}

Element directory

Type: directoryType

Java class for directoryType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="directoryType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}directoryType" maxOccurs="unbounded" minOccurs="0" />
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}fileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="uri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="empty" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<directory xmlns="http://rest.rsb.openanalytics.eu/types" path="..." name="..." uri="..." empty="...">
  <directory>
    <!--...-->
  </directory>
  <directory path="..." name="..." uri="..." empty="...">
    <!--...-->
  </directory>
  <!--...more "directory" elements...-->
  <file path="..." name="..." />
  <file path="..." name="...">
    <!--...-->
  </file>
  <!--...more "file" elements...-->
</directory>

Example JSON

{
  "path": "...",
  "name": "...",
  "uri": "...",
  "empty": false,
  "directory": 
  [    
    {
      "...": "..."
    },
    "..."
  ],
  "file": 
  [    
    {
      "path": "...",
      "name": "..."
    },
    "..."
  ]
}

Element errorResult

Type: errorResultType

Java class for errorResultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="errorResultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="errorMessage" type="{http://www.w3.org/2001/XMLSchema}string" />
      </sequence>
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<errorResult xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." submissionTime="...">
  <errorMessage>...</errorMessage>
</errorResult>

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "submissionTime": "...",
  "errorMessage": "..."
}

Element jobToken

Type: jobTokenType

Java class for jobTokenType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="jobTokenType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="applicationResultsUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="resultUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<jobToken xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." submissionTime="..." applicationResultsUri="..." resultUri="..." />

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "submissionTime": "...",
  "applicationResultsUri": "...",
  "resultUri": "..."
}

Element nodeInformation

Type: nodeInformationType

Java class for nodeInformationType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="nodeInformationType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="healthy" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="uptime" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="uptimeText" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="servletContainerInfo" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="rsbVersion" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="jvmMaxMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="jvmFreeMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="osLoadAverage" use="required" type="{http://www.w3.org/2001/XMLSchema}double" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<nodeInformation xmlns="http://rest.rsb.openanalytics.eu/types" name="..." healthy="..." uptime="..." uptimeText="..." servletContainerInfo="..." rsbVersion="..." jvmMaxMemory="..." jvmFreeMemory="..." osLoadAverage="..." />

Example JSON

{
  "name": "...",
  "healthy": false,
  "uptime": "...",
  "uptimeText": "...",
  "servletContainerInfo": "...",
  "rsbVersion": "...",
  "jvmMaxMemory": "...",
  "jvmFreeMemory": "...",
  "osLoadAverage": "..."
}

Element result

Type: resultType

Java class for resultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="resultTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="success" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="selfUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<result xmlns="http://rest.rsb.openanalytics.eu/types" jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="..." />

Example JSON

{
  "jobId": "...",
  "applicationName": "...",
  "resultTime": "...",
  "success": false,
  "type": "...",
  "selfUri": "...",
  "dataUri": "..."
}

Element results

Type: resultsType

Java class for resultsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="result" type="{http://rest.rsb.openanalytics.eu/types}resultType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://rest.rsb.openanalytics.eu/types">
  <result jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="..." />
  <result jobId="..." applicationName="..." resultTime="..." success="..." type="..." selfUri="..." dataUri="...">
    <!--...-->
  </result>
  <!--...more "result" elements...-->
</results>

Example JSON

{
  "result": 
  [    
    {
      "jobId": "...",
      "applicationName": "...",
      "resultTime": "...",
      "success": false,
      "type": "...",
      "selfUri": "...",
      "dataUri": "..."
    },
    "..."
  ]
}

Element rServiPools

Type: rServiPoolsType

Java class for rServiPoolsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="rServiPool" type="{http://rest.rsb.openanalytics.eu/types}rServiPoolType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<rServiPools xmlns="http://rest.rsb.openanalytics.eu/types">
  <rServiPool poolUri="..." applicationNames="..." default="..." />
  <rServiPool poolUri="..." applicationNames="..." default="...">
    <!--...-->
  </rServiPool>
  <!--...more "rServiPool" elements...-->
</rServiPools>

Example JSON

{
  "rServiPool": 
  [    
    {
      "poolUri": "...",
      "applicationNames": "...",
      "default": false
    },
    "..."
  ]
}

Type catalogDirectory

Java class for catalogDirectory complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogDirectory">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}catalogFileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="type" use="required">
        <simpleType>
          <restriction base="{http://www.w3.org/2001/XMLSchema}NMTOKEN">
            <enumeration value="EMAIL_REPLIES" />
            <enumeration value="JOB_CONFIGURATIONS" />
            <enumeration value="R_SCRIPTS" />
            <enumeration value="SWEAVE_FILES" />
          </restriction>
        </simpleType>
      </attribute>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
type	string	(no documentation provided)
path	string	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
file (catalogFileType)	0/unbounded	(no documentation provided)

Type catalogFileType

Java class for catalogFileType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogFileType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
name	string	(no documentation provided)
dataUri	anyURI	(no documentation provided)

Type catalogType

Java class for catalogType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="catalogType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}catalogDirectory" maxOccurs="4" minOccurs="4" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
directory (catalogDirectory)	1/unbounded	(no documentation provided)

Type directoryType

Java class for directoryType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="directoryType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="directory" type="{http://rest.rsb.openanalytics.eu/types}directoryType" maxOccurs="unbounded" minOccurs="0" />
        <element name="file" type="{http://rest.rsb.openanalytics.eu/types}fileType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="uri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="empty" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
path	string	(no documentation provided)
name	string	(no documentation provided)
uri	anyURI	(no documentation provided)
empty	boolean	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
directory (directoryType)	0/unbounded	(no documentation provided)
file (fileType)	0/unbounded	(no documentation provided)

Type errorResultType

Java class for errorResultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="errorResultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="errorMessage" type="{http://www.w3.org/2001/XMLSchema}string" />
      </sequence>
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
submissionTime	dateTime	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
errorMessage (string)	1/1	(no documentation provided)

Type fileType

Java class for fileType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="fileType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
path	string	(no documentation provided)
name	string	(no documentation provided)

Type jobTokenType

Java class for jobTokenType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="jobTokenType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="submissionTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="applicationResultsUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="resultUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
submissionTime	dateTime	(no documentation provided)
applicationResultsUri	anyURI	(no documentation provided)
resultUri	anyURI	(no documentation provided)

Type nodeInformationType

Java class for nodeInformationType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="nodeInformationType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="healthy" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="uptime" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="uptimeText" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="servletContainerInfo" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="rsbVersion" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="jvmMaxMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="jvmFreeMemory" use="required" type="{http://www.w3.org/2001/XMLSchema}long" />
      <attribute name="osLoadAverage" use="required" type="{http://www.w3.org/2001/XMLSchema}double" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
healthy	boolean	(no documentation provided)
uptime	long	(no documentation provided)
uptimeText	string	(no documentation provided)
servletContainerInfo	string	(no documentation provided)
rsbVersion	string	(no documentation provided)
jvmMaxMemory	long	(no documentation provided)
jvmFreeMemory	long	(no documentation provided)
osLoadAverage	double	(no documentation provided)

Type resultsType

Java class for resultsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="result" type="{http://rest.rsb.openanalytics.eu/types}resultType" maxOccurs="unbounded" minOccurs="0" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
result (resultType)	0/unbounded	(no documentation provided)

Type resultType

Java class for resultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="jobId" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="applicationName" use="required" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
      <attribute name="resultTime" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
      <attribute name="success" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
      <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="selfUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="dataUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
jobId	string	(no documentation provided)
applicationName	string	(no documentation provided)
resultTime	dateTime	(no documentation provided)
success	boolean	(no documentation provided)
type	string	(no documentation provided)
selfUri	anyURI	(no documentation provided)
dataUri	anyURI	(no documentation provided)

Type rServiPoolsType

Java class for rServiPoolsType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolsType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="rServiPool" type="{http://rest.rsb.openanalytics.eu/types}rServiPoolType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
rServiPool (rServiPoolType)	1/unbounded	(no documentation provided)

Type rServiPoolType

Java class for rServiPoolType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="rServiPoolType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="poolUri" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
      <attribute name="applicationNames" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="default" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
poolUri	anyURI	(no documentation provided)
applicationNames	string	(no documentation provided)
default	boolean	(no documentation provided)

Documentation: SOAP-data

Mon, 01 Jan 0001 00:00:00 +0000

Namespace: http://soap.rsb.openanalytics.eu/types
XML Schema File: soap-data.xsd

The following types are members of this namespace:

(anonymous)
jobType
payloadType
resultType

Type (anonymous)

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType>
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
name	string	(no documentation provided)
value	string	(no documentation provided)

Type jobType

Java class for jobType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="jobType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="applicationName" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
        <element name="parameter" maxOccurs="unbounded" minOccurs="0">
          <complexType>
            <complexContent>
              <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
                <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
              </restriction>
            </complexContent>
          </complexType>
        </element>
        <element name="payload" type="{http://soap.rsb.openanalytics.eu/types}payloadType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
applicationName (string)	1/1	(no documentation provided)
parameter ()	0/unbounded	(no documentation provided)
payload (payloadType)	1/unbounded	(no documentation provided)

Type payloadType

Java class for payloadType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="payloadType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="data" type="{http://www.w3.org/2001/XMLSchema}base64Binary" />
      </sequence>
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
      <attribute name="contentType" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Attributes

name	type	description
name	string	(no documentation provided)
contentType	string	(no documentation provided)

Child Elements

name (type)	min/max occurs	description
data (base64Binary)	1/1	(no documentation provided)

Type resultType

Java class for resultType complex type.

The following schema fragment specifies the expected content contained within this class.

<?xml version="1.0" encoding="UTF-8"?>
<complexType name="resultType">
  <complexContent>
    <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      <sequence>
        <element name="applicationName" type="{http://rsb.openanalytics.eu/types}applicationNameType" />
        <element name="jobId" type="{http://www.w3.org/2001/XMLSchema}string" />
        <element name="success" type="{http://www.w3.org/2001/XMLSchema}boolean" />
        <element name="payload" type="{http://soap.rsb.openanalytics.eu/types}payloadType" maxOccurs="unbounded" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

Child Elements

name (type)	min/max occurs	description
applicationName (string)	1/1	(no documentation provided)
jobId (string)	1/1	(no documentation provided)
success (boolean)	1/1	(no documentation provided)
payload (payloadType)	1/unbounded	(no documentation provided)

Documentation: Clients

Mon, 01 Jan 0001 00:00:00 +0000

C Client Library

Introduction

The C module generates the source code for the ANSI-C-compatible data structures and (de)serialization functions that can be used in conjunction with libxml2 to (de)serialize the REST resources as they are represented as XML data.

The generated C source code depends on the XML Reader API and the XML Writer API as well as the <time.h>, <string.h>, and <stdlib.h> C standard libraries.

REST XML Example

#include <rsb.c>
//... 
xmlTextReaderPtr reader = ...;
//set up the reader to the url.
rsb_rest_data_resultsType *response_element = ...;
response_element = xml_read_rsb_rest_data_resultsType(reader);
//handle the response as needed...
//free the rsb_rest_data_resultsType
free_rsb_rest_data_resultsType(response_element);

Files:

rsb.c
enunciate-common.c: common code needed for all projects

.NET Client Library

Introduction

The .NET client-side library may be used to access the SOAP API for this application via the .NET runtime.

.NET Service Example

//instantiate a new service...
MtomJobProcessor service = new MtomJobProcessor();
//make the remote call...
result = service.Process(job);
//handle the result as needed...

The .NET client-side library defines the classes that can be (de)serialized to/from XML. This is useful for accessing the REST endpoints that are published by this application.

REST Example

//read a resource from a REST url
Uri uri = new Uri(...);
XmlSerializer s = new XmlSerializer( typeof( Results ) );
//Create the request object WebRequest req =
WebRequest.Create(uri);
WebResponse resp = req.GetResponse();
Stream stream = resp.GetResponseStream();
TextReader r = new StreamReader( stream );
Results order = (Results) s.Deserialize( r );
//handle the result as needed...

Files:

rsb-dotnet.zip: bundle of C# code

Java Client Library

Introduction

The Java client-side library is used to access the Web service API for this application.

The Java client-side uses JAX-WS to access the SOAP API for this application.

JAX-WS Example

// instantiate a new service with an impl
// (or through dependency injection, or whatever)...
MtomJobProcessor service = new MtomJobProcessor();
//make the remote call to read the result...
result = service.process(job);
//handle the result as needed...

The JAX-WS client-side library is used to provide the set of Java objects that can be serialized to/from XML using JAXB. This is useful for accessing the REST endpoints that are published by this application.

REST Example (Raw JAXB)

java.net.URL url = new java.net.URL(baseURL + "/results/{applicationName}");
JAXBContext context = JAXBContext.newInstance( Results.class );
java.net.URLConnection connection = url.openConnection();
connection.connect();
Unmarshaller unmarshaller = context.createUnmarshaller();
Results result = (Results) unmarshaller.unmarshal( connection.getInputStream() );
//handle the result as needed...

REST Example (Jersey client)

com.sun.jersey.api.client.Client client = com.sun.jersey.api.client.Client.create();
Results result = client.resource(baseUrl + "/results/{applicationName}") .get(Results.class);
//handle the result as needed...

Files:

rsb-client.jar: the binaries for the Java client library
rsb-client-sources.jar: the sources for the Java client library

Java JSON Client Library

Introduction

The Java client-side library is used to provide the set of Java objects that can be serialized to/from JSON using Jackson. This is useful for accessing the JSON REST endpoints that are published by this application.

REST Example (Raw Jackson)

 java.net.URL url = new java.net.URL(baseURL + "/results/{applicationName}");
 ObjectMapper mapper = new ObjectMapper();
 java.net.URLConnection connection = url.openConnection();
 connection.connect();
 Results result = (Results) mapper.readValue( connection.getInputStream(), Results.class );
 //handle the result as needed...

Files:

rsb-json-client.jar: the binaries for the Java JSON client library.
rsb-json-client-sources.jar: the sources for the Java JSON client library.

Objective C Client Library

Introduction

The Objective C module generates the source code for the Objective C classes and (de)serialization functions that can be used in conjunction with libxml2 to (de)serialize the REST resources as they are represented as XML data.

The generated Objective C source code depends on the XML Reader API and the XML Writer API as well as the base OpenStep foundation classes.

REST XML Example

#import <rsb.h>
//... 
RSBREST_DATAResults *responseElement;
NSData *responseData;
//data holding the XML from the response.
NSURL *baseURL = ...;
//the base url including the host and subpath.
NSURL *url = [NSURL URLWithString: @"/results/{applicationName}" relativeToURL: baseURL];
NSMutableURLRequest *request = [[NSMutableURLRequest alloc] initWithURL:url];
NSURLResponse *response = nil;
NSError *error = NULL;
[request setHTTPMethod: @"GET"];
//this example uses a synchronous request,
//but you'll probably want to use an asynchronous call
// responseData = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
// RSBREST_DATAResults *responseElement = [RSBREST_DATAResults readFromXML: responseData];
// [responseElement retain];
//handle the response as needed...

Files:

rsb.h
rsb.m
enunciate-common.h: common header needed for all projects.
enunciate-common.m: common implementation needed for all projects.

PHP Client Library

Introduction

The PHP client-side library defines the PHP classes that can be (de)serialized to/from JSON. This is useful for accessing the REST endpoints that are published by this application, but only those that produce a JSON representation of their resources (content type “application/json”).

This library requires the json_encode function which was included in PHP versions 5.2.0+.

Files

rsb-php.zip

Ruby Client Library

Introduction

The Ruby client-side library defines the Ruby classes that can be (de)serialized to/from JSON. This is useful for accessing the REST endpoints that are published by this application, but only those that produce a JSON representation of their resources (content type “application/json”).

This library leverages the Ruby JSON Implementation, which is required in order to use this library.

JSON REST Example

require 'net/https'
require 'uri'
//...
//read a resource from a REST url
url = URI.parse("...")
request = Net::HTTP::Get.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
//set up additional http stuff...
res = http.start do |ht| ht.request(request) end
result = Results.from_json(JSON.parse(res.body))
//handle the result as needed...

Files:

rsb.rb