Permalink: www.outsystems.com/goto/web-service-java-extension

Edit: this post refers to an outdated approach at importing web references. The method detailed by Leonardo Fernandes below is prefered.
You can still try this method if the preferred one is not desirable for any particular reason.

--------------------------------------

This posts explains how to consume an external WSDL using a Java extension. This technique is usually needed when trying to use unsupported WSDLs.

Steps

1. Get the necessary files
2. Create/Edit the extension
3. Change the build.xml file of the extension
4. Generating the stubs
5. Use the generated stub

Step 1 - Get the necessary files

In order to consume a web service in an extension we'll need some libraries. These are:

• activation.jar
• getopt.jar
• javassist.jar
• jaxb-api.jar
• jaxb-impl.jar
• jaxb-xjc.jar
• jaxws-rt.jar
• jaxws-tools.jar
• jboss-xml-binding.jar
• jbossall-client.jar
• jbossws-common.jar
• jbossws-framework.jar
• jbossws-native-client.jar
• jbossws-native-core.jar
• jbossws-native-jaxrpc.jar
• jbossws-native-jaxws-ext.jar
• jbossws-native-jaxws.jar
• jbossws-native-saaj.jar
• jbossws-spi.jar
• log4j.jar
• mail.jar
• stax-api.jar
• stax-ex.jar
• streambuffer.jar
• wstx.jar

These files can be located inside the jboss. They can be found inside the client folder.

Step 2 - Create/Edit the extension

• First open Integration Studio, then create a new extension or open an existing one if you want to change it.
• Make sure the Application Server is J2EE or Both
• Add the necessary actions that will be exposed to the Service Studio
• Click Edit Source Code J2EE in the Integration Studio Toolbar
• Right-click the J2EE folder in the left tree, select properties, and in the tab Libraries tab, click Add External JARs to add each of the above jar files.

Step 3 - Change the build.xml file of the extension

We need to change the build.xml file to add the libraries to the classpath, so the extension can be correctly compiled. In addition will add a new target to the build.xml file so we can easily generate the stubs that will call the web service.

• Open the build.xml file in the Eclipse (use the left tree).
• Add the following property "<property name="javaHome" location="xx"/> ", where xx is the folder where java is instaled.
• Add the following property "<property name="wsConsumeLocation" location="xx"/>", where xx is the folder where the jar files reside.
• In the section <path id="classpath"> add the following (this will add the necessary jar files to the classpath):

<fileset dir="${wsConsumeLocation}">

  <include name="*.jar" />

</fileset>

<fileset file="${javaHome}\lib\tools.jar" />

• Next add the following target to the end of the file (after the target all). Change xx to the location of the wsdl file (can be an URL).

<target name="wsdl2java">

  <taskdef name="wsconsume" classname="org.jboss.wsf.spi.tools.ant.WSConsumeTask">

    <classpath>

      <path refid="classpath" />

    </classpath>

  </taskdef>

  <mkdir dir="${build}" />

  <wsconsume fork="true" verbose="true" destdir="${build}" sourcedestdir="${src}" keep="true" wsdl="xx" />

</target>

Step 4 - Generate the stubs

• With the build.xml file open, in the right tree (Outline), right click the wsdl2java target, select Run As and them Ant Build. The stubs will be generated.

Step 5 - Use the generated stubs

• To use the generated stubs, simply create an instance of the class xxSoap, where xx is the name of the webservice. For example:

  xxSoap stub = new xx().getxxSoap();

• Now simply invoke the desired actions of the variable stub, corresponding to the desired web methods.