The Vantiq Java SDK is a Java library that provides an API into a Vantiq system for Android and standalone Java applications. The SDK connects to a Vantiq system using the Vantiq REST API.
The SDK is published through the Maven Central repository. To include this into your project, you can add the dependency.
In Gradle,
repositories {
mavenCentral()
}
dependencies {
compile 'io.vantiq:vantiq-sdk:1.2.1'
}
In Maven,
<dependencies>
<dependency>
<groupId>io.vantiq</groupId>
<artifactId>vantiq-sdk</artifactId>
<version>1.2.1</version>
<scope>compile</scope>
</dependency>
</dependencies>
The Vantiq SDK for Java requires Java 8 or later.
You will need valid credentials on a Vantiq server in the form of a username and password. If you have a private Vantiq server, contact your administrator for credentials. If you wish to use the Vantiq public cloud, contact support@vantiq.com.
The first step is to create an instance of the Vantiq SDK providing the URL of the Vantiq server to connect:
String server = "https://dev.vantiq.com";
Vantiq vantiq = new io.vantiq.client.Vantiq(server);where server is the full URL for the Vantiq server to connect to, such as https://dev.vantiq.com/. An optional second argument is the version of the API to connect to. If not specified, this defaults to the latest version, currently 1. At this point, the Vantiq instance has not yet connected to the server. To establish a connection to the server, use the authenticate method, e.g.,
String username = "joe@user";
String password = "my-secr3t-passw0rd!#!"
vantiq.authenticate(username, password, handler);The username and password are the same credentials used to log into the system. Note the username and password are not stored either in-memory or persistently after this authentication call. After successfully authenticating with the system, the Vantiq instance stores in-memory an access token that subsequent API calls will use.
The handler is an instance of io.vantiq.ResponseHandler that needs to be implemented by the caller and defines methods, such as onSuccess and onError that are called during the method processing. BaseResponseHandler provides an implementation of ResponseHandler that should be overridden to provide desired behavior.
Now, you are able to perform any SDK calls to the Vantiq server. There are both synchronous and asynchronous forms of all the methods in the API. For example, the following uses the asynchronous select to print out the list of types that have been defined:
vantiq.select(Vantiq.SystemResources.TYPES.value(),
null,
null,
null,
new BaseResponseHandler() {
@Override
public void onSuccess(Object body, Response response) {
super.onSuccess(body, response);
for(JsonObject obj : (List<JsonObject>) body) {
System.out.println(obj);
}
}
}
);The following is the equivalent using the synchronous version:
VantiqResponse response = vantiq.select(Vantiq.SystemResources.TYPES.value(), null, null, null);
if(response.isSuccess()) {
for(JsonObject obj : (List<JsonObject>) response.getBody()) {
System.out.println(obj);
}
}For the full documentation on the SDK, see the SDK API Reference.
Example projects can be found under the examples directory.
The unit tests are mocked so they can be executed without a Vantiq server and account. The integration tests require a Vantiq account with the artifacts under src/resources/intgTest loaded. These can be loaded using the Vantiq CLI using the import command, e.g.,
% cd src/test/resources/intgTest
% vantiq -s <profile> import -d .
To execute the integration tests, the following Java properties must be set:
- server: The URL for the Vantiq server (e.g.
https://dev.vantiq.com) - username: The username on the Vantiq server
- password: The password on the Vantiq server
Copyright © 2020 Vantiq, Inc. Code released under the MIT license.