org.broadleafcommerce.core.payment.domain.secure

Interface Referenced

All Superinterfaces:

Serializable

All Known Subinterfaces:

BankAccountPayment, CreditCardPayment, GiftCardPayment

All Known Implementing Classes:

BankAccountPaymentImpl, CreditCardPaymentInfoImpl, GiftCardPaymentImpl

public interface Referenced
extends Serializable

The main interface used to store extra-secure data such as credit card, bank accounts and gift card data. All entities that implement this interface should be stored in a completely separate database under strict PCI compliance. Broadleaf provides the ability for this in the blSecurePU persistence unit, which all implementing entities are members of.

Entities that implement this Referenced interface should not be instantiated directly but rather be instaniated via SecureOrderPaymentService#create(org.broadleafcommerce.core.payment.service.type.PaymentType)

In the common case, this is rarely used as most implementors will NOT want to deal with the liability and extra PCI requirements associated with storing sensitive payment data. Consider integrating with a payment provider that takes care of PCI-sensitive data instead.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

CreditCardPayment}, GiftCardPayment}, BankAccountPayment}

Method Summary

Modifier and Type	Method and Description
EncryptionModule	getEncryptionModule()
Long	getId()
String	getReferenceNumber() The indirect link between non-secure data and the secure data represented here.
void	setEncryptionModule(EncryptionModule encryptionModule) Sets the encryption module used by to encrypt and decrypt the data saved in the blSecurePU persistence unit.
void	setId(Long id)
void	setReferenceNumber(String referenceNumber) Set the link between this secure entity and the OrderPayment.

Method Detail

getId

Long getId()

setId

void setId(Long id)

getReferenceNumber

String getReferenceNumber()

The indirect link between non-secure data and the secure data represented here. Since implementing entities should be in a separate persistence unit (blSecurePU), this is the only avenue to show a relationship between the two.

From the Order side of the domain, this is linked by OrderPayment.getReferenceNumber() on the OrderPayment entity.

See Also:

OrderPayment#getReferenceNumber()}

setReferenceNumber

void setReferenceNumber(@Nonnull
                        String referenceNumber)

Set the link between this secure entity and the OrderPayment. This should not be null as this is required

Parameters:

referenceNumber -

getEncryptionModule

EncryptionModule getEncryptionModule()

Returns:

the EncryptionModule used to encrypt and decrypt this secure information back and forth

setEncryptionModule

void setEncryptionModule(EncryptionModule encryptionModule)

Sets the encryption module used by to encrypt and decrypt the data saved in the blSecurePU persistence unit. This normally corresponds to the blEncryptionModule Spring bean which should be automatically set after invoking SecureOrderPaymentService#findSecurePaymentInfo(String, org.broadleafcommerce.core.payment.service.type.PaymentType) and SecureOrderPaymentService#create(org.broadleafcommerce.core.payment.service.type.PaymentType).

See Also:

SecureOrderPaymentService#findSecurePaymentInfo(String, org.broadleafcommerce.core.payment.service.type.PaymentType)}, SecureOrderPaymentService#create(org.broadleafcommerce.core.payment.service.type.PaymentType)}