Databox Java SDK

The Java SDK for interacting with the Databox Push API.

Features

• Built on top of a solid and extensively tested framework Apache HttpComponents
• Uses Java library to convert JSON to Java objects and vice-versa google-gson
• Tested and well-documented

Requirements

• Java >= 1.5 or later,
• Maven >= 3.0.3 (optional but highly recomended)

Maven supported

Add a maven repository to your pom file:

<repository>
	<id>umajeric-public-repo</id>
	<name>Umajeric Releases</name>
	<releases>
		<enabled>true</enabled>
	</releases>
	<snapshots>
		<enabled>false</enabled>
	</snapshots>
	<url>https://raw.github.com/umajeric/maven-public-repo/releases</url>
</repository>

Then add a dependency for Databox Custom DataSource artefact (see here to find the latest version):

<dependency>
	<groupId>com.databox</groupId>
	<artifactId>custom-datasource-sdk</artifactId>
	<version>LATEST</version>
</dependency>

Basic usage of the Databox's custom-datasource-sdk client

Most basic sample:

	DataSink<DataboxCustomConnection> sink = new DataboxSink();
	
	String pushToken = "hd32o1ga8sf7sad0fu9sdufs8440442kj2";
	String pushUrl = "3m2k3u2o3i4hujlb";

	DataboxCustomConnection connection = new DataboxCustomConnection(pushToken, pushUrl);

	DefaultDataProvider dataProvider = new DefaultDataProvider();
	dataProvider.addKPI(new KPI.Builder().setKey("new_signups").setValue(234D).build());
	dataProvider.addKPI(new KPI.Builder().setKey("new_signups").setValue(234D).build());
	connection.addDataProvider(dataProvider);
	
	sink.push(connection);

One more advanced example (XSLDailyDataProvider implements DataProvider interface) that reads data from Excel file:

	DataboxSink sink = new DataboxSink();
	List<DataboxCustomConnection> connections = new ArrayList<DataboxCustomConnection>();
	
	String pushToken = "hd32o1ga8sf7sad0fu9sdufs8440442kj2";
	String pushUrl = "3m2k3u2o3i4hujlb";
	
	DataboxCustomConnection connection = new DataboxCustomConnection(pushToken, pushUrl);
	XSLDailyDataProvider xlsxDataProvider = new XSLDailyDataProvider("cycling.xlsx");
	connection.addDataProvider(xlsxDataProvider);
	/* You can implement your own data provider that implements DataProvider interface */
	// connection.addDataProvider(new MyCustomDataProviderImpl());
	connections.add(connection);

	/* For each custom connection in api.databox.com we add a separate connection to the sink (each uses a different API Key and URL postfix) */
	// connection = new DataboxCustomConnection("5r4w91ga8sf7sad0fu9sdufs844044", "923noien28dnkj23");
	/* We can use the same data provider for different connections */
	// connection.addDataProvider(xlsxDataProvider);
	// connections.add(connection);

	for (DataboxCustomConnection connection : connections) {
		sink.push(connection);
	}

Snippet from excel file:

Date	Total Time	Moving Time	Distance	Distance Unit	Average Speed	Max Speed	Speed Unit
7/6/13	56	56	27.00	km	28.93	34.00	km/h
7/7/13	34	34	13	km	22.94	30	km/h
7/8/13	56	56	23	km	24.54	38	km/h
7/9/13	63	63	28	km	26.67	35	km/h
7/10/13	22	22	9	km	24.55	35	km/h

More examples can be found here Example project

Documentation

See wiki page for additional documentation.

License

Databox custom-datasource-sdk is licensed under the Apache License, Version 2.0 - see the LICENSE file for details

Credits

Contributors

• Uros Majeric