bbc/glycerin

Name: glycerin

Owner: BBC

Description: A Java HTTP client for Nitro

Forked from: mbst/glycerin

Created: 2016-08-11 11:22:37.0

Updated: 2016-08-12 14:45:18.0

Pushed: 2016-08-12 13:41:24.0

Homepage: null

Size: 157

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

glycerin

A Java HTTP client for Nitro

Usage

1. Add a maven dependency:

   dependency>
     <groupId>com.metabroadcast.atlas.glycerin</groupId>
     <artifactId>glycerin</artifactId>
     <version>0.1.11</version>
   dependency>
   

   You'll need the MetaBroadcast repository: http://mvn.metabroadcast.com/all

2. Create a Glycerin instance:

   erin glycerin = XmlGlycerin.builder(apiKey);
   

3. Execute a query:

   erinResponse<Broadcast> broadcasts = glycerin.execute(BroadcastQuery.builder() .withDescendantsOf("b039gr8y").build());
   

Compiling

Glycerin is built with gradle. In the glycerin directory:

• gradle compileJava will generate and compile glycerin.
• gradle install will install maven artifacts into a local mvn repo.

Code is generated from:

• the XML schema via XJC. The bindings are regenerated using the generateXmlSource task from the nitro-schema.xsd.
  
• From the API description using the query generator in the src/queries/java package. The query sources are generated using the generateQueries task using api.xml. The description can be updated via the fetchApiDescription task with an API key.

Updating

When you need to update to newer versions

• The XSD schema can be found under /nitro/api/schema; fetch the new one into nitro-schema.xsd
• The api query schema can be under /nitro/api; fetch the new one into api.xml