Package com.broadleafcommerce.sandbox.service.autoconfigure

Class SandboxNotificationPruneProperties

java.lang.Object
com.broadleafcommerce.sandbox.service.autoconfigure.SandboxNotificationPruneProperties
@Validated @ConfigurationProperties("broadleaf.sandbox.tracking.notification.prune") public class SandboxNotificationPruneProperties extends Object
Properties configuring behavior of SandboxNotificationPruneService and SandboxNotificationPruneRepository.

  • Constructor Details

    • SandboxNotificationPruneProperties

      public SandboxNotificationPruneProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Whether pruning of dormant notification states is enabled. Enabling this is highly recommended to prevent buildup in the datastore.

    • getOutdatedDataAgeCutoff

      public Duration getOutdatedDataAgeCutoff()
      Dormant NotificationStates created at a time older than the current time (the time that the scheduled job is handled) minus this duration will be pruned from the datastore. This value should be set low enough to prevent excessive build-up of dormant states in the system, but also high enough to allow most change summary lifecycles to complete within the allotted time. The default value is set to 30 days, assuming that most change summaries are created and either reverted or fully deployed to production within that time.

    • getDeleteBatchSize

      public int getDeleteBatchSize()
      The default cleanup process deletes entities in batches, and this property can be used to configure the batch size. This can be helpful to avoid large transactions that affect a huge number of rows.

    • getPauseBetweenDeleteBatches

      public Duration getPauseBetweenDeleteBatches()
      This is the amount of time that the cleanup job will pause in between each delete batch. Useful to give the database some relief during execution.

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether pruning of dormant notification states is enabled. Enabling this is highly recommended to prevent buildup in the datastore.

    • setOutdatedDataAgeCutoff

      public void setOutdatedDataAgeCutoff(Duration outdatedDataAgeCutoff)
      Dormant NotificationStates created at a time older than the current time (the time that the scheduled job is handled) minus this duration will be pruned from the datastore. This value should be set low enough to prevent excessive build-up of dormant states in the system, but also high enough to allow most change summary lifecycles to complete within the allotted time. The default value is set to 30 days, assuming that most change summaries are created and either reverted or fully deployed to production within that time.

    • setDeleteBatchSize

      public void setDeleteBatchSize(int deleteBatchSize)
      The default cleanup process deletes entities in batches, and this property can be used to configure the batch size. This can be helpful to avoid large transactions that affect a huge number of rows.

    • setPauseBetweenDeleteBatches

      public void setPauseBetweenDeleteBatches(Duration pauseBetweenDeleteBatches)
      This is the amount of time that the cleanup job will pause in between each delete batch. Useful to give the database some relief during execution.

    • 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