Package com.broadleafcommerce.paymenttransaction.service

Class DefaultTransactionExecutionRequestValidator

java.lang.Object

com.broadleafcommerce.paymenttransaction.service.DefaultTransactionExecutionRequestValidator

All Implemented Interfaces:

TransactionExecutionRequestValidator

public class DefaultTransactionExecutionRequestValidator
extends Object
implements TransactionExecutionRequestValidator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DETACHED_CREDIT_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_THE_PARENT_TRANSACTION_AMOUNT
static final String	TRANSACTION_AMOUNT_MUST_BE_EQUAL_TO_AVAILABLE
static final String	TRANSACTION_AMOUNT_MUST_BE_POSITIVE
static final String	TRANSACTION_AMOUNT_MUST_BE_VALID_FOR_PAYMENT
static final String	TRANSACTION_CURRENCY_MUST_MATCH_PAYMENT_CURRENCY
static final String	TRANSACTION_SOURCE_ENTITY_ID_REQUIRED
static final String	TRANSACTION_SOURCE_ENTITY_TYPE_REQUIRED
static final String	TRANSACTION_SOURCE_REQUIRED

Constructor Summary

Constructors

Constructor	Description
DefaultTransactionExecutionRequestValidator(PaymentTransactionService<PaymentTransaction> paymentTransactionService, PaymentSummaryService paymentSummaryService, TransactionExecutionUtil transactionExecutionUtil)

Method Summary

Modifier and Type	Method	Description
protected String	buildInvalidParentTransactionTypeMessage(@NonNull String transactionType, @NonNull PaymentTransaction parentTransaction, @NonNull String... expectedParentTransactionTypes)
protected boolean	canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest request, Payment payment)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest, PaymentSummary)
protected boolean	canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest request, PaymentSummary paymentSummary)	Determines if the transaction amount can be less than the available amount.
protected javax.money.MonetaryAmount	getAmountAvailableForTransactionType(@NonNull Payment payment, @NonNull String transactionType)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of getAmountAvailableForTransactionType(PaymentSummary, String)
protected javax.money.MonetaryAmount	getAmountAvailableForTransactionType(@NonNull PaymentSummary paymentSummary, @NonNull String transactionType)
protected PaymentSummaryService	getPaymentSummaryService()
protected PaymentTransactionService<PaymentTransaction>	getPaymentTransactionService()
protected TransactionExecutionUtil	getTransactionExecutionUtil()
void	validate(@NonNull TransactionExecutionRequest request, @NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Checks whether or not the TransactionExecutionRequest is valid.
protected void	validateParentTransaction(@NonNull TransactionExecutionRequest request, @NonNull Payment payment)
protected void	validateParentTransactionAmounts(List<TransactionWithExecutableAmount> parentTransactionWithExecutableAmounts, @NonNull javax.money.MonetaryAmount transactionAmount)	Validates the total amount from parent transactions is sufficient for the given transactionAmount.
protected void	validateParentTransactionCurrency(PaymentTransaction parentTransaction, @NonNull javax.money.MonetaryAmount transactionAmount)
protected void	validateParentTransactionType(PaymentTransaction parentTransaction, @NonNull String transactionType)
protected void	validateSource(@NonNull TransactionExecutionRequest request, @NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	validateTransactionAmount(@NonNull TransactionExecutionRequest request, @NonNull Payment payment)
protected void	validateTransactionType(@NonNull TransactionExecutionRequest request, @NonNull Payment payment, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Field Details

TRANSACTION_AMOUNT_MUST_BE_POSITIVE

public static final String TRANSACTION_AMOUNT_MUST_BE_POSITIVE

See Also:

• Constant Field Values

TRANSACTION_CURRENCY_MUST_MATCH_PAYMENT_CURRENCY

public static final String TRANSACTION_CURRENCY_MUST_MATCH_PAYMENT_CURRENCY

See Also:

• Constant Field Values

TRANSACTION_AMOUNT_MUST_BE_VALID_FOR_PAYMENT

public static final String TRANSACTION_AMOUNT_MUST_BE_VALID_FOR_PAYMENT

See Also:

• Constant Field Values

TRANSACTION_AMOUNT_MUST_BE_EQUAL_TO_AVAILABLE

public static final String TRANSACTION_AMOUNT_MUST_BE_EQUAL_TO_AVAILABLE

See Also:

• Constant Field Values

TRANSACTION_SOURCE_REQUIRED

public static final String TRANSACTION_SOURCE_REQUIRED

See Also:

• Constant Field Values

TRANSACTION_SOURCE_ENTITY_TYPE_REQUIRED

public static final String TRANSACTION_SOURCE_ENTITY_TYPE_REQUIRED

See Also:

• Constant Field Values

TRANSACTION_SOURCE_ENTITY_ID_REQUIRED

public static final String TRANSACTION_SOURCE_ENTITY_ID_REQUIRED

See Also:

• Constant Field Values

DETACHED_CREDIT_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_THE_PARENT_TRANSACTION_AMOUNT

public static final String DETACHED_CREDIT_AMOUNT_MUST_BE_LESS_THAN_OR_EQUAL_TO_THE_PARENT_TRANSACTION_AMOUNT

See Also:

• Constant Field Values

Constructor Details

DefaultTransactionExecutionRequestValidator

public DefaultTransactionExecutionRequestValidator(PaymentTransactionService<PaymentTransaction> paymentTransactionService,
 PaymentSummaryService paymentSummaryService,
 TransactionExecutionUtil transactionExecutionUtil)

Method Details

validate

public void validate(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: TransactionExecutionRequestValidator

Checks whether or not the TransactionExecutionRequest is valid.

Specified by:

validate in interface TransactionExecutionRequestValidator

Parameters:

request - The TransactionExecutionRequest to be checked.

payment - The related Payment that the request will act against.

contextInfo - Context information related to multitenancy.

validateTransactionType

protected void validateTransactionType(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

validateTransactionAmount

protected void validateTransactionAmount(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull Payment payment)

getAmountAvailableForTransactionType

@Deprecated(forRemoval=true)
protected javax.money.MonetaryAmount getAmountAvailableForTransactionType(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull String transactionType)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of getAmountAvailableForTransactionType(PaymentSummary, String)

getAmountAvailableForTransactionType

protected javax.money.MonetaryAmount getAmountAvailableForTransactionType(@NonNull
 @NonNull PaymentSummary paymentSummary,
 @NonNull
 @NonNull String transactionType)

canTransactionAmountBeLessThanAvailableAmount

@Deprecated(forRemoval=true)
protected boolean canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest request,
 Payment payment)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest, PaymentSummary)

Determines if the transaction amount can be less than the available amount.

Parameters:

request - the TransactionExecutionRequest being validated

payment - the Payment being executed against

Returns:

true if the transaction can be less than the available amount, otherwise false

canTransactionAmountBeLessThanAvailableAmount

protected boolean canTransactionAmountBeLessThanAvailableAmount(TransactionExecutionRequest request,
 PaymentSummary paymentSummary)

Determines if the transaction amount can be less than the available amount.

Parameters:

request - the TransactionExecutionRequest being validated

paymentSummary - the PaymentSummary being executed against

Returns:

true if the transaction can be less than the available amount, otherwise false

validateParentTransaction

protected void validateParentTransaction(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull Payment payment)

validateParentTransactionType

protected void validateParentTransactionType(PaymentTransaction parentTransaction,
 @NonNull
 @NonNull String transactionType)

validateParentTransactionAmounts

protected void validateParentTransactionAmounts(List<TransactionWithExecutableAmount> parentTransactionWithExecutableAmounts,
 @NonNull
 @NonNull javax.money.MonetaryAmount transactionAmount)

Validates the total amount from parent transactions is sufficient for the given transactionAmount.

Parameters:

parentTransactionWithExecutableAmounts - A list of TransactionWithExecutableAmounts representing all the parent transactions.

transactionAmount - The amount to validate

See Also:

• TransactionExecutionUtil.getParentTransactionWithExecutableAmounts(Payment, TransactionExecutionRequest)

validateParentTransactionCurrency

protected void validateParentTransactionCurrency(PaymentTransaction parentTransaction,
 @NonNull
 @NonNull javax.money.MonetaryAmount transactionAmount)

buildInvalidParentTransactionTypeMessage

protected String buildInvalidParentTransactionTypeMessage(@NonNull
 @NonNull String transactionType,
 @NonNull
 @NonNull PaymentTransaction parentTransaction,
 @NonNull
 @NonNull String... expectedParentTransactionTypes)

validateSource

protected void validateSource(@NonNull
 @NonNull TransactionExecutionRequest request,
 @NonNull
 @NonNull Payment payment,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getPaymentTransactionService

protected PaymentTransactionService<PaymentTransaction> getPaymentTransactionService()

getPaymentSummaryService

protected PaymentSummaryService getPaymentSummaryService()

getTransactionExecutionUtil

protected TransactionExecutionUtil getTransactionExecutionUtil()