Java Virtual Machine Parameters

This topic describes variables that ReadyAPI passes to the Java virtual machine to prepare the environment.

Note

To learn how to modify JVM settings, see Modifying JVM Settings.

Memory and JVM heap tuning

Heap sizing

  • -Xms<value>

    Specifies the initial size of the heap (memory) in bytes.

    Append k or K to specify the value in kilobytes, and m or M to specify the value in megabytes.

    Example:

    -Xms128m
  • -Xmx<value>

    Specifies the maximum size of the heap (memory) to be used in bytes. Default value: 4000m.

    Append k or K to specify the value in kilobytes, and m or M to specify the value in megabytes.

    Example:

    -Xmx1000m

Heap free ratio (GC behavior)

  • -XX:MinHeapFreeRatio=<value>

    Specifies the minimum percentage of free heap space after the garbage collector event to avoid shrinking.

    Example:

    -XX:MinHeapFreeRatio=20
  • -XX:MaxHeapFreeRatio=<value>

    Specifies the maximum percentage of free heap space after the garbage collector event to avoid shrinking.

    Example:

    -XX:MaxHeapFreeRatio=40

Legacy / JVM-version-specific

  • -XX:MaxPermSize=<value>

    Specifies the size of the permanent generation to avoid PermGen errors.

    Append k or K to specify the value in kilobytes, and m or M to specify the value in megabytes.

    Example:

    -XX:MaxPermSize=256m

ReadyAPI chart memory

  • -Dloadui.charts.maxpoints=<value>

    Sets the maximum number of points to draw ReadyAPI charts on the Load and Statistics pages. When ReadyAPI reaches the specified number of points, it removes the oldest point from the memory, so the beginning of the charts is not drawn. See Memory Management.

Security and transport

TLS/ciphers

Client certificate authentication (SSL)

  • -Dsoapui.ssl.keystore.location=<value>

    The path to the keystore that ReadyAPI uses to connect to the server.

    Note

    • This option is used for client certificate authentication.

    • This option overwrites the KeyStore setting on the SSL preferences page.

    • ReadyAPI always ignores the javax.net.ssl.keyStore, javax.net.ssl.keyStorePassword, javax.net.ssl.trustStore and javax.net.ssl.trustStorePassword options.

  • -Dsoapui.ssl.keystore.password=<value>

    The keystore password.

    Note

    • This option is used for client certificate authentication.

    • This option overwrites the KeyStore Password setting on the SSL preferences page.

    • ReadyAPI always ignores the javax.net.ssl.keyStore, javax.net.ssl.keyStorePassword, javax.net.ssl.trustStore, and javax.net.ssl.trustStorePassword options.

Request/content handling

  • -Dsoapui.send.zero.content.length=<value>

    Removes the Content.Length: 0 header from the request.

    Example:

    -Dsoapui.send.zero.content.length=false
  • -Dsuppress.api.request.validation.message=<value>

    Specifies whether to suppress the pop-up that appears when viewing encrypted request content in the Project save/load scripts. Setting the value to true suppresses the pop-up, allowing the encrypted content to remain intact; false displays the pop-up by default, potentially replacing the content with default values.

    Example:

    -Dsuppress.api.request.validation.message=true

Authentication and SSO

SPNEGO/Kerberos

  • -Djavax.security.auth.useSubjectCredsOnly=<value>: Controls the process of getting credentials from a request. See SPNEGO/Kerberos Authentication.

    Example:

    -Djavax.security.auth.useSubjectCredsOnly=false
  • -Djava.security.auth.login.config=<value>: Specifies the path to the Kerberos configuration file. See SPNEGO/Kerberos Authentication.

    Example:

    -Djava.security.auth.login.config=C:/kerberos/login.conf
  • -Djava.security.krb5.conf=<value>: Specifies the path to the configuration file for the Kerberos login module. See SPNEGO/Kerberos Authentication.

    Example:

    -Djava.security.krb5.conf=C:/kerberos/krb5.conf
  • -Dhttpclient.spnego.usecanonicalname=<value> -Dhttpclient.kerberos.usecanonicalname=<value>:

    Specifies if SPNEGO/Kerberos should perform a reverse DNS lookup. See SPNEGO/Kerberos Authentication

    Examples:

    -Dhttpclient.spnego.usecanonicalname=false
    -Dhttpclient.kerberos.usecanonicalname=false

OAuth / OIDC timeouts

  • -Doauth2.access.token.retrieval.timeout=<value>: Sets the timeout for automatic input of credentials when running the OAuth token retrieval script (in milliseconds). It can be useful if the process of getting a new access token takes more than 5 seconds. Default value: 5000.

  • -Dvirtserver.oidc.login.timeout=<value>

    Value to be added in milliseconds.

    Example:

    -Dvirtserver.oidc.login.timeout=30000
    for setting timeout as 30 seconds.

Network and embedded server (Jetty / Mocking)

  • -Djetty.header.size=<value>

    Sets RequestHeaderSize and ResponseHeaderSize to a given value.

    Example:

    -Djetty.header.size=32768
  • -Dsoapui.mock.connector.headerBufferSize=<value>: Sets the Jetty connector properties.

    Example:

    -Dsoapui.mock.connector.headerBufferSize=8192

ReadyAPI configuration, extensibility, and tooling paths

Global config/properties

External libraries and legacy plugins

  • -Dsoapui.ext.libraries=<value>: Specifies the path to the external .jar files that ReadyAPI should load (for example, JDBC drivers).

    Example:

    -Dsoapui.ext.libraries=C:\Program Files\SmartBear\ReadyAPI-2.x.x/bin/ext
  • -Dsoapui.ext.listeners=<value>: Specifies the location where the old-style plugin listeners are stored.

    Example:

    -Dsoapui.ext.listeners=C:\Program Files\SmartBear\ReadyAPI-2.x.x/bin/listeners
  • -Dsoapui.ext.actions=<value>: Specifies the location where the old-style plugin actions are stored.

    Example:

    -Dsoapui.ext.actions=C:\Program Files\SmartBear\ReadyAPI-2.x.x/bin/actions

WS-I tools

  • -Dwsi.dir=<value>: Specifies the location of wsi-test-tools, if not the default.

    Example:

    -Dwsi.dir=C:\Program Files\
    SmartBear\ReadyAPI-2.x.x/wsi-test-tools

Product behavior and feature controls

  • -Dreadyapi.enable.ai.features=<value>

    Controls whether SmartBear AI features appear in ReadyAPI.

    ReadyAPI disables AI features in the UI by default. You can enable them in Preferences, under Integrations, by selecting the SmartBear AI option.

    If you deploy ReadyAPI as part of a managed image, use this parameter to disable AI at startup and remove AI options from the UI.

    -Dreadyapi.enable.ai.features=false
  • -Dtest.history.disabled=<value>: Disables the test history in ReadyAPI Test. Same as the Test History disabled option.

    Example:

    -Dtest.history.disabled=true
  • -DloadTestDisableTimeBarrier=<value>: Controls the LoadTest time barrier in ReadyAPI. The time barrier synchronizes LoadTest execution across threads to maintain consistent timing between requests. Set the value to true to disable the time barrier.

    Use this option to remediate cases where the remote LoadUI agents on a VM have system clocks that are out of synch with the ReadyAPI controller instance.

    Default value: false.

    Example:

    -DloadTestDisableTimeBarrier=true
  • -DupdatesCheckDisable=<value>

    Disables automatic product updates, product update notifications, and the option to check for updates.

    Example:

    -DupdatesCheckDisable=true

UI and desktop (Windows/JxBrowser)

  • -Dsun.java2d.dpiaware=<value>

    Commands Windows to scale the application window. This can be useful for high-resolution monitors. If the value is true, the UI is scaled to fit the screen DPI. The default value is false.

    Example:

    -Dsun.java2d.dpiaware=true
  • -Djxbrowser.chromium.dir=<value>: Specifies the path to the folder where JxBrowser will write information.

    Example:

    -Djxbrowser.chromium.dir=C:\Work\JxBrowserFiles
  • -Ddisable.jxbrowser.basic.auth=<value>

    Disables basic auth for Auth Profile verification.

    Example:

    -Ddisable.jxbrowser.basic.auth=true

Data and JDBC limits

  • -Dmax.virt.resultset.size=<value>: Sets the maximum number of rows in a JDBC virtual response. Default value: 10000.

Mail/MIME parsing

  • -Dmail.mime.parameters.strict=<value>

    Allows/Disallows parameter values to contain whitespace and other special characters without being quoted. If set to true (the default), parameter values must conform to the MIME specification and be quoted if they contain whitespace or special characters.

    Example:

    -Dmail.mime.parameters.strict=false-Xmx1000m

Non-editable properties

Among JVM options, there are several properties that are necessary for the proper operation of ReadyAPI. You should not modify them.

  • -Dsoapui.home

  • -Djava.library.path

  • -Djava.util.Arrays.useLegacyMergeSort

  • -Dsun.net.http.allowRestrictedHeaders

Examples of Usage

See Also

Publication date: