Package com.broadleafcommerce.cartoperation.web.endpoint

Class CheckoutEventsEndpoint

java.lang.Object

com.broadleafcommerce.cartoperation.web.endpoint.CheckoutEventsEndpoint

@FrameworkRestController
@FrameworkMapping("/carts/{cartId}")
@DataRouteByKey("cartoperation")
public class CheckoutEventsEndpoint
extends Object

Endpoints for resending events.

These endpoints are helpful to manually recover from scenarios where a process was completed but encountered an error when sending the corresponding event. For example, if a cart was finalized during the checkout flow but failed to send the checkout completion event, these endpoints can help manually recover.

Author:

Sunny Yu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CheckoutEventsEndpoint(CheckoutService checkoutService)

Method Summary

Modifier and Type	Method	Description
protected CheckoutService	getCheckoutService()
protected org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	handleSendEventResponse(SendCheckoutEventResponse response)
org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	resendCartAwaitingPaymentResultsEvent(String cartId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	resendCartPendingPaymentFailedEvent(String cartId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	resendCheckoutCompletionEvent(String cartId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	resendCheckoutRollbackEvent(String cartId, String requestId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<SendCheckoutEventResponse>	resendExternalPaymentTransactionCartFinalizationEvent(String cartId, String requestId, 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

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

CheckoutEventsEndpoint

public CheckoutEventsEndpoint(CheckoutService checkoutService)

Method Details

resendCheckoutCompletionEvent

@Policy(permissionRoots="SEND_CHECKOUT_COMPLETION_EVENT")
@FrameworkPostMapping("/resend-checkout-completion-event")
public org.springframework.http.ResponseEntity<SendCheckoutEventResponse> resendCheckoutCompletionEvent(@PathVariable
 String cartId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resendCheckoutRollbackEvent

@Policy(permissionRoots="SEND_ROLLBACK_EVENT")
@FrameworkPostMapping("/resend-checkout-rollback-event")
public org.springframework.http.ResponseEntity<SendCheckoutEventResponse> resendCheckoutRollbackEvent(@PathVariable
 String cartId,
 @RequestParam
 String requestId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resendCartAwaitingPaymentResultsEvent

@Policy(permissionRoots="SEND_CART_AWAITING_PAYMENT_RESULTS_EVENT")
@FrameworkPostMapping("/resend-cart-awaiting-payment-result-event")
public org.springframework.http.ResponseEntity<SendCheckoutEventResponse> resendCartAwaitingPaymentResultsEvent(@PathVariable
 String cartId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resendCartPendingPaymentFailedEvent

@Policy(permissionRoots="SEND_CART_PENDING_PAYMENT_FAILED_EVENT")
@FrameworkPostMapping("/resend-pending-payment-failed-event")
public org.springframework.http.ResponseEntity<SendCheckoutEventResponse> resendCartPendingPaymentFailedEvent(@PathVariable
 String cartId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resendExternalPaymentTransactionCartFinalizationEvent

@Policy(permissionRoots="SEND_EXTERNAL_PAYMENT_TRANSACTION_CART_FINALIZATION_EVENT")
@FrameworkPostMapping("/resend-external-payment-transaction-cart-finalization-event")
public org.springframework.http.ResponseEntity<SendCheckoutEventResponse> resendExternalPaymentTransactionCartFinalizationEvent(@PathVariable
 String cartId,
 @RequestParam
 String requestId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

handleSendEventResponse

protected org.springframework.http.ResponseEntity<SendCheckoutEventResponse> handleSendEventResponse(SendCheckoutEventResponse response)

getCheckoutService

protected CheckoutService getCheckoutService()