com.ibm.commerce.payment.utils
Class PMCashierFactory

java.lang.Object
  |
  +--com.ibm.commerce.payment.utils.PMCashierFactory
All Implemented Interfaces:
PMConstants

public class PMCashierFactory
extends java.lang.Object
implements PMConstants

Factory class for vending Cashier object that WebSphere Commerce uses to communicate with WebSphere Commerce Payments.


Field Summary
static java.lang.String CLASSNAME
          The name of this class.
 
Fields inherited from interface com.ibm.commerce.payment.utils. PMConstants
CFG_PMWEBSERVERPORT, CFG_SOCKSPORT, COPYRIGHT, DEFAULT_WCS_PMADMINID, DEFAULT_WEBSERVER_PORT, DEFAULT_WEBSERVER_SSL_PORT, INST_CFG_CONFILEPATH, PM_CFG_DTDPATH, PM_CFG_HOSTNAME, PM_CFG_PMADMINID, PM_CFG_PMWEBSERVERPORT, PM_CFG_PROFILEPATH, PM_CFG_SOCKSHOSTNAME, PM_CFG_SOCKSPORT, PM_CFG_USEEXTERNALPM, PM_CFG_USENONSSLPMCLNT, PM_CFG_USESOCKS
 
Constructor Summary
PMCashierFactory()
           
 
Method Summary
static java.lang.String getPMAdminId()
          Returns the Administrator ID used to create the Payment Cashier.
static Cashier getPMCashier()
          Static method to return the Cashier object that WebSphere Commerce uses to communicate with WebSphere Commerce Payments.
static void removePMCashier()
          Static method to remove the Cashier object that WebSphere Commerce currently uses to communicate with WebSphere Commerce Payments.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this class.
Constructor Detail

PMCashierFactory

public PMCashierFactory()
Method Detail

getPMAdminId

public static java.lang.String getPMAdminId()
Returns the Administrator ID used to create the Payment Cashier. The String may be null unless the Cashier has been already been created.
Returns:
the Payment administrator ID

getPMCashier

public static Cashier getPMCashier()
                            throws ECException
Static method to return the Cashier object that WebSphere Commerce uses to communicate with WebSphere Commerce Payments.
Returns:
the Payment Cashier object
Throws:
ECException - If the Cashier object cannot be returned.

removePMCashier

public static void removePMCashier()
Static method to remove the Cashier object that WebSphere Commerce currently uses to communicate with WebSphere Commerce Payments.

The next time getPMCashier() is called a new Cashier object will be initialized and returned. This method has no effect if Cashier has not been initialized.