Package com.broadleafcommerce.cart.service.messaging

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 Type	Method	Description
void	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	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	sendRollbackEvent(CheckoutRollbackEvent event, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Sends rollback event to process the error during checkout.

Method Detail

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 payload

contextInfo - context information around sandbox and multitenant state

Throws:

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CheckoutRollbackEventProducer

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 payload

contextInfo - context information around sandbox and multitenant state

Throws:

InvalidCartStatusException - if the cart status is not DefaultCartStatuses.SUBMITTED

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CheckoutCompletionProducer

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 payload

contextInfo - context information around sandbox and multitenant state

Throws:

InvalidCartStatusException - if the cart status is not DefaultCartStatuses.REJECTED

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CartRejectionProducer

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 updated Cart

audit - The CartActionAudit for the update

contextInfo - context information around sandbox and multitenant state

Throws:

InvalidCartStatusException - if the cart status is not DefaultCartStatuses.REJECTED

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CartRejectionProducer

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 payload

contextInfo - context information around sandbox and multitenant state

Throws:

InvalidCartStatusException - if the cart status is not DefaultCartStatuses.REQUIRES_APPROVAL

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CartRejectionProducer

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 updated Cart

audit - The CartActionAudit for the update

contextInfo - context information around sandbox and multitenant state

Throws:

InvalidCartStatusException - if the cart status is not DefaultCartStatuses.REQUIRES_APPROVAL

SaveCartNotificationException - if the cart notification can not be saved

See Also:

CartApprovalRequestProducer

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 payload

contextInfo - context information around sandbox and multitenant state

See Also:

CartPendingPaymentFailedProducer