Package org.broadleafcommerce.core.payment.service

Class OrderToPaymentRequestDTOServiceImpl

java.lang.Object

org.broadleafcommerce.core.payment.service.OrderToPaymentRequestDTOServiceImpl

All Implemented Interfaces:

OrderToPaymentRequestDTOService

@Service("blOrderToPaymentRequestDTOService")
public class OrderToPaymentRequestDTOServiceImpl
extends Object
implements OrderToPaymentRequestDTOService

Service that translates various pieces of information such as: - Order - PaymentTransaction into a PaymentRequestDTO so that the gateway can create the appropriate request for a specific transaction.

Author:

Elbert Bautista (elbertbautista)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OrderToPaymentRequestDTOServiceImpl.NameResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected FulfillmentGroupService	fgService
protected PaymentRequestDTOService	paymentRequestDTOService
protected PostLoaderDao	postLoaderDao
static final String	ZERO_TOTAL

Constructor Summary

Constructors

Constructor	Description
OrderToPaymentRequestDTOServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected OrderToPaymentRequestDTOServiceImpl.NameResponse	getName(Address address)
protected void	populateAddressInfo(AddressDTO<PaymentRequestDTO> dto, Address address)
void	populateBillTo(Order order, PaymentRequestDTO requestDTO)	Uses billing information on the Order to populate the PaymentRequestDTO.billTo() object
void	populateCustomerInfo(Order order, PaymentRequestDTO requestDTO)	Uses customer information on the Order to populate the PaymentRequestDTO.customer() object
void	populateDefaultLineItemsAndSubtotal(Order order, PaymentRequestDTO requestDTO)	IMPORTANT:
void	populateShipTo(Order order, PaymentRequestDTO requestDTO)	Uses the first shippable fulfillment group to populate the PaymentRequestDTO.shipTo() object
void	populateTotals(Order order, PaymentRequestDTO requestDTO)	Uses total information on the Order to populate the PaymentRequestDTO.transactionTotal(String)()} PaymentRequestDTO.taxTotal(String)()} PaymentRequestDTO.shippingTotal(String)()} PaymentRequestDTO.orderCurrencyCode(String)()}
protected PaymentTransaction	refreshTransaction(PaymentTransaction paymentTransaction)
PaymentRequestDTO	translateOrder(Order order)	This translates an Order into a PaymentRequestDTO.
PaymentRequestDTO	translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction)	Utilizes the PaymentTransaction.getAdditionalFields() map to populate necessary request parameters on the resulting PaymentRequestDTO.
PaymentRequestDTO	translatePaymentTransaction(Money transactionAmount, PaymentTransaction paymentTransaction, boolean autoCalculateFinalPaymentTotals)	Important: As of 4.0.1-GA+, there is a requirement to automatically populate the transaction amount on the DTO only if coming from a "checkout payment flow".

Methods inherited from class java.lang.Object

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

Field Details

ZERO_TOTAL

public static final String ZERO_TOTAL

See Also:

• Constant Field Values

fgService

protected FulfillmentGroupService fgService

postLoaderDao

protected PostLoaderDao postLoaderDao

paymentRequestDTOService

protected PaymentRequestDTOService paymentRequestDTOService

Constructor Details

OrderToPaymentRequestDTOServiceImpl

public OrderToPaymentRequestDTOServiceImpl()

Method Details

translateOrder

public PaymentRequestDTO translateOrder(Order order)

Description copied from interface: OrderToPaymentRequestDTOService

This translates an Order into a PaymentRequestDTO. This method assumes that the total transaction amount being sent to the gateway will be calculated from the "final payment" on the order. This means that the transaction amount for the returned PaymentRequestDTO will be Order.getTotalAfterAppliedPayments() It assumes that all other payments (e.g. gift cards/account credit) have already been applied to the Order.

Specified by:

translateOrder in interface OrderToPaymentRequestDTOService

Parameters:

order - the Order to be translated

Returns:

a PaymentRequestDTO based on the properties of an order.

translatePaymentTransaction

public PaymentRequestDTO translatePaymentTransaction(Money transactionAmount,
 PaymentTransaction paymentTransaction)

Description copied from interface: OrderToPaymentRequestDTOService

Utilizes the PaymentTransaction.getAdditionalFields() map to populate necessary request parameters on the resulting PaymentRequestDTO. These additional fields are then used by the payment gateway to construct additional requests. For example, an existing PaymentTransaction of type PaymentTransactionType.AUTHORIZE might be passed into this method in order for the gateway issue a "reverse auth" against this original transaction.

Specified by:

translatePaymentTransaction in interface OrderToPaymentRequestDTOService

Parameters:

transactionAmount - the amount that should be placed on PaymentRequestDTO.getTransactionTotal()

paymentTransaction - the transaction whose additional fields should be placed on PaymentRequestDTO.getAdditionalFields() for the gateway to use

Returns:

a new PaymentRequestDTO populated with the additional fields from paymentTransaction and the amount from transactionAmount OR override with final payment details on the order if coming in from a payment flow.

translatePaymentTransaction

public PaymentRequestDTO translatePaymentTransaction(Money transactionAmount,
 PaymentTransaction paymentTransaction,
 boolean autoCalculateFinalPaymentTotals)

Description copied from interface: OrderToPaymentRequestDTOService

Important: As of 4.0.1-GA+, there is a requirement to automatically populate the transaction amount on the DTO only if coming from a "checkout payment flow". That is, if you are invoking this method via the ValidateAndConfirmPaymentActivity and the payment transaction passed in is of type PaymentTransactionType.UNCONFIRMED. If the totals need to be auto-calculated, the transaction total will be set from the "final payment" details that are coming off the order itself (along with other details like shipping/billing info etc...)

Specified by:

translatePaymentTransaction in interface OrderToPaymentRequestDTOService

Returns:

refreshTransaction

protected PaymentTransaction refreshTransaction(PaymentTransaction paymentTransaction)

populateTotals

public void populateTotals(Order order,
 PaymentRequestDTO requestDTO)

Description copied from interface: OrderToPaymentRequestDTOService

Uses total information on the Order to populate the PaymentRequestDTO.transactionTotal(String)()} PaymentRequestDTO.taxTotal(String)()} PaymentRequestDTO.shippingTotal(String)()} PaymentRequestDTO.orderCurrencyCode(String)()}

Specified by:

populateTotals in interface OrderToPaymentRequestDTOService

Parameters:

order - the Order to get data from

requestDTO - the PaymentRequestDTO that should be populated

populateCustomerInfo

public void populateCustomerInfo(Order order,
 PaymentRequestDTO requestDTO)

Description copied from interface: OrderToPaymentRequestDTOService

Uses customer information on the Order to populate the PaymentRequestDTO.customer() object

Specified by:

populateCustomerInfo in interface OrderToPaymentRequestDTOService

Parameters:

order - the Order to get data from

requestDTO - the PaymentRequestDTO that should be populated

populateShipTo

public void populateShipTo(Order order,
 PaymentRequestDTO requestDTO)

Uses the first shippable fulfillment group to populate the PaymentRequestDTO.shipTo() object

Specified by:

populateShipTo in interface OrderToPaymentRequestDTOService

Parameters:

order - the Order to get data from

requestDTO - the PaymentRequestDTO that should be populated

populateBillTo

public void populateBillTo(Order order,
 PaymentRequestDTO requestDTO)

Description copied from interface: OrderToPaymentRequestDTOService

Uses billing information on the Order to populate the PaymentRequestDTO.billTo() object

Specified by:

populateBillTo in interface OrderToPaymentRequestDTOService

Parameters:

order - the Order to get data from

requestDTO - the PaymentRequestDTO that should be populated

populateAddressInfo

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

getName

protected OrderToPaymentRequestDTOServiceImpl.NameResponse getName(Address address)

populateDefaultLineItemsAndSubtotal

public void populateDefaultLineItemsAndSubtotal(Order order,
 PaymentRequestDTO requestDTO)

IMPORTANT:

If you would like to pass Line Item information to a payment gateway so that it shows up on the hosted site, you will need to override this method and construct line items to conform to the requirements of that particular gateway:

For Example: The Paypal Express Checkout NVP API validates that the order subtotal that you pass in, add up to the amount of the line items that you pass in. So, In that case you will need to take into account any additional fees, promotions, credits, gift cards, etc... that are applied to the payment and add them as additional line items with a negative amount when necessary.

Each gateway that accepts line item information may require you to construct this differently. Please consult the module documentation on how it should be properly constructed.

In this default implementation, just the subtotal is set, without any line item details.

Specified by:

populateDefaultLineItemsAndSubtotal in interface OrderToPaymentRequestDTOService

Parameters:

order -

requestDTO -