Package a payment plug-in


Procedure

  1. Package the plug-in (binary code) as an EJB module (JAR file) containing the following items:

    • Required: The EJB module with EJB home, interface, and implementation: 

        plug_in_name.class
plug_in_nameBean.class
plug_in_nameHome.class

    • Required: The plug-in deployment descriptor: PluginDeployment.xml

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

    • Required: The standard EJB deployment descriptor: ejb-jar.xml

    • Required: The JAR file manifest: Manifest.MF.

    • Any required utility JAR files 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 we can produce, see the description for one of the plug-ins provided by WebSphere Commerce.


Related concepts
Payment financial transaction state
Plug-in exception handling and transaction roll-back


Related reference
Payment plug-in specification