Files and Libraries

The following files and libraries are available:

C Client Library
.NET Client Library
Java Client Library
Objective C Client Library

C Client Library

Created Apr 14, 2014 8:14:42 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 <full.c>
//...

xmlTextWriterPtr writer = ...; //set up the writer to the url.
full_ns0_openDoveServiceApplianceRequest *request_element = ...;
xmlTextReaderPtr reader = ...; //set up the reader to the url.
full_ns0_openDoveServiceApplianceRequest *response_element = ...;
//set up the full_ns0_openDoveServiceApplianceRequest...
xml_write_full_ns0_openDoveServiceApplianceRequest(writer, request_element);
response_element = xml_read_full_ns0_openDoveServiceApplianceRequest(reader);

//handle the response as needed...

//free the full_ns0_openDoveServiceApplianceRequest
free_full_ns0_openDoveServiceApplianceRequest(request_element);
//free the full_ns0_openDoveServiceApplianceRequest
free_full_ns0_openDoveServiceApplianceRequest(response_element);

Files

name	size	description
full.c	560.05K
enunciate-common.c	39.70K	Common code needed for all projects.

.NET Client Library

Created Apr 14, 2014 8:14:44 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( OpenDoveServiceApplianceRequest )
);

  //Create the request object
WebRequest req = WebRequest.Create(uri);
WebResponse resp = req.GetResponse();
Stream stream = resp.GetResponseStream();
TextReader r = new StreamReader( stream );

OpenDoveServiceApplianceRequest order = (OpenDoveServiceApplianceRequest) s.Deserialize( r );

//handle the result as needed...

This bundle contains C# source code.

Files

name	size
full-dotnet.zip	5.49K

Java Client Library

Created Apr 14, 2014 8:14:44 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 + "/odgw/{odgwUUID}/role");
JAXBContext context = JAXBContext.newInstance( OpenDoveServiceApplianceRequest.class, OpenDoveServiceApplianceRequest.class );
java.net.URLConnection connection = url.openConnection();
connection.setDoOutput(true);
connection.connect();

Unmarshaller unmarshaller = context.createUnmarshaller();
Marshaller marshaller = context.createMarshaller();
marshaller.marshal(openDoveServiceApplianceRequest, connection.getOutputStream());
OpenDoveServiceApplianceRequest result = (OpenDoveServiceApplianceRequest) 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();

OpenDoveServiceApplianceRequest result = client.resource(baseUrl + "/odgw/{odgwUUID}/role")
  .entity(openDoveServiceApplianceRequest)
  .put(OpenDoveServiceApplianceRequest.class);

//handle the result as needed...

Files

name	size	description
full-client.jar	26.27K	The binaries for the Java client library.
full-client-sources.jar	16.51K	The sources for the Java client library.

Objective C Client Library

Created Apr 14, 2014 8:14:43 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 <full.h>
//...

FULLNS0OpenDoveServiceApplianceRequest *requestElement = [[FULLNS0OpenDoveServiceApplianceRequest alloc] init];
NSData *requestData; //data holding the XML for the request.
FULLNS0OpenDoveServiceApplianceRequest *responseElement;
NSData *responseData; //data holding the XML from the response.
NSURL *baseURL = ...; //the base url including the host and subpath.
NSURL *url = [NSURL URLWithString: @"/odgw/{odgwUUID}/role" relativeToURL: baseURL];
NSMutableURLRequest *request = [[NSMutableURLRequest alloc] initWithURL:url];
NSURLResponse *response = nil;
NSError *error = NULL;
[request setHTTPMethod: @"PUT"];
[request setValue:@"application/xml" forHTTPHeaderField:@"Content-Type"];  

//set up the FULLNS0OpenDoveServiceApplianceRequest...

requestData = [requestElement writeToXML];
[request setHTTPBody: requestData];

//this example uses a synchronous request,
//but you'll probably want to use an asynchronous call
responseData = [NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];
FULLNS0OpenDoveServiceApplianceRequest *responseElement = [FULLNS0OpenDoveServiceApplianceRequest readFromXML: responseData];
[responseElement retain];

//handle the response as needed...

Files

name	size	description
full.h	32.57K
full.m	395.86K
enunciate-common.h	12.81K	Common header needed for all projects.
enunciate-common.m	42.61K	Common implementation code needed for all projects.