Interface CartNotificationService
- All Known Implementing Classes:
DefaultCartNotificationService
public interface CartNotificationService
The cart notification service is used to send the notification using durable messaging.
- Author:
- Dima Myroniuk (dmyroniuk)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
sendCartApprovalRequestEvent
(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.cart.client.domain.CartActionAudit audit, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart approval requested event.void
sendCartApprovalRequestEvent
(CartApprovalRequestEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart approval request event.void
sendCartAwaitingPaymentResultsEvent
(CartAwaitingPaymentResultsEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart awaiting payment results event.void
sendCartPendingPaymentFailedEventUri
(CartPendingPaymentFailedEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart pending payment failed event.void
sendCartRejectionEvent
(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.cart.client.domain.CartActionAudit audit, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart rejection event.void
sendCartRejectionEvent
(CartRejectionEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart rejection event.void
sendCheckoutCompletionEvent
(CheckoutCompletionEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends checkout completion event.void
sendExternalPaymentTransactionCartFinalizationEvent
(ExternalPaymentTransactionCartFinalizationEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) void
sendQuoteStatusUpdatedEvent
(com.broadleafcommerce.cart.client.domain.Cart quote, com.broadleafcommerce.cart.client.domain.CartActionAudit audit, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends quote status updated event.void
sendRollbackEvent
(CheckoutRollbackEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends rollback event to process the error during checkout.
-
Method Details
-
sendRollbackEvent
void sendRollbackEvent(CheckoutRollbackEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) throws SaveCartNotificationException Sends rollback event to process the error during checkout. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendCheckoutCompletionEvent
void sendCheckoutCompletionEvent(CheckoutCompletionEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) throws InvalidCartStatusException, SaveCartNotificationException Sends checkout completion event. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.SUBMITTED
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
CheckoutCompletionProducer
-
sendExternalPaymentTransactionCartFinalizationEvent
void sendExternalPaymentTransactionCartFinalizationEvent(ExternalPaymentTransactionCartFinalizationEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) - Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.SUBMITTED
SaveCartNotificationException
- if the cart notification can not be saved
-
sendCartRejectionEvent
void sendCartRejectionEvent(CartRejectionEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart rejection event. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.REJECTED
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendCartRejectionEvent
void sendCartRejectionEvent(com.broadleafcommerce.cart.client.domain.Cart cart, @Nullable com.broadleafcommerce.cart.client.domain.CartActionAudit audit, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart rejection event. It uses durable sending to guarantee delivery.- Parameters:
cart
- The updatedCart
audit
- TheCartActionAudit
for the updatecontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.REJECTED
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendCartApprovalRequestEvent
void sendCartApprovalRequestEvent(CartApprovalRequestEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart approval request event. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.REQUIRES_APPROVAL
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendCartApprovalRequestEvent
void sendCartApprovalRequestEvent(com.broadleafcommerce.cart.client.domain.Cart cart, @Nullable com.broadleafcommerce.cart.client.domain.CartActionAudit audit, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart approval requested event. It uses durable sending to guarantee delivery.- Parameters:
cart
- The updatedCart
audit
- TheCartActionAudit
for the updatecontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.REQUIRES_APPROVAL
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendCartPendingPaymentFailedEventUri
void sendCartPendingPaymentFailedEventUri(CartPendingPaymentFailedEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart pending payment failed event. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- See Also:
-
sendCartAwaitingPaymentResultsEvent
void sendCartAwaitingPaymentResultsEvent(CartAwaitingPaymentResultsEvent event, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends cart awaiting payment results event. It uses durable sending to guarantee delivery.- Parameters:
event
- the message payloadcontextInfo
- context information around sandbox and multitenant state- Throws:
InvalidCartStatusException
- if the cart status is notDefaultCartStatuses.SUBMITTED
SaveCartNotificationException
- if the cart notification can not be saved- See Also:
-
sendQuoteStatusUpdatedEvent
void sendQuoteStatusUpdatedEvent(com.broadleafcommerce.cart.client.domain.Cart quote, com.broadleafcommerce.cart.client.domain.CartActionAudit audit, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Sends quote status updated event.- Parameters:
quote
- the quote to send the notification foraudit
- The relatedCartActionAudit
contextInfo
- Additional sandbox and multitenant info
-