Compiling Gateway Server sample user exits

The Gateway Server sample user exits require access to JAR files to compile. The following JAR files are needed and must be placed in the class path so that they can be found when the user exit is compiled.
  • base_java_utilities.jar
  • igateway.jar
  • util.jar

The files for user exits are provided in the FTM artifacts pod and must be downloaded from the pod. For more information about getting files from the artifacts container for your offering, see Getting the files from the artifacts container for your FTM offering.

If class not found errors for the import statements of the user exit still occur when the user exit is compiled, obtain the JAR files for the import statements. Place those JAR files in the class path.

Implementation and installation

The following list shows the general steps to follow to implement and install a Gateway user exit. For more information about that user exit, see the documentation for the specific user exit.
  1. Create a Java™ class that uses the interface for the type of user exit that you want to create. For this example, the name of the new class is com.sample.MySampleUE.
  2. Implement the methods that are needed for the specific user exit that you want to create.
  3. Ensure that all of the JAR files that are needed to compile the user exit can be found on the class path.
  4. Compile the user exit to create the new JAR file for the implementation.
  5. Ensure that the JAR file for the new com.sample.MySampleUE class is placed in the appropriate folder. For more information about installing compiled user exits, see User exits for the FTM components.
  6. Most of the user exits are enabled by specifying the class name of the user exit in a property in the Gateway properties file. Update the properties file, izxconfig.properties, to add the property for your user exit and set its value to refer to the implementation class. For example, the property to use for the user insert transaction user exit is userInsertItemClass.
  7. Stop and restart the Gateway Server for the updates to take effect.

Common additional JAR files that are needed to compile user exits

Some of the Gateway Server sample user exits require more JAR files to compile. These JAR files are associated with the various other components that the user exit is intended to work with.

Some of the additional JAR files that might need to be included are shown in the following list.
pdapi.jar
Common Services components (com.ibm.paydir.api.*)
cqaapi.jar
Image Compliance or IQA (com.ibm.icpcs.iqa.*)
snow.jar
The Snowbound product (Snow.*)