com.ibm.commerce.payments.plugincontroller

Class PluginController

java.lang.Object

com.ibm.commerce.payments.plugincontroller.PluginController

public abstract class PluginController
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright.

Constructor Summary

Constructors

Constructor and Description
PluginController() This method is the constructor for PluginController.

Method Summary

Modifier and Type	Method and Description
void	activateMerchant(java.lang.Long merchantId) This method activates the merchant with the specific merchant id.
Result	approve(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of approve(PaymentContext, String, BigDecimal).
Result	approveAndDeposit(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of approveAndDeposit(PaymentContext, String, BigDecimal).
Result	checkPaymentInstruction(PaymentContext paymentContext, PaymentInstruction paymentInstruction) This method is the implementation of checkPaymentInstruction(PaymentContext, PaymentInstruction).
void	closePaymentInstruction(PaymentContext paymentContext, java.lang.String paymentInstruction_Id) This method is the implementation of closePaymentInstruction(PaymentContext, String).
com.ibm.commerce.payments.plugincontroller.Batch	createBatch(PaymentContext paymentContext, java.lang.String merchConfId, java.util.Collection financialTransactionIds, java.util.Map extendedData) This method creates batch for the given batch value object.
Credit	createDependentCredit(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of createDependentCredit(PaymentContext, String, BigDecimal).
Credit	createIndependentCredit(PaymentContext paymentContext, java.lang.String paymentInstruction_Id, java.math.BigDecimal amount) This method is the implementation of createIndependentCredit(PaymentContext, String, BigDecimal).
com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean	createMerchant(java.lang.String merchantName, java.lang.Long memberId) This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store.
com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean	createMerchant(java.lang.String merchantName, java.lang.Long memberId, java.lang.Boolean state) This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store.
com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean	createMerchantConf(java.lang.Long merchantId, java.lang.String paymentSystemName, java.lang.String paymentConfigurationGroup) This method creates a merchant configuration which means for a specific merchant, which payment system and payment configuration group are used.
Payment	createPayment(PaymentContext paymentContext, java.lang.String paymentInstruction_Id, java.math.BigDecimal amount) This method is the implementation of createPayment(PaymentContext, String, BigDecimal).
PaymentInstruction	createPaymentInstruction(PaymentContext paymentContext, PaymentInstruction paymentInstruction) This method is the implementation of createPaymentInstruction(PaymentContext, PaymentInstruction).
Result	credit(PaymentContext paymentContext, java.lang.String creditId, java.math.BigDecimal amount) This method is the implementation of credit(PaymentContext, String, BigDecimal).
void	deactivateMerchant(java.lang.Long merchantId) This method deactivates the merchant with the specific merchant id.
void	deleteMerchant(java.lang.Long merchantId) This method deletes the specific merchant with merchant id.
void	deleteMerchantConf(java.lang.Long merchConfId) This method deletes the merchant configuration with merchant configuration id.
void	deleteMerchantConfInfo(java.lang.Long merchConfId) This method deletes all properties for the merchant configuration.
void	deleteMerchantConfInfo(java.lang.Long merchConfId, java.util.ArrayList properties) This method deletes all properties in the array list for the merchant configuration.
void	deleteMerchantConfInfo(java.lang.Long merchConfId, java.lang.String name) This method deletes the specific property with name for the merchant configuration.
void	deletePaymentInstruction(PaymentContext paymentContext, java.lang.String paymentInstruction_Id) This method is the implementation of deletePaymentInstruction(PaymentContext, String).
void	deleteStoreMerchant(java.lang.Integer storeId) This method deletes the association between the store and the merchant.
Result	deposit(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of deposit(PaymentContext, String, BigDecimal).
Result	editCredit(PaymentContext paymentContext, Credit objCredit, java.math.BigDecimal processAmount, java.lang.String reasonCode, java.lang.String responseCode, java.lang.String referenceNumber, ExtendedData extendedData) This method is the implementation of editCredit(PaymentContext, Credit, BigDecimal, String, String, String, ExtendedData).
void	editMerchantConfInfo(java.lang.Long merchConfId, java.util.Hashtable properties) This method edits the properties for the specific merchant configuration id.
void	editMerchantConfInfo(java.lang.Long merchConfId, java.lang.String name, java.lang.String value, boolean encrypted) This method edits the property value with specific name to a new value of the merchant configuration.
Result	editPayment(PaymentContext paymentContext, Payment payment, java.math.BigDecimal processAmount, java.lang.String reasonCode, java.lang.String responseCode, java.lang.String referenceNumber, ExtendedData extendedData) This method is the implementation of editPayment(PaymentContext, Payment, BigDecimal, String, String, String, ExtendedData).
Result	editPaymentInstruction(PaymentContext paymentContext, PaymentInstruction piWithNewValues) This method is the implementation of editPaymentInstruction(PaymentContext, PaymentInstruction).
void	editStoreMerchant(java.lang.Integer storeId, java.lang.Long merchantId) This method edits the association between the store and the merchant, which updates the store to be mapped to another merchant with merchantId.
java.lang.String	getAuthenticationURL(PaymentContext paymentContext, java.lang.String paymentInstructionId) This method gets the popup URL or form of punch-out payment.
com.ibm.commerce.payments.plugincontroller.Batch	getBatch(PaymentContext paymentContext, java.lang.String batchId) This method gets the batch from the back end by calling the plugin's getBatch() API.
Credit	getCredit(PaymentContext paymentContext, java.lang.String creditId) This method is the implementation of getCredit(PaymentContext, String).
java.util.Collection	getMerchant(java.lang.String name, java.lang.Long memberId) This method is This method gets all merchants with the specific attributes.
com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean	getMerchantById(java.lang.Long merchantId) This method gets the merchant with specific merchant id.
java.util.Collection	getMerchantConf(java.lang.Long merchantId) This method gets all merchant configurations according to the input parameters.
java.util.Collection	getMerchantConf(java.lang.Long merchantId, java.lang.String paymentSystemName, java.lang.String paymentConfigurationGroup) This method gets all merchant configurations with the specific merchant id.
com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean	getMerchantConfById(java.lang.Long merchantConfId) This method gets the merchant configuration with merchant configuration id.
java.util.Collection	getMerchantConfInfo(java.lang.Long merchConfId) This method gets all merchant configuration information according to the input parameter.
java.util.Collection	getMerchantConfInfo(java.lang.Long merchConfId, java.lang.String name) This method gets all merchant configuration information according to the input parameter.
com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean	getMerchantConfInfoById(java.lang.Long merchantConfInfoId) This method gets the merchant configuration information according to the merchant configuration information id.
java.lang.String	getMessage(PaymentContext paymentContext, java.lang.String paymentSystemName, java.lang.String store, java.lang.String messageKey) This method is the implementation of getMessage(PaymentContext, String, String, String).
Payment	getPayment(PaymentContext paymentContext, java.lang.String paymentId) This method is the implementation of getPayment(PaymentContext, String).
PaymentInstruction	getPaymentInstruction(PaymentContext paymentContext, java.lang.String paymentInstruction_Id, java.lang.Boolean maskSensitiveData) This method is the implementation of getPaymentInstruction(PaymentContext, String, Boolean).
java.math.BigDecimal	getRemainingValueOnPaymentInstruction(PaymentContext paymentContext, PaymentInstruction paymentInstruction) This method is the implementation of getRemainingValueOnPaymentInstruction(PaymentContext, PaymentInstruction).
java.util.Collection	getStoreMerchantByMerchantId(java.lang.Long merchantId) This method gets all association with current merchant id.
com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean	getStoreMerchantByStoreId(java.lang.Integer storeId) This method gets the association between store and merchant with the specific store id.
void	initAuthenticationSession(PaymentContext paymentContext, java.lang.String paymentInstructionId) This method initializes punch-out payment session.
com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean	mapStoreMerchant(java.lang.Integer storeId, java.lang.Long merchantId) This method creates the association between the store and the merchant.
java.lang.String	preprocessProviderResponseData(PaymentContext paymentContext, java.lang.String paymentSystemName, java.util.Map callbackParameters) This method preprocess punch-out payment transaction data from payment service provider side.
java.util.Map	processProviderResponse(PaymentContext paymentContext, java.lang.String paymentInstructionId, java.util.Map callbackParameters) This method gets the result of punch-out payment transaction from payment service provider side.
void	putMerchantConfInfo(java.lang.Long merchConfId, java.util.Hashtable properties) This method creates the properties for the specific merchant configuration id by taking a hashtable as input.
com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean	putMerchantConfInfo(java.lang.Long merchConfId, java.lang.String name, java.lang.String value, boolean encrypted) This method creates a property for the specific merchant configuration id.
Result	reverseApproval(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of reverseApproval(PaymentContext, String, BigDecimal).
Result	reverseCredit(PaymentContext paymentContext, java.lang.String creditId, java.math.BigDecimal amount) This method is the implementation of reverseCredit(PaymentContext, String, BigDecimal).
Result	reverseDeposit(PaymentContext paymentContext, java.lang.String paymentId, java.math.BigDecimal amount) This method is the implementation of reverseDeposit(PaymentContext, String, BigDecimal).
com.ibm.commerce.payments.plugincontroller.Batch	settleBatch(PaymentContext paymentContext, java.lang.String batchId, boolean forceClose) This method is used to send batch request to the back end.
Result	validatePaymentInstruction(PaymentContext paymentContext, PaymentInstruction paymentInstruction) This method is the implementation of validatePaymentInstruction(PaymentContext, PaymentInstruction).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright.

See Also:

Constant Field Values

Constructor Detail

PluginController

public PluginController()

This method is the constructor for PluginController.

Method Detail

getMessage

public java.lang.String getMessage(PaymentContext paymentContext,
                                   java.lang.String paymentSystemName,
                                   java.lang.String store,
                                   java.lang.String messageKey)
                            throws BackendException,
                                   ConfigException,
                                   InputException,
                                   InternalException

This method is the implementation of getMessage(PaymentContext, String, String, String).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#getMessage(PaymentContext,String,String,String)

getPaymentInstruction

public PaymentInstruction getPaymentInstruction(PaymentContext paymentContext,
                                                java.lang.String paymentInstruction_Id,
                                                java.lang.Boolean maskSensitiveData)
                                         throws BackendException,
                                                InputException,
                                                ConfigException,
                                                InternalException

This method is the implementation of getPaymentInstruction(PaymentContext, String, Boolean).

Throws:

BackendException

InputException

ConfigException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#getPaymentInstruction(PaymentContext,String,Boolean)

getRemainingValueOnPaymentInstruction

public java.math.BigDecimal getRemainingValueOnPaymentInstruction(PaymentContext paymentContext,
                                                                  PaymentInstruction paymentInstruction)
                                                           throws BackendException,
                                                                  ConfigException,
                                                                  InputException,
                                                                  InternalException

This method is the implementation of getRemainingValueOnPaymentInstruction(PaymentContext, PaymentInstruction).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#getRemainingValueOnPaymentInstruction(PaymentContext,PaymentInstruction)

approve

public Result approve(PaymentContext paymentContext,
                      java.lang.String paymentId,
                      java.math.BigDecimal amount)
               throws BackendException,
                      ConfigException,
                      InputException,
                      InternalException,
                      InvalidDataException

This method is the implementation of approve(PaymentContext, String, BigDecimal).

Throws:

BackendException

ConfigException

InputException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#approve(PaymentContext,String,BigDecimal)

approveAndDeposit

public Result approveAndDeposit(PaymentContext paymentContext,
                                java.lang.String paymentId,
                                java.math.BigDecimal amount)
                         throws BackendException,
                                ConfigException,
                                InputException,
                                InternalException,
                                InvalidDataException

This method is the implementation of approveAndDeposit(PaymentContext, String, BigDecimal).

Throws:

BackendException

ConfigException

InputException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#approveAndDeposit(PaymentContext,String,BigDecimal)

checkPaymentInstruction

public Result checkPaymentInstruction(PaymentContext paymentContext,
                                      PaymentInstruction paymentInstruction)
                               throws BackendException,
                                      ConfigException,
                                      InputException,
                                      InternalException

This method is the implementation of checkPaymentInstruction(PaymentContext, PaymentInstruction).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#checkPaymentInstruction(PaymentContext,PaymentInstruction)

closePaymentInstruction

public void closePaymentInstruction(PaymentContext paymentContext,
                                    java.lang.String paymentInstruction_Id)
                             throws ConfigException,
                                    InternalException,
                                    InvalidDataException,
                                    PaymentInstructionNotFoundException

This method is the implementation of closePaymentInstruction(PaymentContext, String).

Throws:

ConfigException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#closePaymentInstruction(PaymentContext,String)

createDependentCredit

public Credit createDependentCredit(PaymentContext paymentContext,
                                    java.lang.String paymentId,
                                    java.math.BigDecimal amount)
                             throws PaymentNotFoundException,
                                    ConfigException,
                                    InvalidPaymentInstructionException,
                                    CreditNotFoundException,
                                    InternalException,
                                    InvalidDataException,
                                    PaymentInstructionNotFoundException,
                                    FinancialException

This method is the implementation of createDependentCredit(PaymentContext, String, BigDecimal).

Throws:

PaymentNotFoundException

ConfigException

InvalidPaymentInstructionException

CreditNotFoundException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

FinancialException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#createDependentCredit(PaymentContext,String,BigDecimal)

createIndependentCredit

public Credit createIndependentCredit(PaymentContext paymentContext,
                                      java.lang.String paymentInstruction_Id,
                                      java.math.BigDecimal amount)
                               throws ConfigException,
                                      CreditNotFoundException,
                                      InternalException,
                                      InvalidDataException,
                                      PaymentInstructionNotFoundException

This method is the implementation of createIndependentCredit(PaymentContext, String, BigDecimal).

Throws:

ConfigException

CreditNotFoundException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#createIndependentCredit(PaymentContext,String,BigDecimal)

createPayment

public Payment createPayment(PaymentContext paymentContext,
                             java.lang.String paymentInstruction_Id,
                             java.math.BigDecimal amount)
                      throws PaymentNotFoundException,
                             ConfigException,
                             InternalException,
                             InvalidDataException,
                             PaymentInstructionNotFoundException

This method is the implementation of createPayment(PaymentContext, String, BigDecimal).

Throws:

PaymentNotFoundException

ConfigException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#createPayment(PaymentContext,String,BigDecimal)

createPaymentInstruction

public PaymentInstruction createPaymentInstruction(PaymentContext paymentContext,
                                                   PaymentInstruction paymentInstruction)
                                            throws ConfigException,
                                                   InternalException,
                                                   InvalidDataException

This method is the implementation of createPaymentInstruction(PaymentContext, PaymentInstruction).

Throws:

ConfigException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#createPaymentInstruction(PaymentContext,PaymentInstruction)

credit

public Result credit(PaymentContext paymentContext,
                     java.lang.String creditId,
                     java.math.BigDecimal amount)
              throws BackendException,
                     PaymentNotFoundException,
                     ConfigException,
                     InputException,
                     InvalidCreditException,
                     CreditNotFoundException,
                     InternalException

This method is the implementation of credit(PaymentContext, String, BigDecimal).

Throws:

BackendException

PaymentNotFoundException

ConfigException

InputException

InvalidCreditException

CreditNotFoundException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#credit(PaymentContext,String,BigDecimal)

deletePaymentInstruction

public void deletePaymentInstruction(PaymentContext paymentContext,
                                     java.lang.String paymentInstruction_Id)
                              throws InternalException,
                                     InvalidDataException,
                                     PaymentInstructionNotFoundException

This method is the implementation of deletePaymentInstruction(PaymentContext, String).

Throws:

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#deletePaymentInstruction(PaymentContext,String)

deposit

public Result deposit(PaymentContext paymentContext,
                      java.lang.String paymentId,
                      java.math.BigDecimal amount)
               throws BackendException,
                      ConfigException,
                      InputException,
                      InternalException,
                      InvalidDataException

This method is the implementation of deposit(PaymentContext, String, BigDecimal).

Throws:

BackendException

ConfigException

InputException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#deposit(PaymentContext,String,BigDecimal)

editCredit

public Result editCredit(PaymentContext paymentContext,
                         Credit objCredit,
                         java.math.BigDecimal processAmount,
                         java.lang.String reasonCode,
                         java.lang.String responseCode,
                         java.lang.String referenceNumber,
                         ExtendedData extendedData)
                  throws PaymentNotFoundException,
                         ConfigException,
                         CreditNotFoundException,
                         InternalException,
                         InvalidDataException,
                         PaymentInstructionNotFoundException

This method is the implementation of editCredit(PaymentContext, Credit, BigDecimal, String, String, String, ExtendedData).

Throws:

PaymentNotFoundException

ConfigException

CreditNotFoundException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#editCredit(PaymentContext,Credit,BigDecimal,String,String,String,ExtendedData)

editPayment

public Result editPayment(PaymentContext paymentContext,
                          Payment payment,
                          java.math.BigDecimal processAmount,
                          java.lang.String reasonCode,
                          java.lang.String responseCode,
                          java.lang.String referenceNumber,
                          ExtendedData extendedData)
                   throws PaymentNotFoundException,
                          ConfigException,
                          CreditNotFoundException,
                          InternalException,
                          InvalidDataException,
                          PaymentInstructionNotFoundException

This method is the implementation of editPayment(PaymentContext, Payment, BigDecimal, String, String, String, ExtendedData).

Throws:

PaymentNotFoundException

ConfigException

CreditNotFoundException

InternalException

InvalidDataException

PaymentInstructionNotFoundException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#editPayment(PaymentContext,Payment,BigDecimal,String,String,String,ExtendedData)

editPaymentInstruction

public Result editPaymentInstruction(PaymentContext paymentContext,
                                     PaymentInstruction piWithNewValues)
                              throws BackendException,
                                     ConfigException,
                                     InputException,
                                     InternalException

This method is the implementation of editPaymentInstruction(PaymentContext, PaymentInstruction).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#editPaymentInstruction(PaymentContext,PaymentInstruction)

reverseApproval

public Result reverseApproval(PaymentContext paymentContext,
                              java.lang.String paymentId,
                              java.math.BigDecimal amount)
                       throws BackendException,
                              ConfigException,
                              InputException,
                              InternalException,
                              InvalidDataException

This method is the implementation of reverseApproval(PaymentContext, String, BigDecimal).

Throws:

BackendException

ConfigException

InputException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#reverseApproval(PaymentContext,String,BigDecimal)

reverseCredit

public Result reverseCredit(PaymentContext paymentContext,
                            java.lang.String creditId,
                            java.math.BigDecimal amount)
                     throws BackendException,
                            PaymentNotFoundException,
                            ConfigException,
                            InputException,
                            InternalException

This method is the implementation of reverseCredit(PaymentContext, String, BigDecimal).

Throws:

BackendException

PaymentNotFoundException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#reverseCredit(PaymentContext,String,BigDecimal)

getMerchant

public java.util.Collection getMerchant(java.lang.String name,
                                        java.lang.Long memberId)
                                 throws InvalidDataException

This method is This method gets all merchants with the specific attributes.

Parameters:

name - A String that specifies the current name.

memberId - A Long that represents the owner of the merchant.

Returns:

A Collection that contains all merchants with the specific attributes.

Throws:

InvalidDataException - This exception is thrown if the some parameters are invalid .

InternalException - This exception is thrown if EJB error occurs.

reverseDeposit

public Result reverseDeposit(PaymentContext paymentContext,
                             java.lang.String paymentId,
                             java.math.BigDecimal amount)
                      throws BackendException,
                             ConfigException,
                             InputException,
                             InternalException,
                             InvalidDataException

This method is the implementation of reverseDeposit(PaymentContext, String, BigDecimal).

Throws:

BackendException

ConfigException

InputException

InternalException

InvalidDataException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#reverseDeposit(PaymentContext,String,BigDecimal)

validatePaymentInstruction

public Result validatePaymentInstruction(PaymentContext paymentContext,
                                         PaymentInstruction paymentInstruction)
                                  throws BackendException,
                                         ConfigException,
                                         InputException,
                                         InternalException

This method is the implementation of validatePaymentInstruction(PaymentContext, PaymentInstruction).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#validatePaymentInstruction(PaymentContext,PaymentInstruction)

getCredit

public Credit getCredit(PaymentContext paymentContext,
                        java.lang.String creditId)
                 throws BackendException,
                        ConfigException,
                        InputException,
                        InternalException

This method is the implementation of getCredit(PaymentContext, String).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#getCredit(PaymentContext,String)

getPayment

public Payment getPayment(PaymentContext paymentContext,
                          java.lang.String paymentId)
                   throws BackendException,
                          ConfigException,
                          InputException,
                          InternalException

This method is the implementation of getPayment(PaymentContext, String).

Throws:

BackendException

ConfigException

InputException

InternalException

See Also:

com.ibm.commerce.payments.plugincontroller.PaymentsInterface#getPayment(PaymentContext,String)

createMerchant

public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                          java.lang.Long memberId)
                                                                                   throws InternalException,
                                                                                          InvalidDataException

This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store. Since here the state is not included in the parameter list, the merchant is created with state 1 default.

Parameters:

merchantName - A String that specifies the current merchant name.

memberId - A Long that specifies the owner of the new merchant.

Returns:

The merchant

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

createMerchant

public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean createMerchant(java.lang.String merchantName,
                                                                                          java.lang.Long memberId,
                                                                                          java.lang.Boolean state)
                                                                                   throws InternalException,
                                                                                          InvalidDataException

This method creates a merchant in WebSphere Commerce, which represents the payment perspective for a store.

Parameters:

merchantName - A String that specifies the current merchant name.

memberId - A Long that specifies the owner of the new merchant.

state - A Boolean indicating the state of the merchant.

Returns:

The merchant

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

createMerchantConf

public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean createMerchantConf(java.lang.Long merchantId,
                                                                                                  java.lang.String paymentSystemName,
                                                                                                  java.lang.String paymentConfigurationGroup)
                                                                                           throws InternalException,
                                                                                                  InvalidDataException

This method creates a merchant configuration which means for a specific merchant, which payment system and payment configuration group are used.

Parameters:

merchantId - A Long that specifies the merchant id this merchant configuration belongs to.

paymentSystemName - A String that specifies the current payment system name.

paymentConfigurationGroup - A String that specifies the current payment configuration group.

Returns:

The merchant configuration.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

mapStoreMerchant

public com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean mapStoreMerchant(java.lang.Integer storeId,
                                                                                                 java.lang.Long merchantId)
                                                                                          throws InternalException,
                                                                                                 InvalidDataException

This method creates the association between the store and the merchant.

Parameters:

storeId - An Integer that specifies the current store id.

merchantId - A Long that specifies the current merchant id.

Returns:

A StoreMerchantAccessBean that represents the store merchant.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

putMerchantConfInfo

public void putMerchantConfInfo(java.lang.Long merchConfId,
                                java.util.Hashtable properties)
                         throws ConfigException,
                                InternalException,
                                InvalidDataException

This method creates the properties for the specific merchant configuration id by taking a hashtable as input.

Parameters:

merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

properties - A Hashtable that contains the properties that will be put into the database.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

ConfigException - Configuration exception.

putMerchantConfInfo

public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean putMerchantConfInfo(java.lang.Long merchConfId,
                                                                                                       java.lang.String name,
                                                                                                       java.lang.String value,
                                                                                                       boolean encrypted)
                                                                                                throws InternalException,
                                                                                                       InvalidDataException

This method creates a property for the specific merchant configuration id. The value of this property should be encrypted configured in a single XML file. The XML file specifies which property should be encrypted according to the property name.

Parameters:

merchConfId - A Long that specifies the merchant configuration id that the merchant configuration information belongs to.

name - A String that specifies the property name.

value - A String that specifies the property value.

encrypted - A String boolean indicating if the property needs encrypt.

Returns:

The merchant configuration information

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

editStoreMerchant

public void editStoreMerchant(java.lang.Integer storeId,
                              java.lang.Long merchantId)
                       throws InternalException,
                              InvalidDataException

This method edits the association between the store and the merchant, which updates the store to be mapped to another merchant with merchantId.

Parameters:

storeId - An Integer that specifies the current store id.

merchantId - The new merchant id that will be associated with current store.

Throws:

InvalidDataException - The invalid data exception.

InternalException - The internal exception.

editMerchantConfInfo

public void editMerchantConfInfo(java.lang.Long merchConfId,
                                 java.lang.String name,
                                 java.lang.String value,
                                 boolean encrypted)
                          throws InternalException,
                                 InvalidDataException

This method edits the property value with specific name to a new value of the merchant configuration.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id the property with name belongs to.

name - A String that specifies the property name.

value - A Sting that specifies the new value of this property with name.

encrypted - A boolean that indicating if the property needs encrypt.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

editMerchantConfInfo

public void editMerchantConfInfo(java.lang.Long merchConfId,
                                 java.util.Hashtable properties)
                          throws ConfigException,
                                 InternalException,
                                 InvalidDataException

This method edits the properties for the specific merchant configuration id.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id the properties in the hashtable belongs to.

properties - A Hashtable that contains the properties to be updated with new values.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

ConfigException - Configuration exception

deleteMerchant

public void deleteMerchant(java.lang.Long merchantId)
                    throws InternalException,
                           InvalidDataException

This method deletes the specific merchant with merchant id.

Parameters:

merchantId - A Long that specifies the current merchant id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

deleteStoreMerchant

public void deleteStoreMerchant(java.lang.Integer storeId)
                         throws InternalException,
                                InvalidDataException

This method deletes the association between the store and the merchant.

Parameters:

storeId - An Integer that specifies the current store id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

deleteMerchantConf

public void deleteMerchantConf(java.lang.Long merchConfId)
                        throws InternalException,
                               InvalidDataException

This method deletes the merchant configuration with merchant configuration id.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

deleteMerchantConfInfo

public void deleteMerchantConfInfo(java.lang.Long merchConfId,
                                   java.lang.String name)
                            throws InternalException,
                                   InvalidDataException

This method deletes the specific property with name for the merchant configuration.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id the property belongs to.

name - A String that specifies the current property name.

Throws:

InvalidDataException - Invalid data exception..

InternalException - Internal exception.

deleteMerchantConfInfo

public void deleteMerchantConfInfo(java.lang.Long merchConfId)
                            throws InternalException,
                                   InvalidDataException

This method deletes all properties for the merchant configuration.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

deleteMerchantConfInfo

public void deleteMerchantConfInfo(java.lang.Long merchConfId,
                                   java.util.ArrayList properties)
                            throws InternalException,
                                   InvalidDataException

This method deletes all properties in the array list for the merchant configuration.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id the properties belong to.

properties - An ArrayList that represents the properties need to be deleted.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantById

public com.ibm.commerce.payments.plugincontroller.beans.MerchantAccessBean getMerchantById(java.lang.Long merchantId)
                                                                                    throws InternalException,
                                                                                           InvalidDataException

This method gets the merchant with specific merchant id.

Parameters:

merchantId - A Long that specifies the current merchant id.

Returns:

MerchantAccessBean The merchant access bean with merchantId.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getStoreMerchantByStoreId

public com.ibm.commerce.payments.plugincontroller.beans.StoreMerchantAccessBean getStoreMerchantByStoreId(java.lang.Integer storeId)
                                                                                                   throws InternalException,
                                                                                                          InvalidDataException

This method gets the association between store and merchant with the specific store id.

Parameters:

storeId - An Integer that specifies the current store id.

Returns:

The association between store and merchant.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getStoreMerchantByMerchantId

public java.util.Collection getStoreMerchantByMerchantId(java.lang.Long merchantId)
                                                  throws InvalidDataException

This method gets all association with current merchant id.

Parameters:

merchantId - A Long that specifies the current merchant id.

Returns:

All association with merhcantId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConfById

public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfAccessBean getMerchantConfById(java.lang.Long merchantConfId)
                                                                                            throws InternalException,
                                                                                                   InvalidDataException

This method gets the merchant configuration with merchant configuration id.

Parameters:

merchantConfId - A Long that specifies the current merchant configuration id.

Returns:

The current merchant configuration with merchant configuration id

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConf

public java.util.Collection getMerchantConf(java.lang.Long merchantId)
                                     throws InternalException,
                                            InvalidDataException

This method gets all merchant configurations according to the input parameters.

Parameters:

merchantId - A Long that specifies the current merchant id.

Returns:

ArrayList All merchant configurations with merchantId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConf

public java.util.Collection getMerchantConf(java.lang.Long merchantId,
                                            java.lang.String paymentSystemName,
                                            java.lang.String paymentConfigurationGroup)
                                     throws InternalException,
                                            InvalidDataException

This method gets all merchant configurations with the specific merchant id.

Parameters:

merchantId - A Long that specifies the current merchant id.

paymentSystemName -

paymentConfigurationGroup -

Returns:

ArrayList All merchant configurations with merchantId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConfInfoById

public com.ibm.commerce.payments.plugincontroller.beans.MerchantConfInfoAccessBean getMerchantConfInfoById(java.lang.Long merchantConfInfoId)
                                                                                                    throws InternalException,
                                                                                                           InvalidDataException

This method gets the merchant configuration information according to the merchant configuration information id.

Parameters:

merchantConfInfoId - The current merchant configuration information id

Returns:

The current merchant configuration information with merchantConfInfoId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConfInfo

public java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId)
                                         throws InternalException,
                                                InvalidDataException

This method gets all merchant configuration information according to the input parameter.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id.

Returns:

All merchant configuration information with merchantConfId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

getMerchantConfInfo

public java.util.Collection getMerchantConfInfo(java.lang.Long merchConfId,
                                                java.lang.String name)
                                         throws InternalException,
                                                InvalidDataException

This method gets all merchant configuration information according to the input parameter.

Parameters:

merchConfId - A Long that specifies the current merchant configuration id.

name - The property name

Returns:

All merchant configuration information with merchantConfId

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

activateMerchant

public void activateMerchant(java.lang.Long merchantId)
                      throws InternalException,
                             InvalidDataException

This method activates the merchant with the specific merchant id.

Parameters:

merchantId - A Long that specifies the current merchant id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

deactivateMerchant

public void deactivateMerchant(java.lang.Long merchantId)
                        throws InternalException,
                               InvalidDataException

This method deactivates the merchant with the specific merchant id.

Parameters:

merchantId - The current merchant id.

Throws:

InvalidDataException - This exception is thrown when some parameters are invalid.

InternalException - This exception is thrown when EJB error occurs.

settleBatch

public com.ibm.commerce.payments.plugincontroller.Batch settleBatch(PaymentContext paymentContext,
                                                                    java.lang.String batchId,
                                                                    boolean forceClose)
                                                             throws PaymentNotFoundException,
                                                                    ConfigException,
                                                                    InputException,
                                                                    InternalException,
                                                                    CommunicationException,
                                                                    InvalidDataException

This method is used to send batch request to the back end. It sends the batch request to the back end by calling the settleBatch API of the plugin.

Parameters:

paymentContext - the context of payment.

batchId - The batch identifier represents the batch to be processed.

forceClose - A boolean indicating if this batch is needed to be closed by force.

Returns:

The batch value object in PPC level.

Throws:

EDPException

PaymentNotFoundException

ConfigException

InputException

InternalException

CommunicationException

InvalidDataException

getBatch

public com.ibm.commerce.payments.plugincontroller.Batch getBatch(PaymentContext paymentContext,
                                                                 java.lang.String batchId)
                                                          throws PaymentNotFoundException,
                                                                 ConfigException,
                                                                 InputException,
                                                                 InternalException,
                                                                 CommunicationException

This method gets the batch from the back end by calling the plugin's getBatch() API. For Paymentech plugin ,this method sends RFR to the back end and receives the RFR response from the back end.The RFR response includes the result of the previous batch request.

Parameters:

paymentContext -

batchId - The identifier of the batch value object needs to be gotten.

Returns:

The batch value object that has been processed.

Throws:

EDPException

PaymentNotFoundException

ConfigException

InputException

InternalException

CommunicationException

createBatch

public com.ibm.commerce.payments.plugincontroller.Batch createBatch(PaymentContext paymentContext,
                                                                    java.lang.String merchConfId,
                                                                    java.util.Collection financialTransactionIds,
                                                                    java.util.Map extendedData)
                                                             throws InternalException,
                                                                    InvalidDataException

This method creates batch for the given batch value object.

Parameters:

paymentContext - the context of payment.

merchConfId - The unique identifier of merchant configuration.

financialTransactionIds - The financial transactions to be included in the new created batch.

extendedData - The extended data for the batch.

Returns:

The new created batch value object.

Throws:

EDPException

InternalException

InvalidDataException

initAuthenticationSession

public void initAuthenticationSession(PaymentContext paymentContext,
                                      java.lang.String paymentInstructionId)
                               throws ConfigException,
                                      InternalException,
                                      CommunicationException,
                                      InvalidDataException,
                                      PaymentInstructionNotFoundException

This method initializes punch-out payment session.

Parameters:

paymentContext - The plug-in context to be used in this request.

paymentInstructionId - The id of PaymentInstruction object.

Throws:

EDPException

ConfigException

InternalException

CommunicationException

InvalidDataException

PaymentInstructionNotFoundException

getAuthenticationURL

public java.lang.String getAuthenticationURL(PaymentContext paymentContext,
                                             java.lang.String paymentInstructionId)
                                      throws ConfigException,
                                             InternalException,
                                             CommunicationException,
                                             InvalidDataException,
                                             PaymentInstructionNotFoundException

This method gets the popup URL or form of punch-out payment.

Parameters:

paymentContext - The plug-in context to be used in this request.

paymentInstructionId - The id of PaymentInstruction object.

Returns:

the popup URL or form.

Throws:

EDPException

ConfigException

InternalException

CommunicationException

InvalidDataException

PaymentInstructionNotFoundException

preprocessProviderResponseData

public java.lang.String preprocessProviderResponseData(PaymentContext paymentContext,
                                                       java.lang.String paymentSystemName,
                                                       java.util.Map callbackParameters)
                                                throws ConfigException,
                                                       InternalException,
                                                       CommunicationException,
                                                       InvalidDataException

This method preprocess punch-out payment transaction data from payment service provider side.

Parameters:

paymentContext - The plug-in context to be used in this request.

paymentSystemName - The payment system name.

callbackParameters - the parameters from callback request.

Returns:

payment instruction id key.

Throws:

EDPException

ConfigException

InternalException

CommunicationException

InvalidDataException

processProviderResponse

public java.util.Map processProviderResponse(PaymentContext paymentContext,
                                             java.lang.String paymentInstructionId,
                                             java.util.Map callbackParameters)
                                      throws ConfigException,
                                             InternalException,
                                             CommunicationException,
                                             InvalidDataException,
                                             PaymentInstructionNotFoundException

This method gets the result of punch-out payment transaction from payment service provider side.

Parameters:

paymentContext - The plug-in context to be used in this request.

paymentInstructionId - The id of PaymentInstruction object.

callbackParameters - the parameters from call back request.

Returns:

the payment transaction result.

Throws:

EDPException

ConfigException

InternalException

CommunicationException

InvalidDataException

PaymentInstructionNotFoundException