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 ISOService	isoService
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) Initiates the checkout process for a given orderId.
boolean	isUseBillingAddressFromGateway()
String	lookupOrderNumberFromOrderId(PaymentResponseDTO responseDTO) Looks up the order number for a particular order id from the PaymentResponseDTO.
void	markPaymentAsInvalid(Long orderPaymentId) Marks a given order payment as invalid.
protected void	populateAddressInfo(Address address, AddressDTO<PaymentResponseDTO> dto)
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

isoService

protected ISOService isoService

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

Parameters:

responseDTO - the response that came back from the gateway

Returns:

a unique ID of the payment as it is saved in the Broadleaf domain. This ID can be referred to to retrieve the payment on the Broadleaf side for other methods like PaymentGatewayCheckoutService.markPaymentAsInvalid(Long)

populateBillingInfo

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

populateShippingInfo

protected void populateShippingInfo(PaymentResponseDTO responseDTO,
                        Order order)

populateAddressInfo

protected void populateAddressInfo(Address address,
                       AddressDTO<PaymentResponseDTO> dto)

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)

Description copied from interface: PaymentGatewayCheckoutService

Marks a given order payment as invalid. In the default implementation, this archives the payment. This can be determined from the result of PaymentGatewayCheckoutService.applyPaymentToOrder(PaymentResponseDTO, PaymentGatewayConfiguration)

Specified by:

markPaymentAsInvalid in interface PaymentGatewayCheckoutService

Parameters:

orderPaymentId - the payment ID to mark as invalid

initiateCheckout

public String initiateCheckout(Long orderId)
                        throws Exception

Description copied from interface: PaymentGatewayCheckoutService

Initiates the checkout process for a given orderId. This is usually from PaymentResponseDTO.getOrderId()

Specified by:

initiateCheckout in interface PaymentGatewayCheckoutService

Parameters:

orderId - the order to check out

Returns:

the response from checking out the order

Throws:

Exception

lookupOrderNumberFromOrderId

public String lookupOrderNumberFromOrderId(PaymentResponseDTO responseDTO)

Description copied from interface: PaymentGatewayCheckoutService

Looks up the order number for a particular order id from the PaymentResponseDTO. This can be used to redirect the user coming from the payment gateway to the order confirmation page.

Specified by:

lookupOrderNumberFromOrderId in interface PaymentGatewayCheckoutService

Parameters:

responseDTO - the response from the gateway

Returns:

The order number for order id. This method can return null if the order number has not already been set (which usually means that the order has not already been checked out)

isUseBillingAddressFromGateway

public boolean isUseBillingAddressFromGateway()

setUseBillingAddressFromGateway

public void setUseBillingAddressFromGateway(boolean useBillingAddressFromGateway)