de.hybris.platform.cscockpit.services.payment.impl

Class DefaultCsCardPaymentService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cscockpit.services.payment.impl.DefaultCsCardPaymentService

All Implemented Interfaces:

CsCardPaymentService, java.io.Serializable

Direct Known Subclasses:

DefaultSubscriptionCsCardPaymentService

public class DefaultCsCardPaymentService
extends AbstractBusinessService
implements CsCardPaymentService

Default implementation of the CsCardPaymentService interface.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCsCardPaymentService()

Method Summary

Modifier and Type	Method and Description
PaymentTransactionEntryModel	authoriseCardPayment(AbstractOrderModel order, CardInfo cardInfo, double amount) Authorise payment for the cart or order.
protected java.lang.String	cleanupCardNumber(java.lang.String cardNumber) Cleanup the card number.
protected java.lang.String	generatePaymentInfoKey(CreditCardPaymentInfoModel paymentInfo)
protected java.lang.String	generatePreAuthTransactionCode(AbstractOrderModel order)
protected CardValidator	getCardValidator()
protected CommonI18NService	getCommonI18NService()
protected CsOrderUnauthorizedTotalStrategy	getCsOrderUnauthorizedTotalStrategy()
protected AddressModel	getPaymentDeliveryAddress(AbstractOrderModel order)
protected PaymentService	getPaymentService()
java.util.List<CreditCardPaymentInfoModel>	getPreviousCreditCardPaymentInfos(UserModel user) Get previously used payment infos for the specified user.
java.util.List<CreditCardType>	getSupportedCardSchemes(AbstractOrderModel order) Get the list of available card types for the specified cart or order.
protected TransactionCodeGenerator	getTransactionCodeGenerator()
protected TransactionInfoService	getTransactionInfoService()
protected PaymentTransactionEntryModel	preAuth(AbstractOrderModel order, CardInfo cardInfo, double amount)
void	setCardValidator(CardValidator cardValidator)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCsOrderUnauthorizedTotalStrategy(CsOrderUnauthorizedTotalStrategy csOrderUnauthorizedTotalStrategy)
void	setPaymentService(PaymentService paymentService)
void	setTransactionCodeGenerator(TransactionCodeGenerator transactionCodeGenerator)
void	setTransactionInfoService(TransactionInfoService transactionInfoService)
void	validate(AbstractOrderModel order, CardInfo cardInfo, double amount) Validate the order, cardInfo and amount.
protected void	validateAmount(AbstractOrderModel order, double amount, java.util.List<ResourceMessage> errorMessages) Validate that the amount it valid.
protected void	validateBillingInfo(AbstractOrderModel order, CardInfo cardInfo, java.util.List<ResourceMessage> errorMessages) Validate the the billing info in the cardInfo.
protected void	validateCardInfo(AbstractOrderModel order, CardInfo cardInfo, java.util.List<ResourceMessage> errorMessages) Validate the cardInfo.

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, setTenantScope, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCsCardPaymentService

public DefaultCsCardPaymentService()

Method Detail

getTransactionCodeGenerator

protected TransactionCodeGenerator getTransactionCodeGenerator()

setTransactionCodeGenerator

public void setTransactionCodeGenerator(TransactionCodeGenerator transactionCodeGenerator)

getPaymentService

protected PaymentService getPaymentService()

setPaymentService

public void setPaymentService(PaymentService paymentService)

getTransactionInfoService

protected TransactionInfoService getTransactionInfoService()

setTransactionInfoService

public void setTransactionInfoService(TransactionInfoService transactionInfoService)

getCsOrderUnauthorizedTotalStrategy

protected CsOrderUnauthorizedTotalStrategy getCsOrderUnauthorizedTotalStrategy()

setCsOrderUnauthorizedTotalStrategy

public void setCsOrderUnauthorizedTotalStrategy(CsOrderUnauthorizedTotalStrategy csOrderUnauthorizedTotalStrategy)

getCardValidator

protected CardValidator getCardValidator()

setCardValidator

public void setCardValidator(CardValidator cardValidator)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getSupportedCardSchemes

public java.util.List<CreditCardType> getSupportedCardSchemes(AbstractOrderModel order)

Description copied from interface: CsCardPaymentService

Get the list of available card types for the specified cart or order.

Specified by:

getSupportedCardSchemes in interface CsCardPaymentService

Parameters:

order - the cart or order

Returns:

the list of credit card types that are supported

getPreviousCreditCardPaymentInfos

public java.util.List<CreditCardPaymentInfoModel> getPreviousCreditCardPaymentInfos(UserModel user)

Description copied from interface: CsCardPaymentService

Get previously used payment infos for the specified user. These will be used to pre-populate the card payment form.

Specified by:

getPreviousCreditCardPaymentInfos in interface CsCardPaymentService

Parameters:

user - the user

Returns:

previous payment infos

generatePaymentInfoKey

protected java.lang.String generatePaymentInfoKey(CreditCardPaymentInfoModel paymentInfo)

authoriseCardPayment

public PaymentTransactionEntryModel authoriseCardPayment(AbstractOrderModel order,
                                                         CardInfo cardInfo,
                                                         double amount)
                                                  throws PaymentException,
                                                         ValidationException

Description copied from interface: CsCardPaymentService

Authorise payment for the cart or order.

Specified by:

authoriseCardPayment in interface CsCardPaymentService

Parameters:

order - the cart or order

cardInfo - the payment card data

amount - the amount to authorise

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid

cleanupCardNumber

protected java.lang.String cleanupCardNumber(java.lang.String cardNumber)

Cleanup the card number. Retain only the numbers from the card number string.

Parameters:

cardNumber - the inputted card number

Returns:

the cleaned card number

validate

public void validate(AbstractOrderModel order,
                     CardInfo cardInfo,
                     double amount)
              throws ValidationException

Validate the order, cardInfo and amount. Throw a ValidationException if a payment cannot be processed. The implementation calls validateCardInfo(de.hybris.platform.core.model.order.AbstractOrderModel, de.hybris.platform.payment.dto.CardInfo, java.util.List) , validateBillingInfo(de.hybris.platform.core.model.order.AbstractOrderModel, de.hybris.platform.payment.dto.CardInfo, java.util.List) , and validateAmount(de.hybris.platform.core.model.order.AbstractOrderModel, double, java.util.List).

Specified by:

validate in interface CsCardPaymentService

Parameters:

order - the order

cardInfo - the cardInfo

amount - the amount

Throws:

ValidationException - thrown on error.

validateCardInfo

protected void validateCardInfo(AbstractOrderModel order,
                                CardInfo cardInfo,
                                java.util.List<ResourceMessage> errorMessages)

Validate the cardInfo. The default implementation is to call the injected card validator.

Parameters:

order - The order

cardInfo - The cardInfo

errorMessages - list to append error messages to

validateBillingInfo

protected void validateBillingInfo(AbstractOrderModel order,
                                   CardInfo cardInfo,
                                   java.util.List<ResourceMessage> errorMessages)

Validate the the billing info in the cardInfo. The default implementation is to validate that all of the following fields are not blank: firstName, lastName, street1, city, country, postalCode, and email. If the country is set to us then the state field is also validated to be not blank.

Parameters:

order - The order

cardInfo - The cardInfo

errorMessages - list to append error messages to

validateAmount

protected void validateAmount(AbstractOrderModel order,
                              double amount,
                              java.util.List<ResourceMessage> errorMessages)

Validate that the amount it valid. Default implementation validates that the payment amount is greater than zero and is also less than or equal to the unauthorized total from the injected CsOrderUnauthorizedTotalStrategy.

Parameters:

order - The order

amount - The amount

errorMessages - list to append error messages to

generatePreAuthTransactionCode

protected java.lang.String generatePreAuthTransactionCode(AbstractOrderModel order)

preAuth

protected PaymentTransactionEntryModel preAuth(AbstractOrderModel order,
                                               CardInfo cardInfo,
                                               double amount)
                                        throws PaymentException

Throws:

PaymentException

getPaymentDeliveryAddress

protected AddressModel getPaymentDeliveryAddress(AbstractOrderModel order)