The Java Remote Method Invocation API (RMI API) is the preferred method for accessing KIM, if you use Java or a compatible language. Having fully-featured Java at both communication ends and in between, it allows a more sophisticated and convenient API design compared to SOAP.
In order to get started:
- make sure you are familiar with the basics of RMI (no need to dive into details)
- ensure you have access to a KIM server installed somewhere on the network
- review the required network and server setup
- reference the required jars from your application
- maven users can just reference the kim-api artifact from our public repository:
- alternatively, add <KIM_HOME>/kim-api.jar and <KIM_HOME>/lib/.*jar to your classpath. If you need to add the minimal set of dependencies along kim-api.jar, download this package instead of using <KIM_HOME>/lib/.*jar.
- maven users can just reference the kim-api artifact from our public repository:
- go through the KIM Java RMI Client Examples
The KIM remote interfaces do not extend java.rmi.Remote, which is generally required by Java RMI. This is due to a convenience wrapper, which removes this and other limitations of the RMI implementation.
The KIM Web Service API (WS API) is generally a subset of the RMI API. Therefore, when developing RMI client applications, you can also use the examples in the WS API documentation. It provides more detailed descriptions of some methods and data structures.