This topic explains the basic procedure for using Parasoft’s Extension Framework to extend extending Parasoft’s built-in transports and message formats.

...

Adding an Extension

Parasoft’s Extension Framework is standardized across all extension types. Once you understand the basic process, you can apply it Use the following process to add support for all of the various message formats and transports your team is working with. All extension work is done using Java.

1. Add [install dir]/plugins/com.parasoft.xtest.libs.web_[version]/root/com.parasoft.api.jar to your Java project classpath. You can also create a new project by going toFile> New> SOAtest>Custom Development> SOAtest  Java Project orFile> New>Virtualize> Custom Development> Virtualize Java Project; this will create a new Java project that already has that the .jar file added to the classpath.its classpath: 
   1. Choose File> New> Project

   2. Choose SOAtest or Virtualize> Custom Development> SOAtest or VirtualizeJava Project
      

      Info
      icon false title Building with Maven?
      If you’re building your Java project with Apache Maven, you can add the following to your project's pom.xml: Code Block <project> ... <dependencies> <dependency> <groupId>com.parasoft.soavirt</groupId> <artifactId>com.parasoft.api</artifactId> <version>9.9.0</version> <!-- should match product version --> <scope>provided</scope> </dependency> </dependencies> ... <repositories> <repository> <id>ParasoftMavenPublic</id> <name>Parasoft Public Repository</name> <url>http://build.parasoft.com/maven/</url> </repository> </repositories> ... </project>

2. Implement the appropriate interfaces. See the following sections for details on implementing the appropriate interfaces:

1. 1. Interfaces to Implement for Custom Transports

      Interfaces to Implement for Custom Message Formats in SOAtest

      Interfaces to Implement for Custom Tools in SOAtest

      Interfaces to Implement for Custom Listeners in Virtualize

      Interfaces to Implement for Custom Message Formats in Virtualize

      Interfaces to Implement for Custom Tools in Virtualize

      
      

2. Create a parasoft-extension.xml file in the default package of your Java project and configure it as appropriate for the item (or items) you’re adding.

1. 1. One parasoft-extension.xml file is expected for each Java project.

   2. If you want to add multiple extensions at once, you create one parasoft-extension.xml file that covers all of the extensions you’re adding—and you use the top-level <extensions>element; see Adding Multiple Extensions at Once for details. Parasoft looks for parasoft-extension.xml files in its classpath under the default package, so each of your parasoft-extension.xml files need to be included on the classpath—by putting the directories each live in (or the jar files each are contained in) on the classpath in the System Properties preferences.

      For details on how to configure this file for a specific type of extension in Virtualize, see:

      Defining parasoft-extension.xml for a Custom Message Format

      Defining parasoft-extension.xml for a Custom Listener

      Defining parasoft-extension.xml for a Custom Tool

      For details on how to configure this file for a specific type of extension in Virtualize, see:

      Defining parasoft-extension.xml for a Custom Transport

      Defining parasoft-extension.xml for a Custom Message Format

      Defining parasoft-extension.xml for a Custom Tool

2. Build your Java project and add it to your system properties classpath area—either as a jar file, a Java project within your SOAtest or Virtualize workspace, or a class folder.

3. Restart SOAtest/Virtualize and verify that the extension appears in the appropriate area. 

   For details, see the following Virtualize sections for details:

   Verifying the New Listener

   Verifying the New Message Format

   
   

   For details, see the following Virtualize sections for details:

   Verifying the New Transport

   Verifying the New Message Format

...

• Custom extensions can depend on Java libraries other than com.parasoft.api.jar. For details in SOAtest, see Configuring External Dependencies_soa.For details in Virtualize, see Configuring External Dependencies 1.

• You can externalize any string displayed in the GUI to support different languages.  For details in SOAtest, see Localizing GUI Text_soa.For details in Virtualize, see Localizing GUI Text 1.
  If you are using an existing extension and later create a new version of that extension that has a different set of GUI options, you can use a version updater to update your saved .tst (SOAtest) or .pva, .pvn (Virtualize) files to adapt them to the new set of options. For details on updating SOAtest artifacts, see Updating GUI Fields for a New Version 1.For details on updating Virtualize artifacts, see Updating GUI Fields for a New Version Virt..