org.broadleafcommerce.core.checkout.service.workflow

Class ValidateAndConfirmPaymentActivity

java.lang.Object

org.broadleafcommerce.core.workflow.BaseActivity<ProcessContext<CheckoutSeed>>

org.broadleafcommerce.core.checkout.service.workflow.ValidateAndConfirmPaymentActivity

All Implemented Interfaces:

Activity<ProcessContext<CheckoutSeed>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.core.Ordered

public class ValidateAndConfirmPaymentActivity
extends BaseActivity<ProcessContext<CheckoutSeed>>

Verifies that there is enough payment on the order via the successful amount on PaymentTransactionType.AUTHORIZE and PaymentTransactionType.AUTHORIZE_AND_CAPTURE transactions. This will also confirm any PaymentTransactionType.UNCONFIRMED transactions that exist on am OrderPayment.

If there is an exception (either in this activity or later downstream) the confirmed payments are rolled back via GenericConfirmPaymentsRollbackHandler

Author:

Phillip Verheyden (phillipuniverse)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ValidateAndConfirmPaymentActivity.ResponseTransactionPair

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAILED_RESPONSES
protected static org.apache.commons.logging.Log	LOG
protected OrderPaymentService	orderPaymentService
protected OrderToPaymentRequestDTOService	orderToPaymentRequestService
protected PaymentGatewayConfigurationServiceProvider	paymentConfigurationServiceProvider
protected PaymentGatewayCheckoutService	paymentGatewayCheckoutService
static String	ROLLBACK_TRANSACTIONS Used by the GenericConfirmPaymentsRollbackHandler to roll back transactions that this activity confirms.
protected SecureOrderPaymentService	secureOrderPaymentService

Fields inherited from class org.broadleafcommerce.core.workflow.BaseActivity

automaticallyRegisterRollbackHandler, beanName, errorHandler, order, rollbackHandler, rollbackRegion, stateConfiguration

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ValidateAndConfirmPaymentActivity()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	constructExpirationDate(Integer expMonth, Integer expYear) Default expiration date construction.
ProcessContext<CheckoutSeed>	execute(ProcessContext<CheckoutSeed> context) Called by the encompassing processor to activate the execution of the Activity
protected String	getGatewayExpirationDateFormat()
protected void	handleUnsuccessfulTransactions(List<ValidateAndConfirmPaymentActivity.ResponseTransactionPair> failedTransactions, ProcessContext<CheckoutSeed> context) Default implementation is to throw a generic CheckoutException which will be caught and displayed on the Checkout Page where the Customer can try again.
protected void	populateBillingAddressOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	populateCreditCardOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	populateCustomerOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected void	populateShippingAddressOnRequest(PaymentRequestDTO requestDTO, OrderPayment payment)
protected boolean	shouldRollbackFailedTransaction(ValidateAndConfirmPaymentActivity.ResponseTransactionPair failedTransactionPair)

Methods inherited from class org.broadleafcommerce.core.workflow.BaseActivity

getAutomaticallyRegisterRollbackHandler, getBeanName, getErrorHandler, getOrder, getRollbackHandler, getRollbackRegion, getStateConfiguration, setAutomaticallyRegisterRollbackHandler, setBeanName, setErrorHandler, setOrder, setRollbackHandler, setRollbackRegion, setStateConfiguration, shouldExecute

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

ROLLBACK_TRANSACTIONS

public static final String ROLLBACK_TRANSACTIONS

Used by the GenericConfirmPaymentsRollbackHandler to roll back transactions that this activity confirms.

This could also contain failed transactions that still need to be rolled back

See Also:

Constant Field Values

FAILED_RESPONSES

public static final String FAILED_RESPONSES

See Also:

Constant Field Values

paymentConfigurationServiceProvider

@Autowired(required=false)
@Qualifier(value="blPaymentGatewayConfigurationServiceProvider")
protected PaymentGatewayConfigurationServiceProvider paymentConfigurationServiceProvider

orderToPaymentRequestService

protected OrderToPaymentRequestDTOService orderToPaymentRequestService

orderPaymentService

protected OrderPaymentService orderPaymentService

secureOrderPaymentService

protected SecureOrderPaymentService secureOrderPaymentService

paymentGatewayCheckoutService

protected PaymentGatewayCheckoutService paymentGatewayCheckoutService

Constructor Detail

ValidateAndConfirmPaymentActivity

public ValidateAndConfirmPaymentActivity()

Method Detail

execute

public ProcessContext<CheckoutSeed> execute(ProcessContext<CheckoutSeed> context)
                                     throws Exception

Description copied from interface: Activity

Called by the encompassing processor to activate the execution of the Activity

Parameters:

context - - process context for this workflow

Returns:

resulting process context

Throws:

Exception

handleUnsuccessfulTransactions

protected void handleUnsuccessfulTransactions(List<ValidateAndConfirmPaymentActivity.ResponseTransactionPair> failedTransactions,
                                  ProcessContext<CheckoutSeed> context)
                                       throws Exception

Default implementation is to throw a generic CheckoutException which will be caught and displayed on the Checkout Page where the Customer can try again. In many cases, this is sufficient as it is usually recommended to display a generic Error Message to prevent Credit Card fraud.

The configured payment gateway may return a more specific error. Each gateway is different and will often times return different error codes based on the acquiring bank as well. In that case, you may override this method to decipher these errors and handle it appropriately based on your business requirements.

Parameters:

responseDTOs -

Throws:

Exception

shouldRollbackFailedTransaction

protected boolean shouldRollbackFailedTransaction(ValidateAndConfirmPaymentActivity.ResponseTransactionPair failedTransactionPair)

populateCreditCardOnRequest

protected void populateCreditCardOnRequest(PaymentRequestDTO requestDTO,
                               OrderPayment payment)
                                    throws WorkflowException

Throws:

WorkflowException

populateBillingAddressOnRequest

protected void populateBillingAddressOnRequest(PaymentRequestDTO requestDTO,
                                   OrderPayment payment)

populateCustomerOnRequest

protected void populateCustomerOnRequest(PaymentRequestDTO requestDTO,
                             OrderPayment payment)

populateShippingAddressOnRequest

protected void populateShippingAddressOnRequest(PaymentRequestDTO requestDTO,
                                    OrderPayment payment)

constructExpirationDate

protected String constructExpirationDate(Integer expMonth,
                             Integer expYear)

Default expiration date construction. Some Payment Gateways may require a different format. Override if necessary or set the property "gateway.config.global.expDateFormat" with a format string to provide the correct format for the configured gateway.

Parameters:

expMonth -

expYear -

Returns:

getGatewayExpirationDateFormat

protected String getGatewayExpirationDateFormat()