com.ibm.commerce.payments.plugincontroller.plugin

Class PluginAdapter_V1

java.lang.Object

com.ibm.commerce.payments.plugincontroller.plugin.PluginAdapter

com.ibm.commerce.payments.plugincontroller.plugin.PluginAdapter_V1

All Implemented Interfaces:

java.lang.Cloneable

public class PluginAdapter_V1
extends PluginAdapter
implements java.lang.Cloneable

This class is the implementation of PluginAdapter for Plugin Specification version 1.0. In Plugin Specification version 1.0, the plugin is a stateless session bean. This class will prepare the parameters needed by the plugin. Then it will call the plugin's remote APIs, retrieve the output from the plugin, update the objects in the database. When PluginController needs the plugin to participate, it will call the PluginAdapter. And then will retrieve the output information from the database or from the fields of PluginAdapter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
PluginAdapter_V1(PluginConfigurationImpl pluginConfData) This method is the constructor of PluginAdapter_V1.

Method Summary

Modifier and Type	Method and Description
void	approve()
void	approveAndDeposit()
boolean	checkHealth() This method will check the health of the Plugins.
void	checkPaymentInstruction()
java.lang.Object	clone() This method overrides the clone() function of Object class.
void	credit()
void	deposit()
java.lang.String	getAuthenticationURL() This method sends the build popup URL of punch-out payment to plugin, then gets the URL.
java.math.BigDecimal	getAvailableBalance()
void	getBatch() This method gets the batch results from the paymentech back end.
void	getCredit()
java.lang.String	getMessage(java.lang.String messageKey, java.util.Locale locale)
java.lang.Object	getMyEjb() This method returns the EJB object for payments plug-ins.
void	getPayment()
void	init() This method initializes this Plugin Adapter.
void	initAuthenticationSession() This method sends the build popup URL of punch-out payment to plugin, then gets the URL.
boolean	isPluginLoaded() This method checks if this plugin is loaded successfully.
java.lang.String	preprocessProviderResponseData() This method executes the verification with PSP and gets the result of payment processing.
java.util.Map	processProviderResponse() This method executes the verification with PSP and gets the result of payment processing.
void	reverseApproval()
void	reverseCredit()
void	reverseDeposit()
void	settleBatch(boolean forceClose) This method sends the batch request that contains all the credit/deposit transactions need to be batched by calling the batch API of the plugins.
void	validatePaymentInstruction()

Methods inherited from class com.ibm.commerce.payments.plugincontroller.plugin.PluginAdapter

getAdditionalInformation, getCallBackRequest, getCreditData, getInitException, getKeywordConf, getKeywordsMapping, getOrderChannelId, getPayInstData, getPaymentData, getPaymentGroupId, getPaymentSentivieData, getPayTranData, getPiExtendedDataCollect, getPluginConfigurationData, getPluginData, getPluginException, getPluginPaymentInstructionProtocolPropertyConfigColl, getPPCBatchData, getRequestedAmount, getTargetLocale, getTxExtendedDataCollect, isPaymentRequiresAttention, isQueriesSupported, isRecoverable, isRetry, setAdditionalInformation, setCallBackRequest, setCreditData, setInitException, setKeywordConf, setKeywordsMapping, setOmf, setOrderChannelId, setPayInstData, setPaymentData, setPaymentGroupId, setPaymentRequiresAttention, setPaymentSentivieData, setPayTranData, setPiExtendedDataCollect, setPluginConfigurationData, setPluginData, setPluginException, setPluginPaymentInstructionProtocolPropertyConfigColl, setPPCBatchData, setQueriesSupported, setRecoverable, setRequestedAmount, setRetry, setTargetLocale, setTxExtendedDataCollect, toString

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

PluginAdapter_V1

public PluginAdapter_V1(PluginConfigurationImpl pluginConfData)

This method is the constructor of PluginAdapter_V1. It will initialize the plugin stateless session bean, and the object Module Facade which is used to update the database of Payment Plugin Controller.

Parameters:

pluginConfData - The context data of the plugin, including the configuration data and the target locale.

Method Detail

getAvailableBalance

public java.math.BigDecimal getAvailableBalance()
                                         throws InputException,
                                                BackendException,
                                                InternalException,
                                                ConfigException

Specified by:

getAvailableBalance in class PluginAdapter

Returns:

A BigDecimal that specifies the available balance.

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.getAvailableBalance()

getCredit

public void getCredit()
               throws InputException,
                      BackendException,
                      InternalException,
                      ConfigException

Specified by:

getCredit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.getCredit()

getMessage

public java.lang.String getMessage(java.lang.String messageKey,
                                   java.util.Locale locale)
                            throws InputException,
                                   BackendException,
                                   InternalException,
                                   ConfigException

Specified by:

getMessage in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.getMessage(java.lang.String, java.util.Locale)

getPayment

public void getPayment()
                throws InputException,
                       BackendException,
                       InternalException,
                       ConfigException

Specified by:

getPayment in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.getPayment()

isPluginLoaded

public boolean isPluginLoaded()

This method checks if this plugin is loaded successfully.

Specified by:

isPluginLoaded in class PluginAdapter

Returns:

The flag to indicate the plugin is loaded successfully.

approve

public void approve()
             throws InputException,
                    BackendException,
                    InternalException,
                    ConfigException

Specified by:

approve in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.approve()

approveAndDeposit

public void approveAndDeposit()
                       throws InputException,
                              BackendException,
                              InternalException,
                              ConfigException

Specified by:

approveAndDeposit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.approveAndDeposit()

checkPaymentInstruction

public void checkPaymentInstruction()
                             throws InputException,
                                    BackendException,
                                    InternalException,
                                    ConfigException

Specified by:

checkPaymentInstruction in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.checkPaymentInstruction()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

This method overrides the clone() function of Object class.

Overrides:

clone in class PluginAdapter

Returns:

The clone of this object.

Throws:

java.lang.CloneNotSupportedException - Thrown when clone is not supported.

credit

public void credit()
            throws InputException,
                   BackendException,
                   InternalException,
                   ConfigException

Specified by:

credit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.credit()

deposit

public void deposit()
             throws InputException,
                    BackendException,
                    InternalException,
                    ConfigException

Specified by:

deposit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.deposit()

init

public void init()

This method initializes this Plugin Adapter.

reverseApproval

public void reverseApproval()
                     throws InputException,
                            BackendException,
                            InternalException,
                            ConfigException

Specified by:

reverseApproval in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.reverseApproval()

reverseCredit

public void reverseCredit()
                   throws InputException,
                          BackendException,
                          InternalException,
                          ConfigException

Specified by:

reverseCredit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.reverseCredit()

reverseDeposit

public void reverseDeposit()
                    throws InputException,
                           BackendException,
                           InternalException,
                           ConfigException

Specified by:

reverseDeposit in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.reverseDeposit()

validatePaymentInstruction

public void validatePaymentInstruction()
                                throws InputException,
                                       BackendException,
                                       InternalException,
                                       ConfigException

Specified by:

validatePaymentInstruction in class PluginAdapter

Throws:

InputException

BackendException

InternalException

ConfigException

See Also:

PluginAdapter.validatePaymentInstruction()

checkHealth

public boolean checkHealth()
                    throws InternalException

This method will check the health of the Plugins.

Specified by:

checkHealth in class PluginAdapter

Returns:

A boolean that indicates the if the plugin is available.

Throws:

InternalException

See Also:

Plugin.checkHealth()

getMyEjb

public java.lang.Object getMyEjb()

This method returns the EJB object for payments plug-ins.

Returns:

Returns the EJB object for payments plug-ins.

getBatch

public void getBatch()
              throws InputException,
                     CommunicationException,
                     InternalException,
                     ConfigException

This method gets the batch results from the paymentech back end.

Specified by:

getBatch in class PluginAdapter

Throws:

InputException

CommunicationException

InternalException

ConfigException

CommunicationException

settleBatch

public void settleBatch(boolean forceClose)
                 throws InputException,
                        CommunicationException,
                        InternalException,
                        ConfigException

This method sends the batch request that contains all the credit/deposit transactions need to be batched by calling the batch API of the plugins. It also updates the payment transactions and payment instructions according to the batch result returned.

Specified by:

settleBatch in class PluginAdapter

Parameters:

forceClose - A boolean indicating if the batch should be closed by force.

Throws:

InputException

CommunicationException

InternalException

ConfigException

CommunicationException

initAuthenticationSession

public void initAuthenticationSession()
                               throws InternalException,
                                      CommunicationException

This method sends the build popup URL of punch-out payment to plugin, then gets the URL. The popup URL has been put into piExtendedDataCollect.

Specified by:

initAuthenticationSession in class PluginAdapter

Throws:

InternalException

CommunicationException

CommunicationException

getAuthenticationURL

public java.lang.String getAuthenticationURL()
                                      throws InternalException,
                                             CommunicationException

This method sends the build popup URL of punch-out payment to plugin, then gets the URL. The popup URL has been put into piExtendedDataCollect.

Specified by:

getAuthenticationURL in class PluginAdapter

Returns:

popup URL

Throws:

InternalException

CommunicationException

CommunicationException

preprocessProviderResponseData

public java.lang.String preprocessProviderResponseData()
                                                throws InternalException,
                                                       CommunicationException

This method executes the verification with PSP and gets the result of payment processing. The result of payment processing has been put into piExtendedDataCollect.

Specified by:

preprocessProviderResponseData in class PluginAdapter

Returns:

payment instruction id key.

Throws:

InternalException

CommunicationException

CommunicationException

processProviderResponse

public java.util.Map processProviderResponse()
                                      throws InternalException,
                                             CommunicationException

This method executes the verification with PSP and gets the result of payment processing. The result of payment processing has been put into piExtendedDataCollect.

Specified by:

processProviderResponse in class PluginAdapter

Returns:

the payment transaction result

Throws:

InternalException

CommunicationException

CommunicationException