Package 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

@Component("blValidateAndConfirmPaymentActivity")
public class ValidateAndConfirmPaymentActivity
extends BaseActivity<ProcessContext<CheckoutSeed>>

This activity is responsible for validating and processing several aspects of an order's payment so that it may successfully complete the checkout workflow. This activity will:

• Verify that there is enough payment on the order via the successful amount on PaymentTransactionType.AUTHORIZE and PaymentTransactionType.AUTHORIZE_AND_CAPTURE and PaymentTransactionType.PENDING transactions.
• "Confirm" any PaymentTransactionType.UNCONFIRMED transactions that exist on an OrderPayment. This can mean different things depending on the type of Order Payment and is handled by the OrderPaymentConfirmationStrategy
• If there is an exception (either in this activity or later downstream) the confirmed payments are rolled back via ConfirmPaymentsRollbackHandler. It will also by default attempt to mark the payment as "ARCHIVED" so that the user may attempt to re-enter their payment details.

Author:

Phillip Verheyden (phillipuniverse), Elbert Bautista (elbertbautista)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ValidateAndConfirmPaymentActivity.ResponseTransactionPair

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FAILED_RESPONSES
protected static final org.apache.commons.logging.Log	LOG
static final int	ORDER
protected OrderPaymentConfirmationStrategy	orderPaymentConfirmationStrategy
protected OrderPaymentService	orderPaymentService
protected OrderPaymentStatusService	orderPaymentStatusService
protected OrderToPaymentRequestDTOService	orderToPaymentRequestService
protected PaymentGatewayConfigurationServiceProvider	paymentConfigurationServiceProvider
protected PaymentGatewayCheckoutService	paymentGatewayCheckoutService
static final String	ROLLBACK_TRANSACTIONS	Used by the ConfirmPaymentsRollbackHandler to roll back transactions that this activity confirms.

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	Description
ValidateAndConfirmPaymentActivity(ConfirmPaymentsRollbackHandler rollbackHandler)

Method Summary

Modifier and Type	Method	Description
protected CustomerPayment	createCustomerPaymentToken(PaymentTransaction transaction)
ProcessContext<CheckoutSeed>	execute(ProcessContext<CheckoutSeed> context)	Called by the encompassing processor to activate the execution of the Activity
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 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 Details

ORDER

public static final int ORDER

See Also:

• Constant Field Values

ROLLBACK_TRANSACTIONS

public static final String ROLLBACK_TRANSACTIONS

Used by the ConfirmPaymentsRollbackHandler 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

LOG

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

paymentConfigurationServiceProvider

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

orderToPaymentRequestService

protected OrderToPaymentRequestDTOService orderToPaymentRequestService

orderPaymentService

protected OrderPaymentService orderPaymentService

paymentGatewayCheckoutService

protected PaymentGatewayCheckoutService paymentGatewayCheckoutService

orderPaymentConfirmationStrategy

protected OrderPaymentConfirmationStrategy orderPaymentConfirmationStrategy

orderPaymentStatusService

protected OrderPaymentStatusService orderPaymentStatusService

Constructor Details

ValidateAndConfirmPaymentActivity

@Autowired
public ValidateAndConfirmPaymentActivity(@Qualifier("blConfirmPaymentsRollbackHandler")
 ConfirmPaymentsRollbackHandler rollbackHandler)

Method Details

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.

Throws:

Exception

shouldRollbackFailedTransaction

protected boolean shouldRollbackFailedTransaction(ValidateAndConfirmPaymentActivity.ResponseTransactionPair failedTransactionPair)

createCustomerPaymentToken

protected CustomerPayment createCustomerPaymentToken(PaymentTransaction transaction)