Package com.broadleafcommerce.paymenttransaction.web.endpoint

Class SavedPaymentMethodTransactionExecutionEndpoint

java.lang.Object

com.broadleafcommerce.paymenttransaction.web.endpoint.SavedPaymentMethodTransactionExecutionEndpoint

@FrameworkRestController
@FrameworkMapping("/saved-payment-methods")
@DataRouteByKey("paymentTransaction")
@ConditionalOnPaymentTransactionAsSavedPaymentStorageLocation
public class SavedPaymentMethodTransactionExecutionEndpoint
extends Object

Since:

PaymentTransactionServices 2.1.0, Release Train 2.3.0

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor

Description

SavedPaymentMethodTransactionExecutionEndpoint(SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService, PaymentManagementService<Payment> paymentManagementService, TransactionExecutionService transactionExecutionService, TransactionExecutionUtil transactionExecutionUtil, PaymentService<Payment> paymentService, PaymentTransactionService<PaymentTransaction> paymentTransactionService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CreatePaymentRequest	buildCreatePaymentRequest(SavedPaymentMethodTransactionExecutionRequest request, SavedPaymentMethod savedPaymentMethod, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected boolean	canRetryIndeterminantResultTransaction(@NonNull Payment payment, @NonNull SavedPaymentMethodTransactionExecutionRequest request)
TransactionExecutionResponse	executeAuthorize(String savedPaymentMethodId, SavedPaymentMethodTransactionExecutionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
TransactionExecutionResponse	executeAuthorizeAndCapture(String savedPaymentMethodId, SavedPaymentMethodTransactionExecutionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected PaymentManagementService<Payment>	getPaymentManagementService()
protected PaymentService<Payment>	getPaymentService()
protected PaymentTransactionService<PaymentTransaction>	getPaymentTransactionService()
protected SavedPaymentMethodService<SavedPaymentMethod>	getSavedPaymentMethodService()
protected TransactionExecutionService	getTransactionExecutionService()
protected TransactionExecutionUtil	getTransactionExecutionUtil()
protected TransactionResultService	getTransactionResultService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
TransactionExecutionResponse	lookupSavedPaymentMethodTransactionResult(String savedPaymentMethodId, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected boolean	requestMatchesPayment(@NonNull Payment payment, @NonNull SavedPaymentMethodTransactionExecutionRequest request)
void	setTransactionResultService(TransactionResultService transactionResultService)
protected Payment	validateRequestAndCreatePayment(@NonNull String savedPaymentMethodId, @NonNull SavedPaymentMethodTransactionExecutionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates that the provided SavedPaymentMethodTransactionExecutionRequest aligns with the identified SavedPaymentMethod, & if so, creates a Payment based on the request & the saved payment method.
protected void	validateSavedPaymentMethodTransactionExecutionRequest(@NonNull SavedPaymentMethodTransactionExecutionRequest request, @NonNull SavedPaymentMethod savedPaymentMethod, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

SavedPaymentMethodTransactionExecutionEndpoint

public SavedPaymentMethodTransactionExecutionEndpoint(SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService,
 PaymentManagementService<Payment> paymentManagementService,
 TransactionExecutionService transactionExecutionService,
 TransactionExecutionUtil transactionExecutionUtil,
 PaymentService<Payment> paymentService,
 PaymentTransactionService<PaymentTransaction> paymentTransactionService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

executeAuthorize

@FrameworkPostMapping(value="/{id}/authorize",
                      consumes="application/json")
@Policy(permissionRoots="SAVED_PAYMENT_METHOD_EXECUTE_AUTHORIZE")
public TransactionExecutionResponse executeAuthorize(@PathVariable("id")
 String savedPaymentMethodId,
 @RequestBody
 SavedPaymentMethodTransactionExecutionRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

executeAuthorizeAndCapture

@FrameworkPostMapping(value="/{id}/authorize-and-capture",
                      consumes="application/json")
@Policy(permissionRoots="SAVED_PAYMENT_METHOD_EXECUTE_AUTHORIZE_AND_CAPTURE")
public TransactionExecutionResponse executeAuthorizeAndCapture(@PathVariable("id")
 String savedPaymentMethodId,
 @RequestBody
 SavedPaymentMethodTransactionExecutionRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

lookupSavedPaymentMethodTransactionResult

@FrameworkGetMapping("/{id}/transactions/{requestId}")
@Policy(permissionRoots="SAVED_PAYMENT_METHOD_TRANSACTION_RESULTS")
public TransactionExecutionResponse lookupSavedPaymentMethodTransactionResult(@PathVariable("id")
 String savedPaymentMethodId,
 @PathVariable("requestId")
 String requestId,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

validateRequestAndCreatePayment

protected Payment validateRequestAndCreatePayment(@NonNull
 @NonNull String savedPaymentMethodId,
 @NonNull
 @NonNull SavedPaymentMethodTransactionExecutionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
                                           throws org.springframework.dao.DataIntegrityViolationException

Validates that the provided SavedPaymentMethodTransactionExecutionRequest aligns with the identified SavedPaymentMethod, & if so, creates a Payment based on the request & the saved payment method.

Parameters:

savedPaymentMethodId - The id of the SavedPaymentMethod that is to be used to define the Payment

request - The SavedPaymentMethodTransactionExecutionRequest used to define the Payment

context - context information around the multi-tenant state

Returns:

a Payment based on the request & saved payment method

Throws:

org.springframework.dao.DataIntegrityViolationException - if there is already a Payment present with the same Payment.getSavedPaymentMethodId() and Payment.getRequestId(). In other words, the same request to charge the saved payment method has already been made.

validateSavedPaymentMethodTransactionExecutionRequest

protected void validateSavedPaymentMethodTransactionExecutionRequest(@NonNull
 @NonNull SavedPaymentMethodTransactionExecutionRequest request,
 @NonNull
 @NonNull SavedPaymentMethod savedPaymentMethod,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

buildCreatePaymentRequest

protected CreatePaymentRequest buildCreatePaymentRequest(SavedPaymentMethodTransactionExecutionRequest request,
 SavedPaymentMethod savedPaymentMethod,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

canRetryIndeterminantResultTransaction

protected boolean canRetryIndeterminantResultTransaction(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull SavedPaymentMethodTransactionExecutionRequest request)

requestMatchesPayment

protected boolean requestMatchesPayment(@NonNull
 @NonNull Payment payment,
 @NonNull
 @NonNull SavedPaymentMethodTransactionExecutionRequest request)

getSavedPaymentMethodService

protected SavedPaymentMethodService<SavedPaymentMethod> getSavedPaymentMethodService()

getPaymentManagementService

protected PaymentManagementService<Payment> getPaymentManagementService()

getTransactionExecutionService

protected TransactionExecutionService getTransactionExecutionService()

getTransactionExecutionUtil

protected TransactionExecutionUtil getTransactionExecutionUtil()

getPaymentService

protected PaymentService<Payment> getPaymentService()

getPaymentTransactionService

protected PaymentTransactionService<PaymentTransaction> getPaymentTransactionService()

setTransactionResultService

@Autowired
public void setTransactionResultService(TransactionResultService transactionResultService)

getTransactionResultService

protected TransactionResultService getTransactionResultService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()