Record Class ScopeAwareProviderSettings

java.lang.Object
java.lang.Record
org.axonframework.messaging.ScopeAwareProviderSettings
Record Components:
readinessTimeout - how long the provider waits for the configuration to start its event processors before a fired deadline fails and is retried by its deadline manager

public record ScopeAwareProviderSettings(Duration readinessTimeout) extends Record
Settings of the LegacyScopeAwareProvider of a configuration.

Register a component of this type to change the defaults:


 configurer.componentRegistry(cr -> cr.registerComponent(
         ScopeAwareProviderSettings.class,
         c -> new ScopeAwareProviderSettings(Duration.ofMinutes(2))
 ));
 
Spring Boot applications set the axon.deadline.scope-aware-provider-readiness-timeout property instead.
Since:
5.4.0
Author:
Jakob Hatzl
  • Field Details

    • DEFAULT

      public static final ScopeAwareProviderSettings DEFAULT
      The settings used when no ScopeAwareProviderSettings component is registered: a readiness timeout of 30 seconds.
  • Constructor Details

    • ScopeAwareProviderSettings

      public ScopeAwareProviderSettings(Duration readinessTimeout)
      Validates the settings.
      Parameters:
      readinessTimeout - how long the provider waits for the configuration to start its event processors
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • readinessTimeout

      public Duration readinessTimeout()
      Returns the value of the readinessTimeout record component.
      Returns:
      the value of the readinessTimeout record component