Interface Timeouts

All Superinterfaces:
org.aeonbits.owner.Config, EngineProperties<Timeouts>, Serializable
@Sources({"system:properties","file:src/main/resources/properties/Timeouts.properties","file:src/main/resources/properties/default/Timeouts.properties","classpath:Timeouts.properties"}) public interface Timeouts extends EngineProperties<Timeouts>
Configuration properties interface for timeout settings in the SHAFT framework. Controls wait durations for browser navigation, page load, script execution, API calls, shell commands, database queries, and element identification.

Use set() to override values programmatically: 

SHAFT.Properties.timeouts.set().defaultElementIdentificationTimeout(10);
SHAFT.Properties.timeouts.set().waitForUiStateTimeout(600);

  • Method Details

    • waitForLazyLoading

      @Key("waitForLazyLoading") @DefaultValue("true") Boolean waitForLazyLoading()

    • browserNavigationTimeout

      @Key("browserNavigationTimeout") @DefaultValue("30") int browserNavigationTimeout()

    • pageLoadTimeout

      @Key("pageLoadTimeout") @DefaultValue("30") int pageLoadTimeout()

    • scriptExecutionTimeout

      @Key("scriptExecutionTimeout") @DefaultValue("30") int scriptExecutionTimeout()

    • waitForLazyLoadingTimeout

      @Key("waitForLazyLoadingTimeout") @DefaultValue("30") int waitForLazyLoadingTimeout()
      Timeout in seconds for SHAFT's browser lazy-loading synchronization.

    • lazyLoadingNetworkIdleInitialObservationMillis

      @Key("lazyLoadingNetworkIdleInitialObservationMillis") @DefaultValue("200") int lazyLoadingNetworkIdleInitialObservationMillis()
      Initial network observation window in milliseconds when no requests were seen.

    • lazyLoadingNetworkIdleQuietWindowMillis

      @Key("lazyLoadingNetworkIdleQuietWindowMillis") @DefaultValue("500") int lazyLoadingNetworkIdleQuietWindowMillis()
      Required network quiet window in milliseconds after observed activity.

    • lazyLoadingPollingIntervalMillis

      @Key("lazyLoadingPollingIntervalMillis") @DefaultValue("200") int lazyLoadingPollingIntervalMillis()
      Polling interval in milliseconds for the browser-readiness fluentWait loop.

    • lazyLoadingDomStabilityQuietWindowMillis

      @Key("lazyLoadingDomStabilityQuietWindowMillis") @DefaultValue("0") int lazyLoadingDomStabilityQuietWindowMillis()
      Required DOM-mutation quiet window in milliseconds before the browser-readiness wait treats the DOM as stable. 0 (default) disables DOM-stability folding entirely, preserving today's behavior bit-for-bit: the readiness wait then never reads the DOM-mutation marker as part of its pass condition.

    • lazyLoadingScrollSweepMaxSteps

      @Key("lazyLoadingScrollSweepMaxSteps") @DefaultValue("20") int lazyLoadingScrollSweepMaxSteps()
      Maximum number of progressive-scroll steps that BrowserActions.scrollToLoadAll() will perform while sweeping a page for scroll-triggered lazy content, bounding its worst-case cost regardless of how far the page keeps growing.

    • defaultElementIdentificationTimeout

      @Key("defaultElementIdentificationTimeout") @DefaultValue("10") double defaultElementIdentificationTimeout()

    • waitForUiStateTimeout

      @Key("waitForUiStateTimeout") @DefaultValue("600") int waitForUiStateTimeout()
      Timeout in seconds for default UI state waits.

    • apiSocketTimeout

      @Key("apiSocketTimeout") @DefaultValue("30") int apiSocketTimeout()

    • apiConnectionTimeout

      @Key("apiConnectionTimeout") @DefaultValue("30") int apiConnectionTimeout()

    • apiConnectionManagerTimeout

      @Key("apiConnectionManagerTimeout") @DefaultValue("30") int apiConnectionManagerTimeout()

    • shellSessionTimeout

      @Key("shellSessionTimeout") @DefaultValue("30") long shellSessionTimeout()

    • sshServerAliveInterval

      @Key("sshServerAliveInterval") @DefaultValue("60") int sshServerAliveInterval()
      JSch ServerAliveInterval in seconds for remote SSH sessions. Values <= 0 disable keep-alive packets.

    • dockerCommandTimeout

      @Deprecated(since="10.2.20260614", forRemoval=true) @Key("dockerCommandTimeout") @DefaultValue("30") int dockerCommandTimeout()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Docker-wrapped terminal execution is deprecated for removal.

    • databaseLoginTimeout

      @Key("databaseLoginTimeout") @DefaultValue("30") int databaseLoginTimeout()

    • databaseNetworkTimeout

      @Key("databaseNetworkTimeout") @DefaultValue("30") int databaseNetworkTimeout()

    • databaseQueryTimeout

      @Key("databaseQueryTimeout") @DefaultValue("30") int databaseQueryTimeout()

    • waitForRemoteServerToBeUp

      @Key("waitForRemoteServerToBeUp") @DefaultValue("false") Boolean waitForRemoteServerToBeUp()

    • timeoutForRemoteServerToBeUp

      @Key("timeoutForRemoteServerToBeUp") @DefaultValue("1") int timeoutForRemoteServerToBeUp()

    • remoteServerInstanceCreationTimeout

      @Key("remoteServerInstanceCreationTimeout") @DefaultValue("5") int remoteServerInstanceCreationTimeout()
      Timeout in minutes for the overall remote WebDriver session-creation retry budget: the total time DriverFactoryHelper keeps retrying failed connection attempts before giving up. Does not bound a single HTTP connect/read attempt against the grid -- see remoteServerConnectionAttemptTimeout() for that. Prior to introducing that property, this single value simultaneously bounded the per-attempt HTTP client timeout, the outer retry budget, and the progress bar, so one hung attempt could silently consume the entire budget without the retry loop ever getting a chance to retry (issue #3811).

    • remoteServerConnectionAttemptTimeout

      @Key("remoteServerConnectionAttemptTimeout") @DefaultValue("120") int remoteServerConnectionAttemptTimeout()
      Timeout in seconds for a single HTTP connect/read attempt made by the underlying HTTP client while creating a remote WebDriver session. Decoupled from remoteServerInstanceCreationTimeout(), which bounds only the overall retry budget (in minutes) across all attempts: this property bounds one connection attempt, so an unreachable or saturated grid fails an attempt fast and the retry loop actually gets to retry within the overall budget, instead of one attempt burning the whole window (issue #3811). The default stays deliberately generous because a healthy-but-busy grid holds the new-session POST open while the request waits in its session queue; a timed-out attempt that gets retried enqueues a duplicate request. Lower this (e.g. to 10-30) only where fail-fast matters more than queue tolerance, such as CI with adaptive throttling.

    • set

      default Timeouts.SetProperty set()
      Description copied from interface: EngineProperties
      Returns a fluent EngineProperties.SetProperty builder that allows programmatic override of individual configuration properties at runtime.
      Specified by:
      set in interface EngineProperties<Timeouts>
      Returns:
      a new EngineProperties.SetProperty instance for chaining property overrides