Packaging a payment plug-in

To package a payment plug-in:

1. Package the plug-in executables (binary code) as a normal EJB module (JAR file) containing the following items:
   • The EJB module with EJB home, interface, and implementation (required):

     plug_in_name.class
     plug_in_nameBean.class
     plug_in_nameHome.class
     

   • The plug-in deployment descriptor (required):

     PluginDeployment.xml
     

     The name of the XML file representing the plug-in deployment descriptor should always be "PluginDeployment."

   • The standard EJB deployment descriptor (required):

     ejb-jar.xml
     

   • The JAR file manifest (required):

     Manifest.MF
     

   • Any required utility JAR files that are used by the EJB module. If your plug-in JAR file uses other JAR files in the library ensure the manifest file includes the appropriate files.
2. Prepare the documentation for the plug-in. A plug-in implementation should be accompanied by documentation describing how to deploy, set up, and use the plug-in. This documentation should cover how to configure any plug-in-specific properties in the deployment descriptor, any required EJB user roles and permissions, and any dependency in third-party libraries. It should also cover the set of name-value pairs expected by the plug-in to process financial transactions. For example, if particular name value pairs are required by a plug-in when validating billing addresses, these name value pairs should be documented.

   For an example of the type of documentation you can produce, see the description for one of the plug-ins provided by WebSphere Commerce.

Related concepts

• Payment plug-ins

Related tasks

• Install a payment plug-in
• Configure a payment plug-in

(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.