Files and Libraries

The following files and libraries are available:

License
C Client Library
.NET Client Library
Java Client Library
Java JSON Client Library
Objective C Client Library

License

Created May 1, 2009 8:49:30 AM

The license file governing the use of this API.

Files

name	size
LICENSE.txt	4.96K

C Client Library

Created Jan 20, 2012 3:42:07 AM

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 <agentrank.c>
//...

xmlTextReaderPtr reader = ...; //set up the reader to the url.
agentrank_ns0_contactAgent *response_element = ...;
response_element = xml_read_agentrank_ns0_contactAgent(reader);

//handle the response as needed...

//free the agentrank_ns0_contactAgent
free_agentrank_ns0_contactAgent(response_element);

Files

name	size	description
agentrank.c	779.15K
enunciate-common.c	38.69K	Common code needed for all projects.

.NET Client Library

Created Jan 20, 2012 3:42:15 AM

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( ContactAgent )
);

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

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

//handle the result as needed...

This bundle contains C# source code.

Files

name	size
agentrank-dotnet.zip	7.96K

Java Client Library

Created Jan 20, 2012 3:42:15 AM

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 + "/agent/contact/{id}");
JAXBContext context = JAXBContext.newInstance( ContactAgent.class );
java.net.URLConnection connection = url.openConnection();
connection.connect();

Unmarshaller unmarshaller = context.createUnmarshaller();
ContactAgent result = (ContactAgent) 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();

ContactAgent result = client.resource(baseUrl + "/agent/contact/{id}")
  
  .post(ContactAgent.class);

//handle the result as needed...

Files

name	size	description
agentrank-jersey-client.jar	44.38K	The binaries for the Java client library.
agentrank-jersey-client-sources.jar	34.10K	The sources for the Java client library.

Java JSON Client Library

Created Jan 20, 2012 3:42:15 AM

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 + "/agent/contact/{id}");
ObjectMapper mapper = new ObjectMapper();
java.net.URLConnection connection = url.openConnection();
connection.connect();

ContactAgent result = (ContactAgent) mapper.readValue( connection.getInputStream(), ContactAgent.class );
//handle the result as needed...

Files

name	size	description
agentrank-json-client.jar	37.24K	The binaries for the Java JSON client library.
agentrank-json-client-sources.jar	32.92K	The sources for the Java JSON client library.

Objective C Client Library

Created Jan 20, 2012 3:42:09 AM

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 <agentrank.h>
//...

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

//handle the response as needed...

Files

name	size	description
agentrank.h	52.16K
agentrank.m	573.37K
enunciate-common.h	12.22K	Common header needed for all projects.
enunciate-common.m	41.77K	Common implementation code needed for all projects.