Package com.broadleafcommerce.scheduledjob.service.autoconfigure

Class ClusterProperties

java.lang.Object
com.broadleafcommerce.scheduledjob.service.autoconfigure.ClusterProperties
@ConfigurationProperties("broadleaf.scheduledjob.cluster") public class ClusterProperties extends Object
Author:
Chad Harchar (charchar)

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClusterProperties()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    getMissedScheduleLagThreshold()
    The amount of time that must pass before the system will attempt to pick up and trigger a single use job that has exceeded its target date without being marked as executed.
    String
    getNamespace()
    Namespace to use when getting the view for the camel cluster.
    Duration
    getSchedulerPollingInterval()
    The polling interval in milliseconds to determine how often to create and update schedulers based off of persisted ScheduledJobs.
    String
    getSchedulerURI()
    The camel URI to use for the scheduled job updates interval.
    boolean
    isActive()
    Whether singleton clustering behavior is enabled.
    boolean
    isDeveloperMode()
    Deprecated.
    Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property.
    void
    setActive(boolean active)
    Whether singleton clustering behavior is enabled.
    void
    setDeveloperMode(boolean developerMode)
    Deprecated.
    Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property.
    void
    setMissedScheduleLagThreshold(Duration missedScheduleLagThreshold)
    The amount of time that must pass before the system will attempt to pick up and trigger a single use job that has exceeded its target date without being marked as executed.
    void
    setNamespace(String namespace)
    Namespace to use when getting the view for the camel cluster.
    void
    setSchedulerPollingInterval(Duration schedulerPollingInterval)
    The polling interval in milliseconds to determine how often to create and update schedulers based off of persisted ScheduledJobs.
    void
    setSchedulerURI(String schedulerURI)
    The camel URI to use for the scheduled job updates interval.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ClusterProperties

      public ClusterProperties()

  • Method Details

    • isActive

      public boolean isActive()
      Whether singleton clustering behavior is enabled. Default is true.

    • getNamespace

      public String getNamespace()
      Namespace to use when getting the view for the camel cluster. Default is "lock".

    • getSchedulerURI

      public String getSchedulerURI()
      The camel URI to use for the scheduled job updates interval. Default is "master:lock1";

    • getSchedulerPollingInterval

      public Duration getSchedulerPollingInterval()
      The polling interval in milliseconds to determine how often to create and update schedulers based off of persisted ScheduledJobs. There is no guarantee that all ScheduledJobs will be created as Quartz jobs, due to invalid data configuration. Default is 30 seconds.

    • isDeveloperMode

      @Deprecated public boolean isDeveloperMode()
      Deprecated.
      Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property. The default for that property is file, which is appropriate for local development.
      Indicates the scheduling system is intended in this configuration to be used by developers, rather than a real deployment. This setting causes an additional random piece of information to be appended to namespace so that instances of the same service being run by multiple devs on the same subnet are not interpreted as being part of the same cluster. Otherwise, behavior could be unpredictable between machines and services might not start up locally for one or more devs. The default is true.

    • getMissedScheduleLagThreshold

      public Duration getMissedScheduleLagThreshold()
      The amount of time that must pass before the system will attempt to pick up and trigger a single use job that has exceeded its target date without being marked as executed. This can occur if a job is scheduled, but no scheduling instance was up or available at the moment targeted for execution. Default is 60 seconds.

    • setActive

      public void setActive(boolean active)
      Whether singleton clustering behavior is enabled. Default is true.

    • setNamespace

      public void setNamespace(String namespace)
      Namespace to use when getting the view for the camel cluster. Default is "lock".

    • setSchedulerURI

      public void setSchedulerURI(String schedulerURI)
      The camel URI to use for the scheduled job updates interval. Default is "master:lock1";

    • setSchedulerPollingInterval

      public void setSchedulerPollingInterval(Duration schedulerPollingInterval)
      The polling interval in milliseconds to determine how often to create and update schedulers based off of persisted ScheduledJobs. There is no guarantee that all ScheduledJobs will be created as Quartz jobs, due to invalid data configuration. Default is 30 seconds.

    • setDeveloperMode

      @Deprecated public void setDeveloperMode(boolean developerMode)
      Deprecated.
      Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property. The default for that property is file, which is appropriate for local development.
      Indicates the scheduling system is intended in this configuration to be used by developers, rather than a real deployment. This setting causes an additional random piece of information to be appended to namespace so that instances of the same service being run by multiple devs on the same subnet are not interpreted as being part of the same cluster. Otherwise, behavior could be unpredictable between machines and services might not start up locally for one or more devs. The default is true.

    • setMissedScheduleLagThreshold

      public void setMissedScheduleLagThreshold(Duration missedScheduleLagThreshold)
      The amount of time that must pass before the system will attempt to pick up and trigger a single use job that has exceeded its target date without being marked as executed. This can occur if a job is scheduled, but no scheduling instance was up or available at the moment targeted for execution. Default is 60 seconds.

    • toString

      public String toString()
      Overrides:
      toString in class Object