Generating client stubs

To create a client application that consumes the Data Ingest Web Service, you need the Web service's WSDL file to generate client stubs.

A WSDL file specifies value types, exceptions, and available methods in a Web service in a programmatic fashion. Typically, a client developer uses a tool that parses the WSDL file and generates client-side stubs (also called proxy classes) and value types. These generated files include all the code necessary to serialize and deserialize SOAP messages and make the SOAP layer transparent to the client developer. The Data Ingest WSDL files can be used with any language that has Web services support.

Tools that generate client stub code from the WSDLs that have been tested are the following:

For details on using a WSDL code-generation utility, refer to the utility's documentation.

Keep in mind that the exact syntax of a class member depends on the output of the WSDL tool that you are using. Therefore, check the client stub classes that are generated by your WSDL tool for the exact syntax of the class members.

Obtaining the WSDL from the deployed service

The Data Ingest Web Service has a unique URL associated with it. If you append ?wsdl to the service endpoint URL, and specify the name of the data store, the service will automatically generate a service description for the deployed service and return it as XML in your browser, as in this example URL:
http://localhost:5555/ws/ingest/datastore?wsdl
You can also use this URL in your WSDL tool to generate the stubs, as in this Apache Axis2 example:
wsdl2java -uri http://localhost:5555/ws/ingest/datastore?wsdl -d xmlbeans -s -p com.endeca.dataingest.axis2.addrecords

You can insert the wsdl2java command in a batch or shell script, or in a build file.