org.broadleafcommerce.core.payment.service

Class DefaultPaymentGatewayCheckoutService

java.lang.Object

org.broadleafcommerce.core.payment.service.DefaultPaymentGatewayCheckoutService

All Implemented Interfaces:

PaymentGatewayCheckoutService

@Service(value="blPaymentGatewayCheckoutService")
public class DefaultPaymentGatewayCheckoutService
extends Object
implements PaymentGatewayCheckoutService

Core framework implementation of the PaymentGatewayCheckoutService.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

PaymentGatewayAbstractController}

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressService	addressService
protected CheckoutService	checkoutService
protected CountryService	countryService
protected FulfillmentGroupService	fulfillmentGroupService
protected OrderPaymentService	orderPaymentService
protected OrderService	orderService
protected PhoneService	phoneService
protected StateService	stateService
protected boolean	useBillingAddressFromGateway

Constructor Summary

Constructors

Constructor and Description
DefaultPaymentGatewayCheckoutService()

Method Summary

Methods

Modifier and Type	Method and Description
Long	applyPaymentToOrder(PaymentResponseDTO responseDTO, PaymentGatewayConfiguration config)
protected void	handleUnsuccessfulTransaction(OrderPayment payment) This default implementation will mark the entire payment as invalid and boot the user to re-enter their billing info and payment information as there may be an error with either the billing address or credit card.
String	initiateCheckout(Long orderId)
boolean	isUseBillingAddressFromGateway()
String	lookupOrderNumberFromOrderId(PaymentResponseDTO responseDTO)
void	markPaymentAsInvalid(Long orderPaymentId)
protected void	populateBillingInfo(PaymentResponseDTO responseDTO, OrderPayment payment, Address tempBillingAddress)
protected void	populateShippingInfo(PaymentResponseDTO responseDTO, Order order)
void	setUseBillingAddressFromGateway(boolean useBillingAddressFromGateway)

Methods inherited from class java.lang.Object

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

Field Detail

orderService

protected OrderService orderService

orderPaymentService

protected OrderPaymentService orderPaymentService

checkoutService

protected CheckoutService checkoutService

addressService

protected AddressService addressService

stateService

protected StateService stateService

countryService

protected CountryService countryService

phoneService

protected PhoneService phoneService

fulfillmentGroupService

protected FulfillmentGroupService fulfillmentGroupService

useBillingAddressFromGateway

@Value(value="${default.payment.gateway.checkout.useGatewayBillingAddress}")
protected boolean useBillingAddressFromGateway

Constructor Detail

DefaultPaymentGatewayCheckoutService

public DefaultPaymentGatewayCheckoutService()

Method Detail

applyPaymentToOrder

public Long applyPaymentToOrder(PaymentResponseDTO responseDTO,
                       PaymentGatewayConfiguration config)

Specified by:

applyPaymentToOrder in interface PaymentGatewayCheckoutService

populateBillingInfo

protected void populateBillingInfo(PaymentResponseDTO responseDTO,
                       OrderPayment payment,
                       Address tempBillingAddress)

populateShippingInfo

protected void populateShippingInfo(PaymentResponseDTO responseDTO,
                        Order order)

handleUnsuccessfulTransaction

protected void handleUnsuccessfulTransaction(OrderPayment payment)

This default implementation will mark the entire payment as invalid and boot the user to re-enter their billing info and payment information as there may be an error with either the billing address or credit card. This is the safest method, because depending on the implementation of the Gateway, we may not know exactly where the error occurred (e.g. Address Verification enabled, etc...) So, we will assume that the error invalidates the entire Order Payment, and the customer will have to re-enter their billing and credit card information to be processed again.

Parameters:

payment -

markPaymentAsInvalid

public void markPaymentAsInvalid(Long orderPaymentId)

Specified by:

markPaymentAsInvalid in interface PaymentGatewayCheckoutService

initiateCheckout

public String initiateCheckout(Long orderId)
                        throws Exception

Specified by:

initiateCheckout in interface PaymentGatewayCheckoutService

Throws:

Exception

lookupOrderNumberFromOrderId

public String lookupOrderNumberFromOrderId(PaymentResponseDTO responseDTO)

Specified by:

lookupOrderNumberFromOrderId in interface PaymentGatewayCheckoutService

isUseBillingAddressFromGateway

public boolean isUseBillingAddressFromGateway()

setUseBillingAddressFromGateway

public void setUseBillingAddressFromGateway(boolean useBillingAddressFromGateway)