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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The IBM copyright notice field.
|
Constructor and Description |
---|
PluginAdapter_V1(PluginConfigurationImpl pluginConfData)
This method is the constructor of PluginAdapter_V1.
|
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() |
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
public static final java.lang.String COPYRIGHT
public PluginAdapter_V1(PluginConfigurationImpl pluginConfData)
pluginConfData
- The context data of the plugin, including the configuration data and
the target locale.public java.math.BigDecimal getAvailableBalance() throws InputException, BackendException, InternalException, ConfigException
getAvailableBalance
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.getAvailableBalance()
public void getCredit() throws InputException, BackendException, InternalException, ConfigException
getCredit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.getCredit()
public java.lang.String getMessage(java.lang.String messageKey, java.util.Locale locale) throws InputException, BackendException, InternalException, ConfigException
getMessage
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.getMessage(java.lang.String,
java.util.Locale)
public void getPayment() throws InputException, BackendException, InternalException, ConfigException
getPayment
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.getPayment()
public boolean isPluginLoaded()
isPluginLoaded
in class PluginAdapter
public void approve() throws InputException, BackendException, InternalException, ConfigException
approve
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.approve()
public void approveAndDeposit() throws InputException, BackendException, InternalException, ConfigException
approveAndDeposit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.approveAndDeposit()
public void checkPaymentInstruction() throws InputException, BackendException, InternalException, ConfigException
checkPaymentInstruction
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.checkPaymentInstruction()
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class PluginAdapter
java.lang.CloneNotSupportedException
- Thrown when clone is not supported.public void credit() throws InputException, BackendException, InternalException, ConfigException
credit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.credit()
public void deposit() throws InputException, BackendException, InternalException, ConfigException
deposit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.deposit()
public void init()
public void reverseApproval() throws InputException, BackendException, InternalException, ConfigException
reverseApproval
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.reverseApproval()
public void reverseCredit() throws InputException, BackendException, InternalException, ConfigException
reverseCredit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.reverseCredit()
public void reverseDeposit() throws InputException, BackendException, InternalException, ConfigException
reverseDeposit
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.reverseDeposit()
public void validatePaymentInstruction() throws InputException, BackendException, InternalException, ConfigException
validatePaymentInstruction
in class PluginAdapter
InputException
BackendException
InternalException
ConfigException
PluginAdapter.validatePaymentInstruction()
public boolean checkHealth() throws InternalException
checkHealth
in class PluginAdapter
InternalException
Plugin.checkHealth()
public java.lang.Object getMyEjb()
public void getBatch() throws InputException, CommunicationException, InternalException, ConfigException
getBatch
in class PluginAdapter
InputException
CommunicationException
InternalException
ConfigException
CommunicationException
public void settleBatch(boolean forceClose) throws InputException, CommunicationException, InternalException, ConfigException
settleBatch
in class PluginAdapter
forceClose
- A boolean indicating if the batch should be closed by force.InputException
CommunicationException
InternalException
ConfigException
CommunicationException
public void initAuthenticationSession() throws InternalException, CommunicationException
initAuthenticationSession
in class PluginAdapter
InternalException
CommunicationException
CommunicationException
public java.lang.String getAuthenticationURL() throws InternalException, CommunicationException
getAuthenticationURL
in class PluginAdapter
InternalException
CommunicationException
CommunicationException
public java.lang.String preprocessProviderResponseData() throws InternalException, CommunicationException
preprocessProviderResponseData
in class PluginAdapter
InternalException
CommunicationException
CommunicationException
public java.util.Map processProviderResponse() throws InternalException, CommunicationException
processProviderResponse
in class PluginAdapter
InternalException
CommunicationException
CommunicationException