Sonatype Nexus Capabilities Plugin API

Introduction

The following items are available for download:

C Client Library

Created Jul 14, 2011 8:30: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 <nexus-capabilities-plugin.c> //... xmlTextWriterPtr writer = ...; //set up the writer to the url. nexus_capabilities_plugin_ns0_capabilityRequestResource *request_element = ...; xmlTextReaderPtr reader = ...; //set up the reader to the url. nexus_capabilities_plugin_ns0_capabilityStatusResponseResource *response_element = ...; //set up the nexus_capabilities_plugin_ns0_capabilityRequestResource... xml_write_nexus_capabilities_plugin_ns0_capabilityRequestResource(writer, request_element); response_element = xml_read_nexus_capabilities_plugin_ns0_capabilityStatusResponseResource(reader); //handle the response as needed... //free the nexus_capabilities_plugin_ns0_capabilityRequestResource free_nexus_capabilities_plugin_ns0_capabilityRequestResource(request_element); //free the nexus_capabilities_plugin_ns0_capabilityStatusResponseResource free_nexus_capabilities_plugin_ns0_capabilityStatusResponseResource(response_element);

file size
nexus-capabilities-plugin.c 209.28K

.NET Client Library

Created Jul 14, 2011 8:30:42 PM 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( CapabilityStatusResponseResource ) ); //Create the request object WebRequest req = WebRequest.Create(uri); WebResponse resp = req.GetResponse(); Stream stream = resp.GetResponseStream(); TextReader r = new StreamReader( stream ); CapabilityStatusResponseResource order = (CapabilityStatusResponseResource) s.Deserialize( r ); //handle the result as needed...

This bundle contains C# source code.

file size
nexus-capabilities-plugin-dotnet.zip 1.80K

JAX-WS Client Library (Java 5+)

Created Jul 14, 2011 8:30:43 PM 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 + "/capabilities/{capabilityId}"); JAXBContext context = JAXBContext.newInstance( CapabilityStatusResponseResource.class, CapabilityRequestResource.class ); java.net.URLConnection connection = url.openConnection(); connection.setDoOutput(true); connection.connect(); Unmarshaller unmarshaller = context.createUnmarshaller(); Marshaller marshaller = context.createMarshaller(); marshaller.marshal(capabilityRequestResource, connection.getOutputStream()); CapabilityStatusResponseResource result = (CapabilityStatusResponseResource) 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(); CapabilityStatusResponseResource result = client.resource(baseUrl + "/capabilities/{capabilityId}") .entity(capabilityRequestResource) .put(CapabilityStatusResponseResource.class); //handle the result as needed...

Files

file size description
nexus-capabilities-plugin-client.jar 11.56K The binaries for the JAX-WS client library.
nexus-capabilities-plugin-client-sources.jar 7.92K The sources for the JAX-WS client library.

Objective C Client Library

Created Jul 14, 2011 8:30:42 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

#include <nexus-capabilities-plugin.h> //... NEXUS_CAPABILITIES_PLUGINNS0CapabilityRequestResource *requestElement = [[NEXUS_CAPABILITIES_PLUGINNS0CapabilityRequestResource alloc] init]; NSData *requestData; //data holding the XML for the request. NEXUS_CAPABILITIES_PLUGINNS0CapabilityStatusResponseResource *responseElement; NSData *responseData; //data holding the XML from the response. NSURL *baseURL = ...; //the base url including the host and subpath. NSURL *url = [NSURL URLWithString: @"/capabilities/{capabilityId}" 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 NEXUS_CAPABILITIES_PLUGINNS0CapabilityRequestResource... 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]; NEXUS_CAPABILITIES_PLUGINNS0CapabilityStatusResponseResource *responseElement = [NEXUS_CAPABILITIES_PLUGINNS0CapabilityStatusResponseResource readFromXML: responseData]; [responseElement retain]; //handle the response as needed...

Files

file size description
nexus-capabilities-plugin.h 13.94K
nexus-capabilities-plugin.m 158.41K