Package com.broadleafcommerce.paymenttransaction.service.validation

Interface PaymentAccessValidationService

All Known Implementing Classes:

DefaultPaymentAccessValidationService

public interface PaymentAccessValidationService

Validates access to the payment based on passed in context.

Method Summary

Modifier and Type	Method	Description
default boolean	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.
void	validateCreatePaymentAllowed(CreatePaymentRequest createPaymentRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates if payment can be created.
default void	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	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

Method Details

validateCustomerPaymentRequest

void validateCustomerPaymentRequest(Payment payment,
 CustomerRef customerRef,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Validates access to the payment based on the passed in context

Parameters:

payment - the Payment requiring access

customerRef - the CustomerRef to validate against

lockToken - the current lock token

context - context information surrounding multitenant state

Throws:

PaymentManagementAccessException - if the request is blocked

validateCustomerPaymentRequest

default void validateCustomerPaymentRequest(Payment payment,
 CustomerRef customerRef,
 UpdatePaymentRequest updatePaymentRequest,
 @Nullable
 String lockToken,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Validates access to the payment based on the passed in context. In the case of a Payment update request, the details of the UpdatePaymentRequest can be factored into determining if the customer's request should be allowed or blocked

Parameters:

payment - the Payment requiring access

customerRef - the CustomerRef to validate against

updatePaymentRequest - the request payload related to an update request (only present for update requests)

lockToken - the current lock token

context - context information surrounding multitenant state

Throws:

PaymentManagementAccessException - if the request is blocked

shouldAllowExistingPaymentArchival

default boolean shouldAllowExistingPaymentArchival(CreatePaymentRequest createPaymentRequest,
 @Nullable
 CustomerRef customerRef,
 Payment existingPayment,
 @Nullable
 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. Typically, this should reject based on the same conditions in validateCustomerPaymentRequest(Payment, CustomerRef, String, ContextInfo).

Parameters:

createPaymentRequest - a CreatePaymentRequest which has requested archival of existing payments via CreatePaymentRequest.isShouldArchiveExistingPayments()

customerRef - the CustomerRef that is attempting to create the payment with archival of existing payments. Will be null if this is a system-initiated operation.

existingPayment - an existing payment that was found and is being considered for archival

contextInfo - context information surrounding multitenant state

Returns:

true if the existing payment can be archived, false otherwise

validateCreatePaymentAllowed

void validateCreatePaymentAllowed(CreatePaymentRequest createPaymentRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Validates if payment can be created. When PaymentValidationProperties.getCustomerMutabilityBlockedCreateCheck() contains an entry with Boolean.TRUE for CreatePaymentRequest.getOwnerType() and there is already a payment matching CreatePaymentRequest.getOwnerType() and CreatePaymentRequest.getOwnerId() with Payment.getAccessRestrictions() containing DefaultPaymentManagementAccessRestrictions.CUSTOMER_MUTABILITY_BLOCKED then validation fails.

Parameters:

createPaymentRequest - a request to create the Payment

context - context information surrounding multitenant state

Throws:

PaymentManagementAccessException - if the request is blocked

Since:

Payment Transaction Service 2.0.9, Release Train 2.2.2, Payment Transaction Service 2.0.9, Release Train 2.1.6