Package com.broadleafcommerce.paymenttransaction.service.messaging.savedpayment

Class CreateSavedPaymentMethodEventListener

java.lang.Object
com.broadleafcommerce.paymenttransaction.service.messaging.savedpayment.CreateSavedPaymentMethodEventListener
@DataRouteByKey("paymentTransaction") @Deprecated(since="1.0.2", forRemoval=true) public class CreateSavedPaymentMethodEventListener extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
since 1.0.2, The creation of saved payment methods as a portion of the checkout process is now handled via a post-transaction hook in TransactionExecutionService. Once a day or two have passed after adopting the upgrade, this listener can be disabled by declaring broadleaf.paymenttransaction.saved-payment.checkout-complete-create-listener.enabled=false
An event listener that triggers when a checkout is successfully completed. Responsible for checking the completed cart for any newly specified payment methods that the user wishes to save for future usage, or usage of any previously saved payment methods to record the latest results.

This listener is only needed for the transitional period after upgrading to 1.0.2, to ensure that saved payments are created for unprocessed messages after the upgrade. Once a day or two have passed after adopting the upgrade, this listener can be disabled by declaring broadleaf.paymenttransaction.saved-payment.checkout-complete-create-listener.enabled=false

Author:
Chris Kittrell (ckittrell), Sunny Yu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    APPLICATION_ID_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    CART_ID_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    CART_STATUS_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    CUSTOMER_CONTEXT_ID_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    CUSTOMER_ID_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    SUBMITTED
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    SUCCESS
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final String
    TENANT_ID_PATH
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CreateSavedPaymentMethodEventListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, PaymentManagementService<Payment> paymentManagementService, SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService, SavedPaymentMethodManagementService savedPaymentMethodManagementService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.broadleafcommerce.data.tracking.core.context.ContextInfo
    buildContextInfo(@NonNull com.jayway.jsonpath.DocumentContext jsonContext)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Builds a ContextInfo for the application context id and tenant id
    protected com.jayway.jsonpath.DocumentContext
    getDocumentContext(@NonNull String payload)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Parses the message payload into a `DocumentContext` which allows for JsonPath parsing using Jackson providers.
    protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService
    getIdempotentConsumptionService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected com.fasterxml.jackson.databind.ObjectMapper
    getObjectMapper()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected PaymentManagementService<Payment>
    getPaymentManagementService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected SavedPaymentMethodManagementService
    getSavedPaymentMethodManagementService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected SavedPaymentMethodService<SavedPaymentMethod>
    getSavedPaymentMethodService()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected com.broadleafcommerce.common.extension.TypeFactory
    getTypeFactory()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected boolean
    isSubmittedOrder(com.jayway.jsonpath.DocumentContext jsonContext)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    listen(org.springframework.messaging.Message<String> message)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Event listener entry point.
    protected void
    processMessage(@NonNull org.springframework.messaging.Message<String> message)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Handles the interpretation of the message payload & if necessary, creates SavedPaymentMethods for the order
    protected String
    readStringValueByPath(@NonNull com.jayway.jsonpath.DocumentContext context, @NonNull String path)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • SUBMITTED

      protected static final String SUBMITTED
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • SUCCESS

      protected static final String SUCCESS
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • CART_STATUS_PATH

      protected static final String CART_STATUS_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • CART_ID_PATH

      protected static final String CART_ID_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • APPLICATION_ID_PATH

      protected static final String APPLICATION_ID_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • TENANT_ID_PATH

      protected static final String TENANT_ID_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • CUSTOMER_CONTEXT_ID_PATH

      protected static final String CUSTOMER_CONTEXT_ID_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • CUSTOMER_ID_PATH

      protected static final String CUSTOMER_ID_PATH
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Constructor Details

    • CreateSavedPaymentMethodEventListener

      public CreateSavedPaymentMethodEventListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, PaymentManagementService<Payment> paymentManagementService, SavedPaymentMethodService<SavedPaymentMethod> savedPaymentMethodService, SavedPaymentMethodManagementService savedPaymentMethodManagementService, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • listen

      @StreamListener("checkoutCompletionInputPaymentTransaction") public void listen(org.springframework.messaging.Message<String> message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Event listener entry point. Checks if the message has already been received and, if not, begins processing it.
      Parameters:
      message - the message to be processed

    • processMessage

      protected void processMessage(@NonNull @NonNull org.springframework.messaging.Message<String> message)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Handles the interpretation of the message payload & if necessary, creates SavedPaymentMethods for the order
      Parameters:
      message - the message to be processed

    • getDocumentContext

      protected com.jayway.jsonpath.DocumentContext getDocumentContext(@NonNull @NonNull String payload)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parses the message payload into a `DocumentContext` which allows for JsonPath parsing using Jackson providers.
      Parameters:
      payload - the message payload
      Returns:
      a `DocumentContext` representation of the message payload

    • isSubmittedOrder

      protected boolean isSubmittedOrder(com.jayway.jsonpath.DocumentContext jsonContext)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • buildContextInfo

      protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(@NonNull @NonNull com.jayway.jsonpath.DocumentContext jsonContext)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Builds a ContextInfo for the application context id and tenant id
      Parameters:
      jsonContext - The json representation of the message payload
      Returns:
      the ContextInfo of the completed checkout

    • readStringValueByPath

      @Nullable protected String readStringValueByPath(@NonNull @NonNull com.jayway.jsonpath.DocumentContext context, @NonNull @NonNull String path)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getIdempotentConsumptionService

      protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService getIdempotentConsumptionService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getPaymentManagementService

      protected PaymentManagementService<Payment> getPaymentManagementService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSavedPaymentMethodService

      protected SavedPaymentMethodService<SavedPaymentMethod> getSavedPaymentMethodService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSavedPaymentMethodManagementService

      protected SavedPaymentMethodManagementService getSavedPaymentMethodManagementService()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getObjectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()
      Deprecated, for removal: This API element is subject to removal in a future version.