Files and Libraries

The following files and libraries are available:

C Client Library

Created Mar 16, 2015 4:29:01 PM

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 <hegira-api.c> //... xmlTextReaderPtr reader = ...; //set up the reader to the url. hegira_api_ns0_status *response_element = ...; response_element = xml_read_hegira_api_ns0_status(reader); //handle the response as needed... //free the hegira_api_ns0_status free_hegira_api_ns0_status(response_element);

Files

name size description
hegira-api.c 33.39K
enunciate-common.c 39.67K Common code needed for all projects.

.NET Client Library

Created Mar 16, 2015 4:29:02 PM

Introduction

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( Status ) ); //Create the request object WebRequest req = WebRequest.Create(uri); WebResponse resp = req.GetResponse(); Stream stream = resp.GetResponseStream(); TextReader r = new StreamReader( stream ); Status order = (Status) s.Deserialize( r ); //handle the result as needed...

This bundle contains C# source code.

Files

name size
hegira-api-dotnet.zip 818.00bytes

Java Client Library

Created Mar 16, 2015 4:29:02 PM

Introduction

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

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 + "/api/switchover"); JAXBContext context = JAXBContext.newInstance( Status.class ); java.net.URLConnection connection = url.openConnection(); connection.connect(); Unmarshaller unmarshaller = context.createUnmarshaller(); Status result = (Status) 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(); Status result = client.resource(baseUrl + "/api/switchover") .post(Status.class); //handle the result as needed...

Files

name size description
hegira-api-client.jar 3.36K The binaries for the Java client library.
hegira-api-client-sources.jar 1.26K The sources for the Java client library.

Java JSON Client Library

Created Mar 16, 2015 4:29:02 PM

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 + "/api/switchover"); ObjectMapper mapper = new ObjectMapper(); java.net.URLConnection connection = url.openConnection(); connection.connect(); Status result = (Status) mapper.readValue( connection.getInputStream(), Status.class ); //handle the result as needed...

Files

name size description
hegira-api-json-client.jar 1.51K The binaries for the Java JSON client library.
hegira-api-json-client-sources.jar 1.23K The sources for the Java JSON client library.

Objective C Client Library

Created Mar 16, 2015 4:29:01 PM

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 <hegira-api.h> //... HEGIRA_APINS0Status *responseElement; NSData *responseData; //data holding the XML from the response. NSURL *baseURL = ...; //the base url including the host and subpath. NSURL *url = [NSURL URLWithString: @"/api/switchover" relativeToURL: baseURL]; NSMutableURLRequest *request = [[NSMutableURLRequest alloc] initWithURL:url]; NSURLResponse *response = nil; NSError *error = NULL; [request setHTTPMethod: @"POST"]; //this example uses a synchronous request, //but you'll probably want to use an asynchronous call responseData = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error]; HEGIRA_APINS0Status *responseElement = [HEGIRA_APINS0Status readFromXML: responseData]; [responseElement retain]; //handle the response as needed...

Files

name size description
hegira-api.h 1.93K
hegira-api.m 25.88K
enunciate-common.h 12.82K Common header needed for all projects.
enunciate-common.m 42.34K Common implementation code needed for all projects.

PHP Client Library

Created Mar 16, 2015 4:29:02 PM

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

name size
hegira-api-php.zip 2.28K

Ruby Client Library

Created Mar 16, 2015 4:29:01 PM

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::Post.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 = Status.from_json(JSON.parse(res.body)) //handle the result as needed...

Files

name size
hegira-api.rb 3.70K