Files and Libraries

C Client Library

Created November 2, 2017

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.

C Example
#include <scm-manager.c>
//...

xmlTextReaderPtr reader = ...; //set up the reader to the url.
scm_manager_ns0_scmState *response_element = ...;
response_element = xml_read_scm_manager_ns0_scmState(reader);

//handle the response as needed...

//free the scm_manager_ns0_scmState
free_scm_manager_ns0_scmState(response_element);
    

Files
name size description
scm-manager.c 618.88K  
enunciate-common.c 39.68K Common code needed for all projects.

GWT JSON Overlay

Created November 2, 2017

The Google Web Toolkit JSON Overlay library provides the JSON Overlays that can be used to access the Web service API for this application.

JSON Overlay Example
String url = ...;
RequestBuilder request = new RequestBuilder(RequestBuilder.GET, url);
request.sendRequest(null, new RequestCallback() {
  public void onResponseReceived(Request request, Response response) {
    if (200 == response.getStatusCode()) {
      //handle the successful data...
      ScmState data = ScmState.fromJson(response.getText());
      //handle the ScmState...
    }
    else {
      //handle the error...
    }
  }

  public void onError(Request request, Throwable throwable) {
    //handle the error...
  }
});
    

Files
name size description
scm-manager-gwt-json-overlay.jar 23.88K The sources for the GWT JSON overlay.

Java JSON Client Library

Created November 2, 2017

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.

Resources Example (Raw JAXB)
java.net.URL url = new java.net.URL(baseURL + "/authentication");
ObjectMapper mapper = new ObjectMapper();
java.net.URLConnection connection = url.openConnection();
connection.connect();

ScmState result = (ScmState) mapper.readValue( connection.getInputStream(), ScmState.class );
//handle the result as needed...
    
Resources Example (Jersey client)
javax.ws.rs.client.Client client = javax.ws.rs.client.ClientBuilder.newClient();

ScmState result = client.target(baseUrl + "/authentication")
  .get(ScmState.class);

//handle the result as needed...
    

Files
name size description
scm-manager-json-client-json-sources.jar 24.02K The sources for the Java JSON client library.

Java XML Client Library

Created November 2, 2017

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

The Java 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 resources that are published by this application.

Resources Example (Raw JAXB)
java.net.URL url = new java.net.URL(baseURL + "/authentication");
JAXBContext context = JAXBContext.newInstance( byte[].class );
java.net.URLConnection connection = url.openConnection();
connection.connect();

Unmarshaller unmarshaller = context.createUnmarshaller();
ScmState result = (ScmState) unmarshaller.unmarshal( connection.getInputStream() );
//handle the result as needed...
    
Resources Example (Jersey client)
javax.ws.rs.client.Client client = javax.ws.rs.client.ClientBuilder.newClient();

ScmState result = client.target(baseUrl + "/authentication")
  .get(ScmState.class);

//handle the result as needed...
    

Files
name size description
scm-manager-xml-client.jar 30.74K The binaries for the Java XML client library.
scm-manager-xml-client-xml-sources.jar 25.78K The sources for the Java XML client library.

JavaScript Client Library

Created November 2, 2017

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

The library uses ES6 class syntax which has limited support. See MDN and the ES6 Compatibility Table for more details.

The library contains a UMD loader which supports AMD, CommonJS and browser globals. The browser global variable name for this library is "javascriptClient".

JavaScript Example
//read the resource in JSON:
var json = JSON.parse(jsonString);

//create an object
var object = new Object(json);

//retreive the json again
var newJson = object.toJSON();

//serialize the json
var newJsonString = JSON.stringify(newJson);
    

Files
name size description
scm-manager-js.zip 8.54K  

Objective C Client Library

Created November 2, 2017

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.

Objective C Example
#import <scm-manager.h>
//...

SCM_MANAGERNS0ScmState *responseElement;
NSData *responseData; //data holding the XML from the response.
NSURL *baseURL = ...; //the base url including the host and subpath.
NSURL *url = [NSURL URLWithString: @"/authentication" 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];
SCM_MANAGERNS0ScmState *responseElement = [SCM_MANAGERNS0ScmState readFromXML: responseData];
[responseElement retain];

//handle the response as needed...
    

Files
name size description
scm-manager.h 37.29K  
scm-manager.m 461.79K  
enunciate-common.h 12.83K Common header needed for all projects.
enunciate-common.m 42.34K Common implementation code needed for all projects.

PHP JSON Client Library

Created November 2, 2017

The PHP JSON client-side library defines the PHP classes that can be (de)serialized to/from JSON. This is useful for accessing the resources 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+.

PHP JSON Example
//read the resource in JSON:
$json = ...;

//read the json as an array.
$parsed = json_decode($json, true);

//read the json array as the object
$result = new Object($parsed);

//open a writer for the json
$json = $result->toJson();
    

Files
name size description
scm-manager-php.zip 9.91K  

PHP XML Client Library

Created November 2, 2017

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

This library leverages the XMLReader and XMLWriter tools that were included in PHP versions 5.1.0+.

PHP XML Example
//read the resource in XML form:
$xml = ...;

$reader = new \XMLReader();

if (!$reader->open($xml)) {
  throw new \Exception('Unable to open ' . $xml);
}
$result = new Object($reader);

//open a writer for the xml
$out = ...;
$writer = new \XMLWriter();
$writer->openUri($out);
$writer->startDocument();
$writer->setIndent(4);
$result->toXml($writer);
$writer->flush();
    

Files
name size description
scm-manager-php.zip 12.20K  

Ruby JSON Client Library

Created November 2, 2017

The Ruby JSON 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.

Ruby JSON 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 = Object.from_json(JSON.parse(res.body))

//handle the result as needed...
    

Files
name size description
scm-manager.rb 134.19K