org.broadleafcommerce.common.web.payment.processor

Class AbstractTRCreditCardExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.common.web.payment.processor.AbstractTRCreditCardExtensionHandler

All Implemented Interfaces:

ExtensionHandler, TRCreditCardExtensionHandler

public abstract class AbstractTRCreditCardExtensionHandler
extends AbstractExtensionHandler
implements TRCreditCardExtensionHandler

An Abstract implementation of the TRCreditCardExtensionHandler. PaymentGateway Handlers will just need to extend this class and implement the declared abstract methods.

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected PaymentGatewayResolver	paymentGatewayResolver

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractTRCreditCardExtensionHandler()

Method Summary

Modifier and Type	Method and Description
ExtensionResultStatusType	createTransparentRedirectForm(Map<String,Map<String,String>> formParameters, PaymentRequestDTO requestDTO, Map<String,String> configurationSettings) The implementing modules should take into consideration the passed in configuration settings map and call their implementing TransparentRedirectService to generate either an Authorize or Authorize and Capture Form.
abstract PaymentGatewayConfiguration	getConfiguration()
abstract String	getFormActionURLKey()
PaymentGatewayType	getHandlerType()
abstract String	getHiddenParamsKey()
abstract PaymentGatewayTransparentRedirectService	getTransparentRedirectService()
protected void	overrideCustomerPaymentReturnURLs(PaymentRequestDTO requestDTO, PaymentResponseDTO responseDTO) If the request contains information about an override return URL, use the one specified on the request dto.
abstract void	populateFormParameters(Map<String,Map<String,String>> formParameters, PaymentResponseDTO responseDTO)
ExtensionResultStatusType	setFormActionKey(StringBuilder key)
ExtensionResultStatusType	setFormHiddenParamsKey(StringBuilder key)

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Field Detail

paymentGatewayResolver

protected PaymentGatewayResolver paymentGatewayResolver

Constructor Detail

AbstractTRCreditCardExtensionHandler

public AbstractTRCreditCardExtensionHandler()

Method Detail

setFormActionKey

public ExtensionResultStatusType setFormActionKey(StringBuilder key)

Specified by:

setFormActionKey in interface TRCreditCardExtensionHandler

setFormHiddenParamsKey

public ExtensionResultStatusType setFormHiddenParamsKey(StringBuilder key)

Specified by:

setFormHiddenParamsKey in interface TRCreditCardExtensionHandler

createTransparentRedirectForm

public ExtensionResultStatusType createTransparentRedirectForm(Map<String,Map<String,String>> formParameters,
                                                               PaymentRequestDTO requestDTO,
                                                               Map<String,String> configurationSettings)
                                                        throws PaymentException

Description copied from interface: TRCreditCardExtensionHandler

The implementing modules should take into consideration the passed in configuration settings map and call their implementing TransparentRedirectService to generate either an Authorize or Authorize and Capture Form. The decision should be based on the implementing PaymentGatewayConfiguration.isPerformAuthorizeAndCapture();

This method accepts a RequestDTO that represents the order along with a map of gateway-specific configuration settings. The hidden values and the form action will be placed on the passed in formParameters variable. The keys to that map can be retrieved by calling the following methods. getFormActionKey, getFormHiddenParamsKey.

Specified by:

createTransparentRedirectForm in interface TRCreditCardExtensionHandler

Throws:

PaymentException

getHandlerType

public PaymentGatewayType getHandlerType()

getFormActionURLKey

public abstract String getFormActionURLKey()

getHiddenParamsKey

public abstract String getHiddenParamsKey()

getConfiguration

public abstract PaymentGatewayConfiguration getConfiguration()

getTransparentRedirectService

public abstract PaymentGatewayTransparentRedirectService getTransparentRedirectService()

populateFormParameters

public abstract void populateFormParameters(Map<String,Map<String,String>> formParameters,
                                            PaymentResponseDTO responseDTO)

overrideCustomerPaymentReturnURLs

protected void overrideCustomerPaymentReturnURLs(PaymentRequestDTO requestDTO,
                                                 PaymentResponseDTO responseDTO)

If the request contains information about an override return URL, use the one specified on the request dto. e.g. some modules like OMS may use the transparent redirect mechanism to create payment tokens, if the request is originating from a module, then it may override the return url, else the request would be coming from a normal flow, like adding a customer payment token from a customer's profile page.