Uses of Class
com.broadleafcommerce.paymenttransaction.domain.CustomerRef

Packages that use CustomerRef

Package	Description
com.broadleafcommerce.paymenttransaction.domain
com.broadleafcommerce.paymenttransaction.service
com.broadleafcommerce.paymenttransaction.service.anonymization
com.broadleafcommerce.paymenttransaction.service.messaging.checkoutcompletion
com.broadleafcommerce.paymenttransaction.service.provider.external.domain
com.broadleafcommerce.paymenttransaction.service.validation
com.broadleafcommerce.paymenttransaction.web.endpoint

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.domain

Methods in com.broadleafcommerce.paymenttransaction.domain that return CustomerRef

Modifier and Type	Method	Description
CustomerRef	Payment.getCustomerRef()	Deprecated. since 1.0.2, use Payment.getOwningUserType() and Payment.getOwningUserId() instead

Methods in com.broadleafcommerce.paymenttransaction.domain with parameters of type CustomerRef

Modifier and Type	Method	Description
void	Payment.setCustomerRef(CustomerRef customerRef)	Deprecated. since 1.0.2, use Payment.getOwningUserType() and Payment.getOwningUserId() instead

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.service

Methods in com.broadleafcommerce.paymenttransaction.service with parameters of type CustomerRef

Modifier and Type	Method	Description
protected void	DefaultPaymentManagementService.archiveExistingPaymentsIfNeeded(@NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Archives the owning entity's existing payments if the CreatePaymentRequest.isShouldArchiveExistingPayments() is "true" and DefaultPaymentManagementService.shouldArchiveExistingPayment(P, com.broadleafcommerce.paymenttransaction.web.endpoint.domain.CreatePaymentRequest, com.broadleafcommerce.paymenttransaction.domain.CustomerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo) returns true.
protected P	DefaultPaymentManagementService.buildPayment(@NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
P	DefaultPaymentManagementService.createPayment(@NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
P	PaymentManagementService.createPayment(CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates a Payment based on the provided CreatePaymentRequest.
protected P	DefaultPaymentManagementService.populatePaymentFromRequest(P payment, @NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected P	DefaultPaymentManagementService.populatePaymentFromSavedPayment(P payment, @NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of DefaultPaymentManagementService.populatePaymentFromSavedPayment(Payment, String, ContextInfo)
protected void	DefaultPaymentManagementService.populatePaymentOwningUser(P payment, @NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef)	Populates the properties describing the owning user of the given Payment.
protected boolean	DefaultPaymentManagementService.shouldArchiveExistingPayment(P payment, @NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Declares if the existing Payment should be archived based on CreatePaymentRequest.isShouldArchiveExistingPayments() & CreatePaymentRequest.getGatewayTypesToArchive(), as well as mutability validations.

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.service.anonymization

Methods in com.broadleafcommerce.paymenttransaction.service.anonymization with parameters of type CustomerRef

Modifier and Type	Method	Description
protected List<com.broadleafcommerce.common.privacy.anonymization.AnonymizationRecord>	AbstractAnonymizationHandler.process(@NonNull String boundedContextIdentifier, CustomerRef customerRef, @NonNull String type, @NonNull String fieldName)	Process a CustomerRef instance

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.service.messaging.checkoutcompletion

Methods in com.broadleafcommerce.paymenttransaction.service.messaging.checkoutcompletion that return CustomerRef

Modifier and Type	Method	Description
protected CustomerRef	PaymentCheckoutCompletionListener.getCustomerRef(com.jayway.jsonpath.DocumentContext jsonContext)
CustomerRef	PaymentPostCheckoutCompletionEvent.getCustomerRef()	The reference to the customer who owns the cart and payments of this event.

Methods in com.broadleafcommerce.paymenttransaction.service.messaging.checkoutcompletion with parameters of type CustomerRef

Modifier and Type	Method	Description
void	PaymentPostCheckoutCompletionEvent.setCustomerRef(CustomerRef customerRef)	The reference to the customer who owns the cart and payments of this event.

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.service.provider.external.domain

Methods in com.broadleafcommerce.paymenttransaction.service.provider.external.domain that return CustomerRef

Modifier and Type	Method	Description
CustomerRef	PaymentAccountSummary.getCustomerRef()	Deprecated, for removal: This API element is subject to removal in a future version. The customer associated with this payment account.

Methods in com.broadleafcommerce.paymenttransaction.service.provider.external.domain with parameters of type CustomerRef

Modifier and Type	Method	Description
void	PaymentAccountSummary.setCustomerRef(CustomerRef customerRef)	Deprecated, for removal: This API element is subject to removal in a future version. The customer associated with this payment account.

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.service.validation

Methods in com.broadleafcommerce.paymenttransaction.service.validation with parameters of type CustomerRef

Modifier and Type	Method	Description
protected boolean	DefaultPaymentAccessValidationService.customerMatches(@NonNull Payment payment, @NonNull CustomerRef customer)	Validates if the owning user of the Payment matches the given CustomerRef.
boolean	DefaultPaymentAccessValidationService.shouldAllowExistingPaymentArchival(@NonNull CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, @NonNull Payment existingPayment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
default boolean	PaymentAccessValidationService.shouldAllowExistingPaymentArchival(CreatePaymentRequest createPaymentRequest, CustomerRef customerRef, Payment existingPayment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	When CreatePaymentRequest.isShouldArchiveExistingPayments() is set to true, this method can be called to verify whether a found candidate existing payment can be archived.
protected boolean	DefaultPaymentAccessValidationService.shouldSkipPaymentTTLValidation(@NonNull Payment payment, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected boolean	DefaultPaymentAccessValidationService.validateAccessForAnonymousOwnedPayment(@NonNull Payment payment, @NonNull CustomerRef customerRef)	Validates access for anonymous owned Payment for the given CustomerRef, which checks against the Payment.getOwningUserEmailAddress() and getUsername() by default.
void	DefaultPaymentAccessValidationService.validateCustomerPaymentRequest(@NonNull Payment payment, @NonNull CustomerRef customerRef, @NonNull UpdatePaymentRequest updatePaymentRequest, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	DefaultPaymentAccessValidationService.validateCustomerPaymentRequest(@NonNull Payment payment, @NonNull CustomerRef customerRef, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
default void	PaymentAccessValidationService.validateCustomerPaymentRequest(Payment payment, CustomerRef customerRef, UpdatePaymentRequest updatePaymentRequest, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates access to the payment based on the passed in context.
void	PaymentAccessValidationService.validateCustomerPaymentRequest(Payment payment, CustomerRef customerRef, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates access to the payment based on the passed in context
protected void	DefaultPaymentAccessValidationService.validatePaymentCustomerRef(@NonNull Payment payment, @NonNull CustomerRef customerRef, String lockToken, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	DefaultSavedPaymentMethodAccessValidationService.validateSavedPaymentMethodOwnership(@NonNull String savedPaymentId, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	SavedPaymentMethodAccessValidationService.validateSavedPaymentMethodOwnership(@NonNull String savedPaymentId, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates access to the saved payment method based on the passed in context.

Uses of CustomerRef in com.broadleafcommerce.paymenttransaction.web.endpoint

Methods in com.broadleafcommerce.paymenttransaction.web.endpoint with parameters of type CustomerRef

Modifier and Type	Method	Description
void	AccountPaymentManagementEndpoint.archivePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, Integer paymentVersion, CustomerRef customerRef)
void	CustomerPaymentManagementEndpoint.archivePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, Integer paymentVersion, CustomerRef customerRef)
PaymentSummary	AccountPaymentManagementEndpoint.createPayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CreatePaymentRequest createPaymentRequest, CustomerRef customerRef)
PaymentSummary	CustomerPaymentManagementEndpoint.createPayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, CreatePaymentRequest createPaymentRequest, CustomerRef customerRef)
SavedPaymentMethodSummary	CustomerSavedPaymentMethodManagementEndpoint.createSavedPaymentMethod(String customerId, CreateSavedPaymentMethodRequest createRequest, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<PaymentSummary>	AccountPaymentManagementEndpoint.readAllPaymentsForOwner(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String ownerType, String ownerId, CustomerRef customerRef, org.springframework.data.domain.Pageable page)
org.springframework.data.domain.Page<PaymentSummary>	CustomerPaymentManagementEndpoint.readAllPaymentsForOwner(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String ownerType, String ownerId, CustomerRef customerRef, org.springframework.data.domain.Pageable page)
PaymentSummary	TransactionExecutionEndpoint.recordTransactionResults(String paymentId, Map<String,Object> transactionResults, Integer paymentVersion, CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<PaymentSummary>	AccountPaymentManagementEndpoint.updatePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, UpdatePaymentRequest req, Integer paymentVersion, CustomerRef customerRef)
org.springframework.http.ResponseEntity<PaymentSummary>	CustomerPaymentManagementEndpoint.updatePayment(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String paymentId, UpdatePaymentRequest req, Integer paymentVersion, CustomerRef customerRef)
protected org.springframework.data.domain.Page<Payment>	AccountPaymentManagementEndpoint.validateAccountPaymentReadAllRequest(@NonNull org.springframework.data.domain.Page<Payment> payments, @NonNull CustomerRef customerRef, @NonNull org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected org.springframework.data.domain.Page<Payment>	CustomerPaymentManagementEndpoint.validateCustomerPaymentReadAllRequest(@NonNull org.springframework.data.domain.Page<Payment> payments, @NonNull CustomerRef customerRef, @NonNull org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected boolean	CustomerPaymentManagementEndpoint.validateCustomerPaymentRequest(@NonNull Payment payment, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the given CustomerRef's access to the given Payment.
protected boolean	AccountPaymentManagementEndpoint.validatePaymentAccess(@NonNull Payment payment, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the given CustomerRef's access to the given Payment.
protected void	AccountPaymentManagementEndpoint.validateSavedPaymentMethodIfNecessary(@NonNull CreatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given CreatePaymentRequest and CustomerRef if the saved payment method id is specified.
protected void	AccountPaymentManagementEndpoint.validateSavedPaymentMethodIfNecessary(@NonNull UpdatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given UpdatePaymentRequest and CustomerRef if the saved payment method id is specified.
protected void	CustomerPaymentManagementEndpoint.validateSavedPaymentMethodIfNecessary(@NonNull CreatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given CreatePaymentRequest and CustomerRef if the saved payment method id is specified.
protected void	CustomerPaymentManagementEndpoint.validateSavedPaymentMethodIfNecessary(@NonNull UpdatePaymentRequest req, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the saved payment method ownership for the given UpdatePaymentRequest and CustomerRef if the saved payment method id is specified.