Package org.cyclos.impl.banking

Class PaymentServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.banking.PaymentServiceImpl

All Implemented Interfaces:

PaymentServiceLocal, PaymentService, Service

@Service
public class PaymentServiceImpl
extends BaseServiceImpl
implements PaymentServiceLocal

implementation for PaymentService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
PaymentServiceImpl()

Method Summary

Modifier and Type	Method	Description
Payment	acceptExternalPayment(ExternalPayment externalPayment, User destinationUser)	Performs the payment for the given external payment
Payment	acceptPaymentRequest(PaymentRequest paymentRequest)	Performs the payment for the given payment request
Payment	confirmOrder(Order order)	Performs the payment related to the given order, returning the reserved amount, if any
Payment	createForVoucherBuying(VoucherType type, User buyer, BigDecimal amount, List<CustomFieldValueDTO> customValues)	Generate a payment when buying a voucher
Payment	createForVoucherRedeeming(Voucher voucher, User user, BigDecimal amount, List<CustomFieldValueDTO> customValues)	Create a payment when redeeming a voucher
Payment	createForVoucherTopUp(Voucher voucher, User user, BigDecimal amount, List<CustomFieldValueDTO> customValues)	Performs a payment for topping-up a voucher
PaymentPreviewVO	doPreview(PerformPaymentDTO parameters, boolean validateCustomFields, boolean runExtensionPoints, SessionData receiverSessionData, PaymentCreationType creationType)	Previews the payment.
PaymentData	getData(Long id)	Returns data about a payment
Payment	importPayment(PerformPaymentDTO parameters, boolean sendNotifications)	Imports a payment
void	initialize()
void	notifyPaymentPerformed(Payment payment)
PaymentVO	perform(PerformPaymentDTO parameters)	Performs a payment, according to the given parameters, returning the resulting payment.
PaymentPreviewVO	preview(PerformPaymentDTO parameters)	Previews a payment to be performed
PaymentPreviewVO	previewAcceptPaymentRequest(PaymentRequest paymentRequest)	Previews accepting the given payment request
PaymentPreviewVO	previewApproveTicket(Ticket ticket)	Previews approving the given ticket
PaymentPreviewVO	previewReceive(PerformPaymentDTO parameters)	Previews a payment to be received
PaymentPreviewVO	previewVoucherBuying(VoucherType type, User buyer, BigDecimal amount, List<CustomFieldValueDTO> customValues)	Previews the payment performed on voucher buying
Payment	processTicket(Ticket ticket)	Performs a payment for the given ticket
PaymentVO	receive(PerformPaymentDTO parameters)	Receives a payment, according to the given parameters, returning the resulting payment.
Payment	refund(Voucher voucher)	Performs a payment for refunding the given voucher
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected PerformPaymentDTO	toBuyVoucherParams(VoucherType type, User buyer, BigDecimal amount, List<CustomFieldValueDTO> customValues)
String	toId(Long id)
void	validate(PerformPaymentDTO dto)	Validates the parameters to perform a payment without actually performing the payment.

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentServiceImpl

public PaymentServiceImpl()

Method Detail

acceptExternalPayment

public Payment acceptExternalPayment(ExternalPayment externalPayment,
                                     User destinationUser)

Description copied from interface: PaymentServiceLocal

Performs the payment for the given external payment

Specified by:

acceptExternalPayment in interface PaymentServiceLocal

destinationUser - The user that will receive the payment

acceptPaymentRequest

public Payment acceptPaymentRequest(PaymentRequest paymentRequest)
                             throws FrameworkException,
                                    TransferException,
                                    PasswordException

Description copied from interface: PaymentServiceLocal

Performs the payment for the given payment request

Specified by:

acceptPaymentRequest in interface PaymentServiceLocal

Throws:

FrameworkException

TransferException

PasswordException

confirmOrder

public Payment confirmOrder(Order order)
                     throws TransferException,
                            PasswordException

Description copied from interface: PaymentServiceLocal

Performs the payment related to the given order, returning the reserved amount, if any

Specified by:

confirmOrder in interface PaymentServiceLocal

Throws:

TransferException

PasswordException

createForVoucherBuying

public Payment createForVoucherBuying(VoucherType type,
                                      User buyer,
                                      BigDecimal amount,
                                      List<CustomFieldValueDTO> customValues)
                               throws FrameworkException,
                                      TransferException

Description copied from interface: PaymentServiceLocal

Generate a payment when buying a voucher

Specified by:

createForVoucherBuying in interface PaymentServiceLocal

Throws:

FrameworkException

TransferException

createForVoucherRedeeming

public Payment createForVoucherRedeeming(Voucher voucher,
                                         User user,
                                         BigDecimal amount,
                                         List<CustomFieldValueDTO> customValues)

Description copied from interface: PaymentServiceLocal

Create a payment when redeeming a voucher

Specified by:

createForVoucherRedeeming in interface PaymentServiceLocal

createForVoucherTopUp

public Payment createForVoucherTopUp(Voucher voucher,
                                     User user,
                                     BigDecimal amount,
                                     List<CustomFieldValueDTO> customValues)

Description copied from interface: PaymentServiceLocal

Performs a payment for topping-up a voucher

Specified by:

createForVoucherTopUp in interface PaymentServiceLocal

doPreview

public PaymentPreviewVO doPreview(PerformPaymentDTO parameters,
                                  boolean validateCustomFields,
                                  boolean runExtensionPoints,
                                  SessionData receiverSessionData,
                                  PaymentCreationType creationType)

Description copied from interface: PaymentServiceLocal

Previews the payment.

Specified by:

doPreview in interface PaymentServiceLocal

receiverSessionData - If not null, is the session data of the payment receiver. If null is not a receive payment

getData

public PaymentData getData(Long id)
                    throws FrameworkException

Description copied from interface: PaymentService

Returns data about a payment

Specified by:

getData in interface PaymentService

Throws:

FrameworkException

importPayment

public Payment importPayment(PerformPaymentDTO parameters,
                             boolean sendNotifications)
                      throws FrameworkException

Description copied from interface: PaymentServiceLocal

Imports a payment

Specified by:

importPayment in interface PaymentServiceLocal

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

notifyPaymentPerformed

public void notifyPaymentPerformed(Payment payment)

Specified by:

notifyPaymentPerformed in interface PaymentServiceLocal

perform

public PaymentVO perform(PerformPaymentDTO parameters)
                  throws TransferException,
                         ValidationException,
                         PasswordException

Description copied from interface: PaymentService

Performs a payment, according to the given parameters, returning the resulting payment.

Specified by:

perform in interface PaymentService

Throws:

InsufficientBalanceException - When the source account, or source account for any generated fee is limited and had insufficient balance for such a payment

MaxAmountPerDayExceededException - When the maximum amount for payments of this transfer type has been exceeded, according to the transfer type configuration

UpperCreditLimitReachedException - When the destination account, or destination account for any generated fee is limited and would have more balance than the allowed maximum

PasswordException - When the confirmation password doesn't match

TransferException

ValidationException

preview

public PaymentPreviewVO preview(PerformPaymentDTO parameters)
                         throws ValidationException

Description copied from interface: PaymentService

Previews a payment to be performed

Specified by:

preview in interface PaymentService

Throws:

ValidationException

previewAcceptPaymentRequest

public PaymentPreviewVO previewAcceptPaymentRequest(PaymentRequest paymentRequest)

Description copied from interface: PaymentServiceLocal

Previews accepting the given payment request

Specified by:

previewAcceptPaymentRequest in interface PaymentServiceLocal

previewApproveTicket

public PaymentPreviewVO previewApproveTicket(Ticket ticket)

Description copied from interface: PaymentServiceLocal

Previews approving the given ticket

Specified by:

previewApproveTicket in interface PaymentServiceLocal

previewReceive

public PaymentPreviewVO previewReceive(PerformPaymentDTO parameters)
                                throws FrameworkException,
                                       TransferException

Description copied from interface: PaymentService

Previews a payment to be received

Specified by:

previewReceive in interface PaymentService

Throws:

FrameworkException

TransferException

previewVoucherBuying

public PaymentPreviewVO previewVoucherBuying(VoucherType type,
                                             User buyer,
                                             BigDecimal amount,
                                             List<CustomFieldValueDTO> customValues)

Description copied from interface: PaymentServiceLocal

Previews the payment performed on voucher buying

Specified by:

previewVoucherBuying in interface PaymentServiceLocal

processTicket

public Payment processTicket(Ticket ticket)

Description copied from interface: PaymentServiceLocal

Performs a payment for the given ticket

Specified by:

processTicket in interface PaymentServiceLocal

receive

public PaymentVO receive(PerformPaymentDTO parameters)
                  throws FrameworkException,
                         TransferException

Description copied from interface: PaymentService

Receives a payment, according to the given parameters, returning the resulting payment.

Specified by:

receive in interface PaymentService

Throws:

FrameworkException

TransferException

See Also:

PaymentService.perform(PerformPaymentDTO)

refund

public Payment refund(Voucher voucher)

Description copied from interface: PaymentServiceLocal

Performs a payment for refunding the given voucher

Specified by:

refund in interface PaymentServiceLocal

toId

public String toId(Long id)

validate

public void validate(PerformPaymentDTO dto)
              throws FrameworkException

Description copied from interface: PaymentService

Validates the parameters to perform a payment without actually performing the payment. Attention: will only validate for required / invalid fields, but will not check for balance, maximum amount per day or other validations that require access to actual accounts.

Specified by:

validate in interface PaymentService

Throws:

FrameworkException

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

toBuyVoucherParams

protected PerformPaymentDTO toBuyVoucherParams(VoucherType type,
                                               User buyer,
                                               BigDecimal amount,
                                               List<CustomFieldValueDTO> customValues)