PluginDeployment.xml

This example shows the contents of the XML file that constitutes the plug-in deployment descriptor for theWCPayments plug-in. This example also shows the inclusion of additional plug-in properties specific to theWCPayments plug-in.

Figure 1: Example of deployment descriptor

<?xml version="1.0" encoding="UTF-8"?>
<Plugin xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:noNamespaceSchemaLocation="../PaymentPlugin.xsd">
  <PluginInformation 
        jndi="ejb/com/ibm/commerce/payments/plugin/WCPayments /bean/WCPaymentsPluginHome" 
        home="com.ibm.commerce.payments.plugin.WCPayments .bean.WCPaymentsPluginHome"
                name="WCPaymentsPlugin" 
                version="1.0.0" 
                vendor="IBM"
                independentCredit="true" 
                virtualTerminal="http://black.cn.ibm.com:5432/webapp/PaymentManager">
        <PluginProperty name="hostName" value="black.cn.ibm.com"/>
        <PluginProperty name="port" value="5433"/>
        <PluginProperty name="useSSL" value="true"/>        
        <PluginProperty name="userid" value="wcsadmin"/>
        <PluginProperty name="maxWCOrderCreationRetries" value="5"/>
    </PluginInformation>
</Plugin>
jndi
The Java Naming and Directory Interface (JNDI) lookup name for the home of the plug-in's stateless session bean.
home
The fully qualified name of the home class for the plug-in's stateless session bean
name
The name of the plug-in implementation.
version
The version of the plug-in implementation.
vendor
The vendor providing the plug-in implementation.
independentCredit
Indication of whether the plug-in supports independent credits.
virtualTerminal
The URL of the payment back-end system administration user interface.
PluginProperty
(Optional) The name of a property to be used with this plug-in and its value.
ProtocolProperty
(Optional) The name of the keyword that should be retained in the database. Protocol properties are specified inside a <ProtocolProperties> element (more than one can be specified). Include the optional attribute keep="true" to retain the data for this keyword in the database. For example: 

<ProtocolProperties>
<ProtocolProperty name="cc_brand" keep="true" />
</ProtocolProperties>

In this example, the brand of credit card used by the customer is kept in the database. If keep="false" is specified, no data is retained for that property. If no keep attribute is specified, the default is keep="true". When a retention is specified here, it takes priority over any global retention specified in the PaymentSystemPluginMapping XML file.