Package com.broadleafcommerce.sandbox.service.cleanup

Class CompletionCleanupProperties

java.lang.Object
com.broadleafcommerce.sandbox.service.cleanup.CompletionCleanupProperties
@ConfigurationProperties("broadleaf.transition.cleanup") public class CompletionCleanupProperties extends Object
Configuration related to batch completion of transition related artifacts once all ChangeSummary instances have completed transition. Generally relates to ChangeDeploy, ChangeSummaryGroup, and Sandbox.

  • Field Details

    • CLEANUP_INTERVAL_MAX_DEFAULT

      public static final int CLEANUP_INTERVAL_MAX_DEFAULT
      See Also:

    • CLEANUP_INTERVAL_MIN_DEFAULT

      public static final int CLEANUP_INTERVAL_MIN_DEFAULT
      See Also:

    • CLEANUP_BATCH_SIZE_DEFAULT

      public static final int CLEANUP_BATCH_SIZE_DEFAULT
      See Also:

    • CLEANUP_BATCH_EVALUATION_WINDOW_DEFAULT

      public static final int CLEANUP_BATCH_EVALUATION_WINDOW_DEFAULT
      See Also:

  • Constructor Details

    • CompletionCleanupProperties

      public CompletionCleanupProperties()

  • Method Details

    • getMaxCleanupIntervalMillis

      public Duration getMaxCleanupIntervalMillis()
      The max amount of pause time between completed transition cleanup attempts. Default is 10000 millis.

    • getMinCleanupIntervalMillis

      public Duration getMinCleanupIntervalMillis()
      The min amount of pause time between completed transition cleanup attempts. Default is 3000 millis. This value always wins, and you can set this value equal to or greater than maxCleanupIntervalMillis to achieve a constant, non-randomized value.

    • getCleanupBatchSize

      public int getCleanupBatchSize()
      The quantity of transition cleanups to attempt at one time. Should be somewhat conservative to avoid overworking the database or causing the transaction log to spiral out of control. Default is 50.

    • getEvaluationWindow

      public Duration getEvaluationWindow()
      The amount of time beyond which active items will no longer be evaluated for completion. This measure avoids infinite evaluation of errant, stuck, or defunct items. Without this, the queue of items to check might grow to a ponderous level and interfere with timely processing of other valid items. Default is 30 days.

    • isEnabled

      public boolean isEnabled()
      Whether the separate cleanup services will be enabled. If false, the prior, slower process of detecting ChangeSummaryGroup and ChangeDeploy status upon every ChangeSummary completion will be used. Note, the prior process is deprecated and will be removed in a subsequent release. Default is true.

    • setMaxCleanupIntervalMillis

      public void setMaxCleanupIntervalMillis(Duration maxCleanupIntervalMillis)
      The max amount of pause time between completed transition cleanup attempts. Default is 10000 millis.

    • setMinCleanupIntervalMillis

      public void setMinCleanupIntervalMillis(Duration minCleanupIntervalMillis)
      The min amount of pause time between completed transition cleanup attempts. Default is 3000 millis. This value always wins, and you can set this value equal to or greater than maxCleanupIntervalMillis to achieve a constant, non-randomized value.

    • setCleanupBatchSize

      public void setCleanupBatchSize(int cleanupBatchSize)
      The quantity of transition cleanups to attempt at one time. Should be somewhat conservative to avoid overworking the database or causing the transaction log to spiral out of control. Default is 50.

    • setEvaluationWindow

      public void setEvaluationWindow(Duration evaluationWindow)
      The amount of time beyond which active items will no longer be evaluated for completion. This measure avoids infinite evaluation of errant, stuck, or defunct items. Without this, the queue of items to check might grow to a ponderous level and interfere with timely processing of other valid items. Default is 30 days.

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether the separate cleanup services will be enabled. If false, the prior, slower process of detecting ChangeSummaryGroup and ChangeDeploy status upon every ChangeSummary completion will be used. Note, the prior process is deprecated and will be removed in a subsequent release. Default is true.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object