This is the README file for the binary distribution of indivo_client_java-1.x,
which is distributed as its indivo_client_java-1.x.tar file.
Writing http code to access the Indivo REST interface directly is an alternative. We think using
the classes in indivo_client_java-1.x.jar will be easier.
For most purposes, it is recommended to use this binary distribution. If you have a need for the source from
from which this binary distribution is built:
git clone git://github.com/chb/indivo_client_java.git
[you must have git installed]
Install
cp indivo_client_java-1.x.tar <binary-installation-directory>
cd <binary-installation-directory>
tar -xf indivo_client_java-1.x.tar
Classpath
indivo_client_java-1.x.jar contains the classes a Java Indivo client application might use directly.
Add <binary-installation-directory>/indivo_client_java-1.x/indivo_client_java-1.x.jar
to the classpath of your client application.
indivo_client_java depends on some 3rd party .jar files, all included in this distribution, in the lib directory.
see NOTICES.txt for 3rd party jar license info.
Add the .jar files in <binary-installation-directory>/indivo_client_java-1.x/lib
to the classpath of your client application.
API documentation
point your browser to file:///<binary-installation-directory>/indivo_client_java-1.x/javadoc/index.html
.
The gateway to this API is the class org.indivo.client.Rest
or, identical except for method names,
org.indivo.client.Rest_py_client_style
.
Methods that stand in for Indivo API REST calls are, in Rest
, named with the REST URL modified for Java
compatability.
In Rest_py_client_style
the same methods are named as in the Indivo Python client.
file:///<binary-installation-directory>/indivo_client_java-1.x/examples/README_EXAMPLES.html
.