org.broadleafcommerce.core.checkout.service.strategy

Class OrderPaymentConfirmationStrategyImpl

java.lang.Object

org.broadleafcommerce.core.checkout.service.strategy.OrderPaymentConfirmationStrategyImpl

All Implemented Interfaces:

OrderPaymentConfirmationStrategy

@Service(value="blOrderPaymentConfirmationStrategy")
public class OrderPaymentConfirmationStrategyImpl
extends Object
implements OrderPaymentConfirmationStrategy

Strategy to handle confirming "UNCONFIRMED" transactions on an Order Payment during the checkout workflow. The default implementation is to (based on the passed in payment type): - If PaymentType == CREDIT_CARD -> AUTHORIZE or AUTHORIZE_AND_CAPTURE based on configuration of the gateway - Otherwise -> call the configured gateways PaymentGatewayTransactionConfirmationService However, if PENDING payments are enabled, then this logic will be by-passed and a new transaction will be created as the payment is marked to be charged offline or asynchronously.

Author:

Elbert Bautista (elbertbautista)

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG
protected OrderToPaymentRequestDTOService	orderToPaymentRequestService
protected PaymentGatewayConfigurationServiceProvider	paymentConfigurationServiceProvider
protected SecureOrderPaymentService	secureOrderPaymentService
protected SystemPropertiesService	systemPropertiesService

Constructor Summary

Constructors

Constructor and Description
OrderPaymentConfirmationStrategyImpl()

Method Summary

Methods

Modifier and Type	Method and Description
PaymentResponseDTO	confirmPendingTransaction(PaymentTransaction tx, ProcessContext<CheckoutSeed> context) Strategy to determine how to "confirm" a PENDING OrderPayment post-checkout
PaymentResponseDTO	confirmTransaction(PaymentTransaction tx, ProcessContext<CheckoutSeed> context) Strategy to determine how to "confirm" an OrderPayment at checkout
protected PaymentResponseDTO	confirmTransactionInternal(PaymentTransaction tx, ProcessContext<CheckoutSeed> context, boolean isCheckout)
protected String	constructExpirationDate(Integer expMonth, Integer expYear) Default expiration date construction.
protected PaymentResponseDTO	constructPendingTransaction(PaymentType paymentType, PaymentGatewayType gatewayType, PaymentRequestDTO confirmationRequest)
protected boolean	enablePendingPaymentsOnCheckoutConfirmation() Set "gateway.config.global.enablePendingPayments" property to allow confirmation of an "UNCONFIRMED" transaction into a "PENDING" state instead of confirming into an AUTHORIZE or AUTHORIZE_AND_CAPTURE status.
protected String	getGatewayExpirationDateFormat()
protected boolean	orderContainsMultipleFinalPayments(Order order) determine whether or not this order contains multiple final payments.
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	transactionIsDetachedCreditRequest(PaymentTransaction transaction) determine whether or not this transaction is a detached credit request.

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

paymentConfigurationServiceProvider

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

orderToPaymentRequestService

protected OrderToPaymentRequestDTOService orderToPaymentRequestService

secureOrderPaymentService

protected SecureOrderPaymentService secureOrderPaymentService

systemPropertiesService

protected SystemPropertiesService systemPropertiesService

Constructor Detail

OrderPaymentConfirmationStrategyImpl

public OrderPaymentConfirmationStrategyImpl()

Method Detail

confirmTransaction

public PaymentResponseDTO confirmTransaction(PaymentTransaction tx,
                                    ProcessContext<CheckoutSeed> context)
                                      throws PaymentException,
                                             WorkflowException,
                                             CheckoutException

Description copied from interface: OrderPaymentConfirmationStrategy

Strategy to determine how to "confirm" an OrderPayment at checkout

Specified by:

confirmTransaction in interface OrderPaymentConfirmationStrategy

Throws:

PaymentException

WorkflowException

CheckoutException

confirmPendingTransaction

public PaymentResponseDTO confirmPendingTransaction(PaymentTransaction tx,
                                           ProcessContext<CheckoutSeed> context)
                                             throws PaymentException,
                                                    WorkflowException,
                                                    CheckoutException

Description copied from interface: OrderPaymentConfirmationStrategy

Strategy to determine how to "confirm" a PENDING OrderPayment post-checkout

Specified by:

confirmPendingTransaction in interface OrderPaymentConfirmationStrategy

Throws:

PaymentException

WorkflowException

CheckoutException

confirmTransactionInternal

protected PaymentResponseDTO confirmTransactionInternal(PaymentTransaction tx,
                                            ProcessContext<CheckoutSeed> context,
                                            boolean isCheckout)
                                                 throws PaymentException,
                                                        WorkflowException,
                                                        CheckoutException

Throws:

PaymentException

WorkflowException

CheckoutException

orderContainsMultipleFinalPayments

protected boolean orderContainsMultipleFinalPayments(Order order)

determine whether or not this order contains multiple final payments. (e.g. paying with multiple credit cards)

Parameters:

order -

Returns:

transactionIsDetachedCreditRequest

protected boolean transactionIsDetachedCreditRequest(PaymentTransaction transaction)

determine whether or not this transaction is a detached credit request. By default, will look at the additional fields map to determine intent (as the actual type of the transaction is UNCONFIRMED).

Parameters:

transaction -

Returns:

constructPendingTransaction

protected PaymentResponseDTO constructPendingTransaction(PaymentType paymentType,
                                             PaymentGatewayType gatewayType,
                                             PaymentRequestDTO confirmationRequest)

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()

enablePendingPaymentsOnCheckoutConfirmation

protected boolean enablePendingPaymentsOnCheckoutConfirmation()

Set "gateway.config.global.enablePendingPayments" property to allow confirmation of an "UNCONFIRMED" transaction into a "PENDING" state instead of confirming into an AUTHORIZE or AUTHORIZE_AND_CAPTURE status.