AgentRank(TM) API

Introduction

The following items are available for download:

License

Created May 1, 2009 8:49:30 AM.

The license file governing the use of this API.

file size
LICENSE.txt 4.96K

C Client Library

Created Jul 25, 2010 6:20:33 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_getAgent *response_element = ...; response_element = xml_read_agentrank_ns0_getAgent(reader); //handle the response as needed... //free the agentrank_ns0_getAgent free_agentrank_ns0_getAgent(response_element);

file size
agentrank.c 553.49K

.NET Client Library

Created Jul 25, 2010 6:20:37 AM for .NET 2.0.

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

This bundle contains C# source code.

file size
agentrank-dotnet.zip 5.45K

JAX-WS Client Library (Java 5+)

Created Jul 25, 2010 6:20:37 AM for Java (Version 5+).

Introduction

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/get/{username}"); JAXBContext context = JAXBContext.newInstance( GetAgent.class ); java.net.URLConnection connection = url.openConnection(); connection.connect(); Unmarshaller unmarshaller = context.createUnmarshaller(); GetAgent result = (GetAgent) 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(); GetAgent result = client.resource(baseUrl + "/agent/get/{username}") .get(GetAgent.class); //handle the result as needed...

Files

file size description
agentrank-client.jar 29.93K The binaries for the JAX-WS client library.
agentrank-client-sources.jar 24.71K The sources for the JAX-WS client library.

Objective C Client Library

Created Jul 25, 2010 6:20:34 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

#include <agentrank.h> //... AGENTRANKNS0GetAgent *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/get/{username}" 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]; AGENTRANKNS0GetAgent *responseElement = [AGENTRANKNS0GetAgent readFromXML: responseData]; [responseElement retain]; //handle the response as needed...

Files

file size description
agentrank.h 38.55K
agentrank.m 444.90K