Java API

The Java™ API provides a Java interface with a set of utility classes and methods that you can use to write Java code. The code can access IBM® InfoSphere® Master Data Management Collaboration Server - Collaborative Edition entities directly, without the need for custom scripts. You use the Java application programming interface (API) to interact with InfoSphere Master Data Management Collaboration Server - Collaborative Edition.

Developing applications for InfoSphere Master Data Management Collaboration Server - Collaborative Edition by using Java code has these benefits:
  • You can write object-oriented code, which allows good design practices, greater code encapsulation, and reuse.
  • You can use existing Java IDEs (integrated development environments) such as Rational® Software Architect.
  • Debugging the user code becomes much easier.
  • You can call and use any third-party Java code (.jar) within your code easily.
  • You can use existing Java skills.
  • You can use existing Java utilities, and applications can be called directly in your Java code.
  • You can reference the worldwide Java development community to find coding help.
The Java API has three parts:
The Java API interface (used for development)
The Java API interface is a set of Java interfaces that document all the classes and methods that are available to you. This API is shipped as a .jar file called ccd_javaapi.jar (for Version 5.3.2) and ccd_javaapi2.jar (for Version 6.0.0 and above) in the javaapi folder in the InfoSphere Master Data Management Collaboration Server - Collaborative Edition installation directory. Import the ccd_javaapi2.jar file into your Java development environment to allow Java API classes to be developed in isolation from a InfoSphere Master Data Management Collaboration Server - Collaborative Edition server.
The Java API implementation (used at run time)
The Java API implementation refers to the InfoSphere Master Data Management Collaboration Server - Collaborative Edition internal code that provides the function that is documented in the Java API interface. This implementation is automatically included with all InfoSphere Master Data Management Collaboration Server - Collaborative Edition server instances at or above version 5.3. No action is required to enable this implementation. A Java class that use the Java API interface to automatically use this internal code when deployed.
The Java API reference documentation
Explanations are provided for some common classes and methods that are available in the Java API interface. For a complete technical reference with detailed explanations of the classes and methods that are available in your InfoSphere Master Data Management Collaboration Server - Collaborative Edition server instance, see the InfoSphere Master Data Management Collaboration Server - Collaborative Edition Javadoc. This document is generated from the InfoSphere Master Data Management Collaboration Server - Collaborative Edition code. It is shipped as a compressed file called ccd_javaapidoc.zip (for Version 5.3.2) and ccd_javaapi2doc.zip (for Version 6.0.0 and above) in the javaapi folder in the InfoSphere Master Data Management Collaboration Server - Collaborative Edition server installation directory. To read the documentation, extract this file to a directory, and open the index.html file from that directory in a web browser. You can also access the Javadoc from the product documentation.