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

Class DefaultPropagationManager

java.lang.Object
com.broadleafcommerce.data.tracking.core.transition.DefaultPropagationManager
All Implemented Interfaces:
PropagationManager
public class DefaultPropagationManager extends Object implements PropagationManager
Default version of PropagationManager
Author:
Jeff Fischer

  • Constructor Details

  • Method Details

    • setHierarchyPropagationHandlers

      @Autowired(required=false) public void setHierarchyPropagationHandlers(@Nullable List<HierarchyPropagationHandler> hierarchyPropagationHandlers)

    • propagate

      @SuppressNotification("SINGLE_INDEX_REQUEST") public void propagate(Trackable deployed, String parentCatalog, OperationType changeType, String propagationId, TrackableRepository<Trackable> repository)
      Description copied from interface: PropagationManager

      Given a deployed catalog discriminated change, recurse through versions of the entity in child catalogs and transfer the deployed changes to those versions as appropriate.

      Since DataTracking 2.0.7, if PropagationManagerProperties.isAllowHierarchyPropagationHandlers(), the default implementation will first try finding a HierarchyPropagationHandler that can handle the request. See the documentation on HierarchyPropagationHandler for more details. If the global setting is disabled, or if no HierarchyPropagationHandler could handle the request, the behavior will fall back to the standard propagation flow as described below.

      In the standard propagation flow, the default implementation defers to implementations of PropagationHandler. PropagationHandler instances are registered with Spring and ordered. The first instance capable of handling is used and others are ignored. By default, for deletion, a CatalogEntityDeletedEvent is emitted at the parent catalog level, and then one for each child catalog if propagation candidate doesn't exist. If propagation candidate exists for a child catalog, InternalPersistenceEvent is used instead.

      Specified by:
      propagate in interface PropagationManager
      Parameters:
      deployed - The deployed item containing changes to propagate
      parentCatalog - The catalog whose children will be checked for propagation items
      changeType - The type of operation to be propagated (CREATE,UPDATE,DELETE)
      propagationId - An id that identifies changes as part of this propagation. See ChangeDetail.getPropagationId().
      repository - The repository responsible for persistence of the entity type

    • areHierarchyPropagationHandlersAllowed

      protected boolean areHierarchyPropagationHandlersAllowed()
      Returns:
      whether hierarchy propagation handler support is enabled at all in the system
      Since:
      DataTracking 2.0.7

    • propagateThroughChildCatalogs

      protected void propagateThroughChildCatalogs(Trackable deployed, String parentCatalog, OperationType changeType, String propagationId, TrackableRepository<Trackable> repository)
      Propagates the changes for each child catalog of the given parent catalog.
      Parameters:
      deployed - The deployed item containing changes to propagate
      parentCatalog - The catalog whose children will be checked for propagation items
      changeType - The type of operation to be propagated (CREATE,UPDATE,DELETE)
      propagationId - An id that identifies changes as part of this propagation. See ChangeDetail.getPropagationId().
      repository - The repository responsible for persistence of the entity type

    • getRecursivePropagationCatalogIdsProcessingBatchSize

      protected int getRecursivePropagationCatalogIdsProcessingBatchSize()
      Returns:
      catalog ids processing batch size for recursive propagation flow
      Since:
      DataTracking 2.0.7

    • getCatalogId

      protected String getCatalogId(Trackable trackable)

    • handleDelete

      protected Trackable handleDelete(Trackable incoming, String incomingCatalog, String parentCatalog, String propagationId, @Nullable Trackable candidate, TrackableRepository<Trackable> repository)

    • handleCreate

      protected Trackable handleCreate(Trackable incoming, String incomingCatalog, String parentCatalog, String propagationId, TrackableRepository<Trackable> repository)

    • handleUpdate

      protected Trackable handleUpdate(Trackable incoming, String incomingCatalog, String parentCatalog, String propagationId, @Nullable Trackable candidate, TrackableRepository<Trackable> repository)

    • notifyCatalogEntityDeletion

      protected void notifyCatalogEntityDeletion(Trackable entity, String catalogId)
      Inform the system via a CatalogEntityDeletedEvent message that a catalog entity has been deleted if applicable.

      This is useful for consuming services to delete any relationship entities that are no longer relevant.

      The given entity class is still checked for whether it's CatalogTrackable, to avoid sending the event for entities that only have TrackableBehavior.CATALOG through its inheritance from another entity, e.g. translations.

      Parameters:
      entity - the entity to notify deletion if it's CatalogTrackable
      catalogId - the id of the catalog to emit the event for
      See Also:

    • notifyCatalogEntityUpdated

      protected void notifyCatalogEntityUpdated(Trackable entity, String catalogId)

    • notifyCatalogEntityCreation

      protected void notifyCatalogEntityCreation(Trackable entity, String catalogId)

    • propagateThroughChildCatalogsViaHierarchyHandler

      protected HierarchyPropagationHandlerOutput propagateThroughChildCatalogsViaHierarchyHandler(Trackable deployed, String parentCatalog, OperationType changeType, String propagationId, TrackableRepository<Trackable> repository)
      Find and invoke a HierarchyPropagationHandler to handle the propagation request.
      Parameters:
      deployed - The deployed item containing changes to propagate
      parentCatalog - The catalog whose children will be checked for propagation items
      changeType - The type of operation to be propagated (CREATE,UPDATE,DELETE)
      propagationId - An id that identifies changes as part of this propagation. See ChangeDetail.getPropagationId().
      repository - The repository responsible for persistence of the entity type
      Returns:
      result details
      Since:
      DataTracking 2.0.7

    • buildHierarchyPropagationHandlerInput

      protected HierarchyPropagationHandlerInput buildHierarchyPropagationHandlerInput(Trackable deployed, String parentCatalog, OperationType changeType, String propagationId, TrackableRepository<Trackable> repository)

    • handleHierarchyPropagationHandlerNotFound

      protected HierarchyPropagationHandlerOutput handleHierarchyPropagationHandlerNotFound(HierarchyPropagationHandlerInput input)

    • getEventPublisher

      protected org.springframework.context.ApplicationEventPublisher getEventPublisher()

    • setEventPublisher

      @Autowired public void setEventPublisher(@Nullable org.springframework.context.ApplicationEventPublisher eventPublisher)

    • getPropagationManagerProperties

      protected PropagationManagerProperties getPropagationManagerProperties()

    • setPropagationManagerProperties

      @Autowired public void setPropagationManagerProperties(@Nullable PropagationManagerProperties propagationManagerProperties)

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

    • setTypeFactory

      @Autowired public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

    • getHierarchyPropagationHandlers

      protected List<HierarchyPropagationHandler> getHierarchyPropagationHandlers()