Package com.hazelcast.config

Class ScheduledExecutorConfig

java.lang.Object
com.hazelcast.config.ScheduledExecutorConfig
All Implemented Interfaces:
NamedConfig, UserCodeNamespaceAwareConfig<ScheduledExecutorConfig>, DataSerializable, IdentifiedDataSerializable, com.hazelcast.nio.serialization.impl.Versioned
public class ScheduledExecutorConfig extends Object implements IdentifiedDataSerializable, NamedConfig, com.hazelcast.nio.serialization.impl.Versioned, UserCodeNamespaceAwareConfig<ScheduledExecutorConfig>
Configuration options for the IScheduledExecutorService.

  • Constructor Details

    • ScheduledExecutorConfig

      public ScheduledExecutorConfig()

    • ScheduledExecutorConfig

      public ScheduledExecutorConfig(String name)

    • ScheduledExecutorConfig

      public ScheduledExecutorConfig(String name, int durability, int capacity, int poolSize, boolean statisticsEnabled, @Nullable String userCodeNamespace)

    • ScheduledExecutorConfig

      public ScheduledExecutorConfig(String name, int durability, int capacity, int poolSize, String splitBrainProtectionName, MergePolicyConfig mergePolicyConfig, ScheduledExecutorConfig.CapacityPolicy capacityPolicy, boolean statisticsEnabled, @Nullable String userCodeNamespace)

    • ScheduledExecutorConfig

      public ScheduledExecutorConfig(ScheduledExecutorConfig config)

  • Method Details

    • getName

      public String getName()
      Gets the name of the executor task.
      Specified by:
      getName in interface NamedConfig
      Returns:
      the name of the executor task

    • setName

      public ScheduledExecutorConfig setName(String name)
      Sets the name of the executor task.
      Specified by:
      setName in interface NamedConfig
      Parameters:
      name - the name of the executor task
      Returns:
      this executor config instance

    • getPoolSize

      public int getPoolSize()
      Gets the number of executor threads per member for the executor.
      Returns:
      the number of executor threads per member for the executor

    • setPoolSize

      public ScheduledExecutorConfig setPoolSize(int poolSize)
      Sets the number of executor threads per member for the executor.
      Parameters:
      poolSize - the number of executor threads per member for the executor
      Returns:
      this executor config instance

    • getDurability

      public int getDurability()
      Gets the durability of the executor
      Returns:
      the durability of the executor

    • setDurability

      public ScheduledExecutorConfig setDurability(int durability)
      Sets the durability of the executor The durability represents the number of replicas that exist in a cluster for any given partition-owned task. If this is set to 0 then there is only 1 copy of the task in the cluster, meaning that if the partition owning it, goes down then the task is lost.
      Parameters:
      durability - the durability of the executor
      Returns:
      this executor config instance

    • getCapacity

      public int getCapacity()
      Gets the capacity of the executor
      Returns:
      the capacity of the executor

    • setCapacity

      public ScheduledExecutorConfig setCapacity(int capacity)
      Sets the capacity of the executor The capacity represents the maximum number of tasks that a scheduler can have at any given point in time per partition or per node according to the capacity policy. If this is set to 0 then there is no limit

      To prevent any undesirable data-loss, capacity is ignored during partition migrations, the count is updated accordingly, however the rejection is not enforced.

      Parameters:
      capacity - the capacity of the executor
      Returns:
      this executor config instance

    • getCapacityPolicy

      public ScheduledExecutorConfig.CapacityPolicy getCapacityPolicy()
      Returns:
      the policy of the capacity setting

    • setCapacityPolicy

      public ScheduledExecutorConfig setCapacityPolicy(@Nonnull ScheduledExecutorConfig.CapacityPolicy capacityPolicy)
      Set the capacity policy for the configured capacity value

      To prevent any undesirable data-loss, capacity is ignored during partition migrations, the count is updated accordingly, however the rejection is not enforced.

      Parameters:
      capacityPolicy -

    • getSplitBrainProtectionName

      public String getSplitBrainProtectionName()
      Returns the split brain protection name for operations.
      Returns:
      the split brain protection name

    • setSplitBrainProtectionName

      public ScheduledExecutorConfig setSplitBrainProtectionName(String splitBrainProtectionName)
      Sets the split brain protection name for operations.
      Parameters:
      splitBrainProtectionName - the split brain protection name
      Returns:
      the updated configuration

    • getMergePolicyConfig

      public MergePolicyConfig getMergePolicyConfig()
      Gets the MergePolicyConfig for the scheduler.
      Returns:
      the MergePolicyConfig for the scheduler

    • setMergePolicyConfig

      public ScheduledExecutorConfig setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)
      Sets the MergePolicyConfig for the scheduler.
      Returns:
      this executor config instance

    • isStatisticsEnabled

      public boolean isStatisticsEnabled()
      Returns:
      true if statistics gathering is enabled on the executor task (default), false otherwise

    • setStatisticsEnabled

      public ScheduledExecutorConfig setStatisticsEnabled(boolean statisticsEnabled)
      Enables or disables statistics gathering on the executor task.
      Parameters:
      statisticsEnabled - true if statistics gathering is enabled on the executor task, false otherwise @return this executor config instance

    • getUserCodeNamespace

      @Nullable public String getUserCodeNamespace()
      Retrieve the User Code Deployment Namespace to be used for ClassLoader awareness during operations related to the structure associated with this configuration.
      Specified by:
      getUserCodeNamespace in interface UserCodeNamespaceAwareConfig<ScheduledExecutorConfig>
      Returns:
      Namespace Name for use with the UserCodeNamespaceService, or null if there is no User Code Namespace to associate with.

    • setUserCodeNamespace

      public ScheduledExecutorConfig setUserCodeNamespace(@Nullable String userCodeNamespace)
      Associates the provided Namespace Name with this structure for ClassLoader awareness.

      The behaviour of setting this to null is outlined in the documentation for UserCodeNamespaceAwareConfig.DEFAULT_NAMESPACE.

      Specified by:
      setUserCodeNamespace in interface UserCodeNamespaceAwareConfig<ScheduledExecutorConfig>
      Parameters:
      userCodeNamespace - The ID of the Namespace to associate with this structure.
      Returns:
      the updated ScheduledExecutorConfig instance
      Since:
      5.4

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFactoryId

      public int getFactoryId()
      Description copied from interface: IdentifiedDataSerializable
      Returns DataSerializableFactory factory ID for this class.
      Specified by:
      getFactoryId in interface IdentifiedDataSerializable
      Returns:
      factory ID

    • getClassId

      public int getClassId()
      Description copied from interface: IdentifiedDataSerializable
      Returns type identifier for this class. It should be unique per DataSerializableFactory.
      Specified by:
      getClassId in interface IdentifiedDataSerializable
      Returns:
      type ID

    • writeData

      public void writeData(ObjectDataOutput out) throws IOException
      Description copied from interface: DataSerializable
      Writes object fields to output stream
      Specified by:
      writeData in interface DataSerializable
      Parameters:
      out - output
      Throws:
      IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

    • readData

      public void readData(ObjectDataInput in) throws IOException
      Description copied from interface: DataSerializable
      Reads fields from the input stream
      Specified by:
      readData in interface DataSerializable
      Parameters:
      in - input
      Throws:
      IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

    • equals

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object