org.broadleafcommerce.core.payment.service

Class OrderPaymentServiceImpl

java.lang.Object

org.broadleafcommerce.core.payment.service.OrderPaymentServiceImpl

All Implemented Interfaces:

OrderPaymentService

@Service(value="blOrderPaymentService")
public class OrderPaymentServiceImpl
extends Object
implements OrderPaymentService

Field Summary

Fields

Modifier and Type	Field and Description
protected AddressService	addressService
protected CustomerPaymentService	customerPaymentService
protected OrderPaymentDao	paymentDao

Constructor Summary

Constructors

Constructor and Description
OrderPaymentServiceImpl()

Method Summary

Modifier and Type	Method and Description
OrderPayment	create()
CustomerPayment	createCustomerPaymentFromPaymentTransaction(PaymentTransaction transaction) Create a CustomerPayment token for the passed in Customer given a PaymentTransaction.
PaymentLog	createLog()
OrderPayment	createOrderPaymentFromCustomerPayment(Order order, CustomerPayment customerPayment, Money amount) Create an OrderPayment with a single PaymentTransactionType.UNCONFIRMED PaymentTransaction initialized with the passed in amount and order.
PaymentTransaction	createTransaction()
void	delete(OrderPayment payment) Deletes a payment from the system.
void	populateCustomerPaymentToken(CustomerPayment customerPayment, PaymentTransaction transaction) Will attempt to populate the CustomerPayment.setPaymentToken(String) by looking at the PaymentTransaction.getAdditionalFields() for key PaymentAdditionalFieldType.TOKEN.
OrderPayment	readPaymentById(Long paymentId)
List<OrderPayment>	readPaymentsForOrder(Order order)
PaymentTransaction	readTransactionById(Long transactionId)
OrderPayment	save(OrderPayment payment)
PaymentLog	save(PaymentLog log)
PaymentTransaction	save(PaymentTransaction transaction)

Methods inherited from class java.lang.Object

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

Field Detail

paymentDao

protected OrderPaymentDao paymentDao

customerPaymentService

protected CustomerPaymentService customerPaymentService

addressService

protected AddressService addressService

Constructor Detail

OrderPaymentServiceImpl

public OrderPaymentServiceImpl()

Method Detail

save

@Transactional(value="blTransactionManager")
public OrderPayment save(OrderPayment payment)

Specified by:

save in interface OrderPaymentService

save

@Transactional(value="blTransactionManager")
public PaymentTransaction save(PaymentTransaction transaction)

Specified by:

save in interface OrderPaymentService

save

public PaymentLog save(PaymentLog log)

Specified by:

save in interface OrderPaymentService

readPaymentById

public OrderPayment readPaymentById(Long paymentId)

Specified by:

readPaymentById in interface OrderPaymentService

readPaymentsForOrder

public List<OrderPayment> readPaymentsForOrder(Order order)

Specified by:

readPaymentsForOrder in interface OrderPaymentService

create

public OrderPayment create()

Specified by:

create in interface OrderPaymentService

delete

@Transactional(value="blTransactionManager")
public void delete(OrderPayment payment)

Description copied from interface: OrderPaymentService

Deletes a payment from the system. Note that this is just a soft-delete and simply archives this entity

Specified by:

delete in interface OrderPaymentService

See Also:

OrderPayment#getArchived()}

createLog

public PaymentLog createLog()

Specified by:

createLog in interface OrderPaymentService

createTransaction

public PaymentTransaction createTransaction()

Specified by:

createTransaction in interface OrderPaymentService

readTransactionById

public PaymentTransaction readTransactionById(Long transactionId)

Specified by:

readTransactionById in interface OrderPaymentService

createOrderPaymentFromCustomerPayment

@Transactional(value="blTransactionManager")
public OrderPayment createOrderPaymentFromCustomerPayment(Order order,
                                                                                                       CustomerPayment customerPayment,
                                                                                                       Money amount)

Description copied from interface: OrderPaymentService

Create an OrderPayment with a single PaymentTransactionType.UNCONFIRMED PaymentTransaction initialized with the passed in amount and order.

Used typically during the payment flow of checkout, where a customer intends to pay for their order with a saved payment token.

Specified by:

createOrderPaymentFromCustomerPayment in interface OrderPaymentService

Returns:

createCustomerPaymentFromPaymentTransaction

@Transactional(value="blTransactionManager")
public CustomerPayment createCustomerPaymentFromPaymentTransaction(PaymentTransaction transaction)

Description copied from interface: OrderPaymentService

Create a CustomerPayment token for the passed in Customer given a PaymentTransaction. This assumes that the token and any additional request attributes needed to do another transaction for this specific gateway has already been persisted to the PaymentTransaction.getAdditionalFields() map. Specifically, the PaymentAdditionalFieldType.TOKEN has been set.

Used typically during the complete checkout flow when a token needs to be saved from a "confirmed" transaction

Specified by:

createCustomerPaymentFromPaymentTransaction in interface OrderPaymentService

Returns:

populateCustomerPaymentToken

public void populateCustomerPaymentToken(CustomerPayment customerPayment,
                                         PaymentTransaction transaction)

Description copied from interface: OrderPaymentService

Will attempt to populate the CustomerPayment.setPaymentToken(String) by looking at the PaymentTransaction.getAdditionalFields() for key PaymentAdditionalFieldType.TOKEN.

Usually used during a checkout flow when there is a direct response from the gateway (e.g. transparent redirect).

Specified by:

populateCustomerPaymentToken in interface OrderPaymentService

See Also:

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