Package com.broadleafcommerce.data.tracking.core.transition

Interface PropagationHandler

All Superinterfaces:
org.springframework.core.Ordered, PropagationAware
All Known Implementing Classes:
DefaultPropagationHandler, VendorSandboxPropagationHandler
public interface PropagationHandler extends PropagationAware, org.springframework.core.Ordered
Perform catalog propagation of entity changes post deployment, iterating through the catalog inheritance hierarchy. Handlers participate as part of the operation of PropagationManager. Handlers are ordered in the manager component, and the first handler capable of handling the request for propagation wins and other handlers are ignored. Altered, or special propagation behavior may be introduced in this way by adding handlers with higher precedence ordering.
Author:
Jeff Fischer

  • Field Summary

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canHandle(Trackable incoming, String incomingCatalog, String parentCatalog, Trackable candidate, OperationType changeType)
    Is this handler capable of handling the propagation process given the contextual information.
    default int
    getOrder()
     

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.transition.PropagationAware

    handleCreate, handleDelete, handleUpdate

  • Method Details

    • canHandle

      boolean canHandle(Trackable incoming, String incomingCatalog, String parentCatalog, @Nullable Trackable candidate, OperationType changeType)
      Is this handler capable of handling the propagation process given the contextual information.
      Parameters:
      incoming - The Trackable instance that contains the change information to propagate
      incomingCatalog - The current catalog in which the propagation is occuring
      parentCatalog - The parent catalog up one level
      candidate - The candidate, if available, representing a catalog override already existing in the incomingCatalog.
      changeType - The type of change requested. See OperationType.
      Returns:
      Is this handler capable of handling the propagation process

    • getOrder

      default int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered