Re-use your own existing Java code in a Java Service in webMethods Integration Server

Modularization is an important concept of programming. So, when I wanted to create a Java Service in webMethods’ Integration Server today, I wanted to re-use my existing Java code that already provided the feature I wanted to publish as a Service. However, this is not as easy as it sounds 😉 Here are the steps you need to perform to get your already existing Java code working in a Java Service:

1. Compile and bundle your external Java project into a JAR file, e.g. using Apache Ant.
2. Copy this JAR file into the subfolder code\jars\ of your package on Integration Server and reload the package. Example path: [...]\SoftwareAG\IntegrationServer\packages\YOURPACKAGE\code\jars\. Now, IS is able to use the JAR and automatically puts it into the package’s CLASSPATH.
3. Copy the JAR file into the subfolder lib\ of your local Java project (in your local Eclipse workspace) and add it to the Eclipse project’s CLASSPATH, e.g. by adding <classpathentry kind="lib" path="lib/MyExternalProject.jar"/> to .classpath. Now, Software AG Designer (i.e. Eclipse) is able to resolve the external classes and can compile the code correctly, provide code completion etc.

4. import the needed packages from your external project and use the classes in your code. Here’s some example code from the resulting Java Service:

   package XML.Services;
   
   import com.wm...; // all webMethods imports
   import it.macke.tools.saxxmlvalidator.SaxXmlValidator; // import from your external project
   
   public final class ValidateXML_SVC
   {
     /** 
      * The primary method for the Java service
      *
      * @param pipeline
      *            The IData pipeline
      * @throws ServiceException
      */
     public static final void ValidateXML(IData pipeline) throws ServiceException
     {
       xml = ISPipelineHelper.getInputParameter(pipeline, "xmlStream");
       schema = ISPipelineHelper.getInputParameter(pipeline, "schemaStream");
       validateXML();
     }
   
     // --- <<IS-BEGIN-SHARED-SOURCE-AREA>> ---  
   
     private static InputStream xml;
     private static InputStream schema;
     private static boolean isValid;
     private static String validationError;
   
     private static void validateXML() throws ServiceException 
     {
       isValid = true;
       validationError = "";
   
       // now you can use your own classes
       SaxXmlValidator validator = new SaxXmlValidator(xml, schema);
       try 
       {
         validator.validate();
       }
       catch (XmlNotValidException e) 
       {
         isValid = false;
         validationError = e.getMessage();
       }
       catch (Exception e)
       {
         throw new ServiceException(e);
       }
     }
   
     // --- <<IS-END-SHARED-SOURCE-AREA>> ---
   }