Connecting to the API using Java and Axis2

Prerequisites

In order to use the configuration in this document, you must use the following tools:

• Axis2 Libraries
• Rampart Module (use as authentication module)
• Ant build files to generate stubs and compile code

Why Connect to the Web Service API using Java and Axis2

You can use the connection to the web service API to test your calls and perform various tasks, such as sending email and retrieving tracking information.

How To Connect to the Web Service API using Java and Axis2

Download Apache Axis2 at http://ws.apache.org/axis2 and follow the appropriate instructions at that site to install the service on your computer. You can use the sample code below to authenticate your installation and exchange information with the web service API servers.

Keep these steps in mind when connecting to the API via Axis2:

• When generating Axis2 stubs, use XML-Beans as the databinding option.
  

  

• Generated files will create resources folder with .class and .xsb files, these files should be in class-path to successfully run and execute API calls.
  

  

• Define the Rampart module in the Axis2 client config file.
• Define the properties file in class-path and store key to refer config files. Reference the props.xml file.
• Change the paths and values in props.xml before compiling, building, and running jar file.

Review the Axis2 .ZIP file attached at the bottom of this page for a sample configuration.

In that .ZIP file, the ETClient.java file sample file has both a Retrieve and a Create method. Use the PropertiesUtil.java file to read properties from the props.xml file located in class-path. Use the PWCBHandler.java file to define the password handler class; this file is required by Axis2 engine to handle authentication. Conduct the build using the Ant file and it will generate the ETClient.jar file. The command Java -jar ETClient.jar executes the ETClient.java file.