Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• WCPaymentsPluginBean

  public WCPaymentsPluginBean()
  

Method Detail

• getAvailableBalance

  public java.math.BigDecimal getAvailableBalance(PluginContext pluginContext,
                                         PaymentInstruction paymentInstruction)
                                           throws PluginException
  

  Gets the Available Balance for the specified PaymentInstruction. Typically used for Store Value/Gift cards or Line of Credit plugins.

  WebSphere Commerce Payments Plugin does not support this API. If invoked, FunctionNotSupportedException will be thrown.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  paymentInstruction - represents the paymentInstruction for which the balance needs to be obtained

  Returns:

  the available balance.

  Throws:

  PluginException - by the spec; FunctionNotSupportedException is actually thrown everytime because this method is not supported

  See Also:

  QueryablePlugin.getAvailableBalance(PluginContext, PaymentInstruction)

• getCredit

  public Credit getCredit(PluginContext pluginContext,
                 Credit aCredit)
                   throws PluginException
  

  Refreshes the current attributes of the Credit object.

  WC Payments Plugin will issue QUERYCREDITS command to WebSphere Commerce Payments. It is used to get the information of each transaction associated with the Credit and update the Credit too.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the plug-in deployment descriptor.

  aCredit - contains all the information needed by a plugin to query the credit

  Returns:

  the updated credit object

  Throws:

  PluginException

  See Also:

  QueryablePlugin.getCredit(PluginContext, Credit)

• getMessage

  public java.lang.String getMessage(PluginContext pluginContext,
                            java.lang.String messageKey)
                              throws PluginException
  

  Gets the Translated error String associated to the particular error key.

  Parameters:

  pluginContext - which includes the target locale used by the client requesting the translated message.

  messageKey - represents the error to which the translated message needs to be obtain.

  Returns:

  the translated message

  Throws:

  PluginException

  See Also:

  Plugin.getMessage(PluginContext, String)

• getPayment

  public Payment getPayment(PluginContext pluginContext,
                   Payment payment)
                     throws PluginException
  

  Refreshes the current attributes of the Payment object.

  WC Payments Plugin will issue QUERYPAYMENTS command to WebSphere Commerce Payments, then update the payment object and the associated transactions.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  payment - contains all the information needed by a plugin to query the payment

  Returns:

  the updated payment container object

  Throws:

  PluginException

  See Also:

  QueryablePlugin.getPayment(PluginContext, Payment)

• setSessionContext

  public void setSessionContext(javax.ejb.SessionContext ctx)
  

  Sets the session context.

  Specified by:

  setSessionContext in interface javax.ejb.SessionBean

  Parameters:

  ctx - the session context to set

• getSessionContext

  public javax.ejb.SessionContext getSessionContext()
  

  Gets the session context.

  Returns:

  javax.ejb.SessionContext the session context used by current session bean

• approve

  public FinancialTransaction approve(PluginContext pluginContext,
                             FinancialTransaction approveTransaction,
                             boolean retry)
                               throws PluginException
  

  Approves an amount against a Payment Instruction. Approve is meant to reserve funds on the particular payment method/type. For example in credit cards this maps to authorization.

  WCPaymentsPlugin will use Cashier to create an order in WebSphere Commerce Payments, then issue APPROVE command against the created order.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  approveTransaction - contains the payment instruction and the amount requested to be approved

  retry - indicates this is a retry of the operation

  Returns:

  the updated transaction with some properties from backend.

  Throws:

  PluginException

  See Also:

  Plugin.approve(PluginContext, FinancialTransaction, boolean)

• approveAndDeposit

  public FinancialTransaction approveAndDeposit(PluginContext pluginContext,
                                       FinancialTransaction approveAndDepositTransaction,
                                       boolean retry)
                                         throws PluginException
  

  Deposits a payment without a prior approval. Some systems call this a "sale" transaction and others an "auth with capture" transaction.

  WCPaymentsPlugin will use Cashier to create an order in WebSphere Commerce Payments, then issue APPROVE command with the AUTODEPOSIT flag against the created order.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  approveAndDepositTransaction - contains the amount and other data required to process the action.

  retry - indicates this is a retry of the operation

  Returns:

  the updated payment transaction with the properties from backend.

  Throws:

  PluginException

  See Also:

  Plugin.approveAndDeposit(PluginContext, FinancialTransaction, boolean)

• checkPaymentInstruction

  public void checkPaymentInstruction(PluginContext pluginContext,
                             PaymentInstruction paymentInstruction)
                               throws PluginException
  

  Checks if a Payment instruction has all required parameters and is syntactically correct.

  WCPaymentsPlugin will check the currency, storeId and orderId are exist or not.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  paymentInstruction - contains the Payment Method information plus any additional data require to process the payment.

  Throws:

  PluginException

  See Also:

  Plugin.checkPaymentInstruction(PluginContext, PaymentInstruction)

• credit

  public FinancialTransaction credit(PluginContext pluginContext,
                            FinancialTransaction creditTransaction,
                            boolean retry)
                              throws PluginException
  

  Credits the requested amount. This single credit method supports both dependent and independent credits.

  WCPaymentsPlugin will issue REFUND command to WebSphere Commerce Payments. If the creditTransaction is referenced by only a Credit, it is an independent credit. WCPayments Plugin will search if there is a WebSphere Commerce Payments order created for this Credit container. If not, WC Payments Plugin will create a WebSphere Commerce Payments order first. Then issue REFUND command for this independent credit. If the creditTransactin is referenced by both a credit and a payment, it is a dependent credit. WC Payments Plugin will search for the WebSphere Commerce Payments order which is used during APPROVE command. Then issue REFUND command against that order.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  creditTransaction - contains the require information to process the credit

  retry - indicates this is a retry of the operation

  Returns:

  the updated payment transaction with the properties from the backend.

  Throws:

  PluginException

  See Also:

  Plugin.credit(PluginContext, FinancialTransaction, boolean)

• deposit

  public FinancialTransaction deposit(PluginContext pluginContext,
                             FinancialTransaction depositTransaction,
                             boolean retry)
                               throws PluginException
  

  Deposits an amount against an Approved Payment. This is typically invoked after the merchant has shipped the goods and is now entitled to receive payment.

  WCPaymentsPlugin will issue DEPOSIT command using Cashier to WebSphere Commerce Payments to deposit the amount

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  depositTransaction - contains the amount and other data required to process the action.

  retry - indicates this is a retry of the operation

  Returns:

  the updated payment transaction with the properties from the backend.

  Throws:

  PluginException

  See Also:

  Plugin.deposit(PluginContext, FinancialTransaction, boolean)

• ejbActivate

  public void ejbActivate()
  

  ejbActivate

  Specified by:

  ejbActivate in interface javax.ejb.SessionBean

• ejbCreate

  public void ejbCreate()
                 throws javax.ejb.CreateException
  

  ejbCreate

  Throws:

  javax.ejb.CreateException

• ejbPassivate

  public void ejbPassivate()
  

  ejbPassivate

  Specified by:

  ejbPassivate in interface javax.ejb.SessionBean

• ejbRemove

  public void ejbRemove()
  

  ejbRemove

  Specified by:

  ejbRemove in interface javax.ejb.SessionBean

• reverseApproval

  public FinancialTransaction reverseApproval(PluginContext pluginContext,
                                     FinancialTransaction reverseApprovalTransaction,
                                     boolean retry)
                                       throws PluginException
  

  Reverse all or partial of approved amount in a payment.

  A payment has approved amount. This plugin will let financial institution know we don't need all or partial of approved amount anymore. The amount to reverse is specified in parameter reverseApprovalTransaction.

  WC Payments Plugin will support partial approve reverse since WebSphere Commerce Payments framework supports it. If some cassettes do not support, WC Payments Plugin will throw a FunctionNotSupportedException. WC Payments Plugin will issue APPROVEREVERSAL command to WebSphere Commerce Payments.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  reverseApprovalTransaction - contains the amount and other data required to process the action.

  retry - indicates this is a retry of the operation

  Returns:

  the updated paymentTransaction

  Throws:

  PluginException

  See Also:

  Plugin.reverseApproval(PluginContext, FinancialTransaction, boolean)

• reverseCredit

  public FinancialTransaction reverseCredit(PluginContext pluginContext,
                                   FinancialTransaction reverseCreditTransaction,
                                   boolean retry)
                                     throws PluginException
  

  Cancels the specified credit.

  WCPayments Plugin will not support partial reverse since WebSphere Commerce Payments framework does not support. WCPayments Plugin will issue REFUNDREVERSAL command to WebSphere Commerce payments.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  reverseCreditTransaction - contains the amount and other data required to process the action.

  retry - indicates this is a retry of the operation

  Returns:

  the updated payment transaction with the properties from the backend.

  Throws:

  PluginException

  See Also:

  Plugin.reverseCredit(PluginContext, FinancialTransaction, boolean)

• reverseDeposit

  public FinancialTransaction reverseDeposit(PluginContext pluginContext,
                                    FinancialTransaction reverseDepositTransaction,
                                    boolean retry)
                                      throws PluginException
  

  Cancels a deposited amount against a the specified payment.

  WC Payments Plugin will not support partial reverse since WebSphere Commerce Payments framework does not support. WC Payments Plugin will issue DEPOSITREVERSAL command to WebSphere Commerce Payments to process the API.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  reverseDepositTransaction - contains the amount and other data required to process the action.

  retry - indicates this is a retry of the operation

  Returns:

  the updated payment transaction with backend response properties

  Throws:

  PluginException

  See Also:

  Plugin.reverseDeposit(PluginContext, FinancialTransaction, boolean)

• validatePaymentInstruction

  public void validatePaymentInstruction(PluginContext pluginContext,
                                PaymentInstruction paymentInstruction)
                                  throws PluginException
  

  Refreshes the current attributes of the Payment object. The plugin controller provides a fully populated Payment object. The plugin determines which attributes have changed and updates those attributes on the returned object.

  WC Payments Plugin does not support this API. It will throw FunctionNotSupportedException.

  Parameters:

  pluginContext - contains all the information needed by a plugin to process the request as obtained from the deployment descriptor.

  paymentInstruction - contains all the information needed by a plugin to query the payment

  Throws:

  PluginException - by the spec; FunctionNotSupportedException is actually thrown whenever this method is invoked.

  See Also:

  Plugin.validatePaymentInstruction(PluginContext, PaymentInstruction)

• checkHealth

  public boolean checkHealth()
  

  Check whether XML configuration for the Plugin is available. For the SimpleOffline, if the XML file is missing, or renamed, or its content is invalid, then false is returned; otherwise true is returned. And for other Plugin, always true is returned since no corresponding XML configuration file exists.

  This API is used by PluginFactory in accelerator. When false is returned, PluginFacotry will not put this plugin into the available collection. And further it will not be listed in the available payment methods in accelerator.

  Returns:

  boolean if the XML configuration for the Plugin is available