Package com.broadleafcommerce.catalog.messaging

Class ProcessProductAssetSortingHandler

java.lang.Object
com.broadleafcommerce.catalog.messaging.ProcessProductAssetSortingHandler
public class ProcessProductAssetSortingHandler extends Object
A listener that accepts triggered scheduled job events of type JOB_TYPE and updates the attributes of all assets in the data store. The purpose of this job is to apply a sorting order to all assets currently in the system while attempting to preserve the current display order. This is typically only ever run once, when the drag-and-drop assets feature is enabled. To trigger this job, add a Scheduled Job with a Job Type of `UPDATE_PRODUCT_ASSET_SORTING`.
Author:
Jon Fleschler (jfleschler)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    JOB_TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProcessProductAssetSortingHandler(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, ProductService<Product> productService, ProductAssetService<ProductAsset> productAssetService, List<com.broadleafcommerce.data.tracking.core.data.CatalogDataRouteSupporting> routes, com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator contextRequestHydrator, com.broadleafcommerce.data.tracking.core.tenant.service.CommonCatalogService<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog> catalogService, com.broadleafcommerce.data.tracking.core.tenant.service.CommonApplicationService<com.broadleafcommerce.data.tracking.core.tenant.domain.Application> applicationService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected com.broadleafcommerce.data.tracking.core.context.ContextInfo
    buildContextInfo(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog)
     
    protected List<Product>
    filterCatalogProducts(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog, org.springframework.data.domain.Page<Product> products)
     
    protected List<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog>
    getAllCatalogs()
     
    protected com.broadleafcommerce.data.tracking.core.tenant.service.CommonApplicationService<com.broadleafcommerce.data.tracking.core.tenant.domain.Application>
    getApplicationService()
     
    protected com.broadleafcommerce.data.tracking.core.tenant.service.CommonCatalogService<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog>
    getCatalogService()
     
    protected com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator
    getContextRequestHydrator()
     
    protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService
    getIdempotentConsumptionService()
     
    protected int
    getPageSize(com.broadleafcommerce.common.messaging.domain.ScheduledJobRef scheduledJobRef)
     
    protected ProductAssetService<ProductAsset>
    getProductAssetService()
     
    protected ProductService<Product>
    getProductService()
     
    protected List<com.broadleafcommerce.data.tracking.core.data.CatalogDataRouteSupporting>
    getRoutes()
     
    protected void
    handleMessage(org.springframework.messaging.Message<com.broadleafcommerce.common.messaging.domain.ScheduledJobRef> message)
     
    void
    listen(org.springframework.messaging.Message<com.broadleafcommerce.common.messaging.domain.ScheduledJobRef> message)
    Queries the data store for all assets and updates their attributes.
    protected void
    updateContextInfoForUpdate(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ProcessProductAssetSortingHandler

      public ProcessProductAssetSortingHandler(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, ProductService<Product> productService, ProductAssetService<ProductAsset> productAssetService, List<com.broadleafcommerce.data.tracking.core.data.CatalogDataRouteSupporting> routes, com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator contextRequestHydrator, com.broadleafcommerce.data.tracking.core.tenant.service.CommonCatalogService<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog> catalogService, com.broadleafcommerce.data.tracking.core.tenant.service.CommonApplicationService<com.broadleafcommerce.data.tracking.core.tenant.domain.Application> applicationService)

  • Method Details

    • listen

      @StreamListener("triggeredJobEventProcessProductAssets") public void listen(org.springframework.messaging.Message<com.broadleafcommerce.common.messaging.domain.ScheduledJobRef> message)
      Queries the data store for all assets and updates their attributes.
      Parameters:
      message - a scheduled job trigger event - will only be handled if it has type JOB_TYPE

    • handleMessage

      protected void handleMessage(org.springframework.messaging.Message<com.broadleafcommerce.common.messaging.domain.ScheduledJobRef> message)

    • updateContextInfoForUpdate

      protected void updateContextInfoForUpdate(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • filterCatalogProducts

      protected List<Product> filterCatalogProducts(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog, org.springframework.data.domain.Page<Product> products)

    • getAllCatalogs

      protected List<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog> getAllCatalogs()

    • getPageSize

      protected int getPageSize(com.broadleafcommerce.common.messaging.domain.ScheduledJobRef scheduledJobRef)

    • buildContextInfo

      protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildContextInfo(com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog catalog)

    • getIdempotentConsumptionService

      protected com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService getIdempotentConsumptionService()

    • getProductService

      protected ProductService<Product> getProductService()

    • getProductAssetService

      protected ProductAssetService<ProductAsset> getProductAssetService()

    • getRoutes

      @NonNull protected List<com.broadleafcommerce.data.tracking.core.data.CatalogDataRouteSupporting> getRoutes()

    • getContextRequestHydrator

      @NonNull protected com.broadleafcommerce.data.tracking.core.web.ContextRequestHydrator getContextRequestHydrator()

    • getCatalogService

      @NonNull protected com.broadleafcommerce.data.tracking.core.tenant.service.CommonCatalogService<com.broadleafcommerce.data.tracking.core.tenant.domain.Catalog> getCatalogService()

    • getApplicationService

      @NonNull protected com.broadleafcommerce.data.tracking.core.tenant.service.CommonApplicationService<com.broadleafcommerce.data.tracking.core.tenant.domain.Application> getApplicationService()