The IAS APIs

The Integrator Acquisition System includes the following APIs:

IAS Server API — A WSDL-based API that controls crawling operations against a variety of file systems, delimited files, JDBC databases, and custom data sources.
Component Instance Manager API — A WSDL-based API that creates, lists, and deletes Record Store instances.
Record Store API — A WSDL-based API that modifies and controls a variety of reading, writing, and utility operations against Record Store instances.
IAS Extension API — A Java-based API to build extensions to the Integrator Acquisition System such as data sources and manipulators. This API is for plugin developers and it is documented in the Integrator Acquisition System Extension API Guide.

The rest of this guide documents the WSDL-based APIs. Each WSDL-based API in the Integrator Acquisition System can be used with any programming language that has Web services support, and developers can write crawl functions in their preferred language (Java, .NET, etc.) as a Web service.

Name and location of the WSDL files

You can find the following WSDL files in <install path>\IAS\<version>\doc\wsdl :

IAS Server API — IasCrawlerService.wsdl.
Component Instance Manager API — ComponentInstanceManager.wsdl.
Record Store API — RecordStore.wsdl.

Java convenience classes

For convenience, Java versions of each API are included in <install path>\IAS\<version>\lib :

IAS Server API — ias-api\eidi-api-3.2.0.jar.
Component Instance Manager API — component-manager-api\component-manager-api-3.2.0.jar.
Record Store API — recordstore-api\recordstore-api-3.2.0.jar.

Each API also includes utility (helper) classes in its JAR file.

If desired, you can use the Java version of the API rather than generate client stubs from the WSDL files. The Java versions were generated using Apache CXF. For other languages (such as .NET), you must generate the client stubs in your programming language.

Java examples in the guide

Examples in this guide use the Java versions of the APIs mentioned above. This convention has an important implication in the code examples:

Most types of identifiers are set in the constructor rather than in a setter method. For example:

 ModuleId moduleId = new ModuleId("File System");

If you are generating client stubs, most types of identifiers are set using a setter method. For example:

 ModuleId moduleId = new ModuleId();
 moduleId.setId("File System");

The specific setter usage depends on the application you use to generate client stubs. For example, setter usage varies in stubs generate with Apache Axis and Apache CXF.

Reference documentation (Javadoc) for the IAS APIs

The Javadoc provides reference documentation for both the core and utility classes. You can find the Javadoc in <install path>\IAS\<version>\doc:

IAS Server API Reference — ias-server-javadoc
Component Instance Manager API Reference — component-manager-javadoc
Record Store API Reference — recordstore-javadoc