Settings.Builder (com.machinepublishers:jbrowserdriver 0.17.10 API)

java.lang.Object
- com.machinepublishers.jbrowserdriver.Settings.Builder

Enclosing class:

Settings
```
public static class Settings.Builder
extends Object
```
Helps build a Settings object which configures jBrowserDriver. Settings objects can safely be re-used across different instances of JBrowserDriver.

See Also:

JBrowserDriver.JBrowserDriver(Settings)

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings.Builder`	`ajaxResourceTimeout(long timeoutMS)` The time in milliseconds after which an AJAX request will be ignored when considering whether all AJAX requests have completed.
`Settings.Builder`	`ajaxWait(long intervalMS)` The idle time (no pending AJAX requests) required in milliseconds before a page is considered to have been loaded completely.
`Settings.Builder`	`blockAds(boolean blockAds)` Whether requests to ad/spam servers should be blocked.
`Settings`	`build()`
`Capabilities`	`buildCapabilities()`
`Settings.Builder`	`cache(boolean cache)` Whether to cache web pages like a desktop browser would.
`Settings.Builder`	`cacheDir(File cacheDir)` Directory where the web cache resides--this enables sharing a cache across instances and after JVM restarts.
`Settings.Builder`	`cacheEntries(int cacheEntries)` Set maximum number of cached files on disk.
`Settings.Builder`	`cacheEntrySize(long bytes)` Set maximum size of a file to be cached.
`Settings.Builder`	`connectionReqTimeout(int timeoutMS)` Connection request timeout in milliseconds, which is the max time to wait when the max number of connections has already been reached.
`Settings.Builder`	`connectTimeout(int timeoutMS)` Connect timeout in milliseconds, which the is max time until a connection is established.
`Settings.Builder`	`csrf()` Enables CSRF token handling.
`Settings.Builder`	`csrf(String requestToken, String responseToken)` Enables CSRF token handling
`Settings.Builder`	`headless(boolean headless)` Whether to run in headless mode (no GUI windows).
`Settings.Builder`	`headScript(String headScript)` Script to be injected in the HTML Head section.
`Settings.Builder`	`hostnameVerification(boolean hostnameVerification)` Whether the hostname in certificates should be verified.
`Settings.Builder`	`ignoreDialogs(boolean ignoreDialogs)` Whether JavaScript alerts, prompts, and confirm dialogs should be auto-dismissed and ignored.
`Settings.Builder`	`javaBinary(String javaBinary)` The path to the Java executable or the Java command used to launch child JRE browser processes.
`Settings.Builder`	`javaExportModules(boolean javaExportModules)` Allows this library to run on Java 9.
`Settings.Builder`	`javaOptions(String... options)` JVM options, such as Java system properties or Java HotSpot VM options.
`Settings.Builder`	`javascript(boolean isEnabled)` Whether javascript is enabled in the browser.
`Settings.Builder`	`localIp(InetAddress nicAddress)` Used for binding to a specific NIC
`Settings.Builder`	`logger(String name)` The name of a Java Logger to handle log messages.
`Settings.Builder`	`loggerLevel(Level loggerLevel)` At what log level the logger should log
`Settings.Builder`	`logJavascript(boolean logJavascript)` Log the browser console output.
`Settings.Builder`	`logsMax(int logsMax)` Maximum number of log messages (per log type) to store in memory (per process), accessible via the Selenium logging APIs.
`Settings.Builder`	`logTrace(boolean logTrace)` Log details of HTTP requests performed and other info useful for monitoring runtime performance.
`Settings.Builder`	`logWarnings(boolean logWarnings)` Log errors, exceptions, and important notices.
`Settings.Builder`	`logWire(boolean logWire)` Log full requests and responses (excluding response bodies).
`Settings.Builder`	`maxConnections(int maxConnections)` Maximum number of concurrent connections overall (per process).
`Settings.Builder`	`maxRouteConnections(int maxRouteConnections)` Maximum number of concurrent connections (per process) to a specific host+proxy combo.
`Settings.Builder`	`processes(int maxProcesses)` The number of `JBrowserDriver` instances that can run concurrently, using any available port.
`Settings.Builder`	`processes(int maxProcesses, String host)` The number of `JBrowserDriver` instances that can run concurrently, using any available port, and the host name or IP of the local machine.
`Settings.Builder`	`processes(String portRanges)` The ports used by `JBrowserDriver` instances and the parent process.
`Settings.Builder`	`processes(String portRanges, String host)` The ports and host/IP used by `JBrowserDriver` instances and the parent process.
`Settings.Builder`	`proxy(ProxyConfig proxy)` Proxy server to be used.
`Settings.Builder`	`quickRender(boolean quickRender)` Exclude web page images and binary data from rendering.
`Settings.Builder`	`requestHeaders(RequestHeaders requestHeaders)` Headers to be sent on each request.
`Settings.Builder`	`saveAttachments(boolean saveAttachments)` Whether to save links to disk when prompted by the browser.
`Settings.Builder`	`saveMedia(boolean saveMedia)` Whether to save media (e.g., images) to disk.
`Settings.Builder`	`screen(Dimension screen)` Size of the screen and initial size of the window.
`Settings.Builder`	`socketTimeout(int timeoutMS)` Socket timeout in milliseconds, which is the max idle time between any two packets.
`Settings.Builder`	`ssl(String ssl)` Specifies a source of trusted certificate authorities.
`Settings.Builder`	`timezone(Timezone timezone)` Timezone of the browser.
`Settings.Builder`	`userAgent(UserAgent userAgent)` User agent and window.navigator properties.
`Settings.Builder`	`userDataDirectory(File userDataDirectory)` User data/local storage directory used by the browser.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - ajaxResourceTimeout
```
public Settings.Builder ajaxResourceTimeout(long timeoutMS)
```
    The time in milliseconds after which an AJAX request will be ignored when considering whether all AJAX requests have completed.
    Defaults to 2000.
    - Java system property jbd.ajaxresourcetimeout overrides this setting.
    - Capabilities name jbd.ajaxresourcetimeout alternately configures this setting.
    Parameters:
    
    timeoutMS -
    
    Returns:
    
    this Builder
  - ajaxWait
```
public Settings.Builder ajaxWait(long intervalMS)
```
    The idle time (no pending AJAX requests) required in milliseconds before a page is considered to have been loaded completely.
    For very slow or overloaded CPUs, set a higher value.
    Defaults to 150.
    - Java system property jbd.ajaxwait overrides this setting.
    - Capabilities name jbd.ajaxwait alternately configures this setting.
    Parameters:
    
    intervalMS -
    
    Returns:
    
    this Builder
  - blockAds
```
public Settings.Builder blockAds(boolean blockAds)
```
    Whether requests to ad/spam servers should be blocked.
    Based on hosts in ad-hosts.txt in the source tree.
    Defaults to false.
    - Java system property jbd.blockads overrides this setting.
    - Capabilities name jbd.blockads alternately configures this setting.
    Parameters:
    
    blockAds -
    
    Returns:
    
    this Builder
  - build
```
public Settings build()
```
    Returns:
    
    A Settings object created from this builder.
    
    See Also:
    
    JBrowserDriver.JBrowserDriver(Settings)
  - buildCapabilities
```
public Capabilities buildCapabilities()
```
    Returns:
    
    A Selenium Capabilities object for a RemoteWebDriver or Selenium Server
  - cache
```
public Settings.Builder cache(boolean cache)
```
    Whether to cache web pages like a desktop browser would.
    The temporary directory where these files are saved is availble from JBrowserDriver.cacheDir()
    Defaults to false.
    - Java system property jbd.cache overrides this setting.
    - Capabilities name jbd.cache alternately configures this setting.
    Parameters:
    
    cache -
    
    Returns:
    
    this Builder
  - cacheDir
```
public Settings.Builder cacheDir(File cacheDir)
```
    Directory where the web cache resides--this enables sharing a cache across instances and after JVM restarts.
    Defaults to null meaning a temp directory will be generated, available via JBrowserDriver.cacheDir().
    - Java system property jbd.cachedir overrides this setting.
    - Capabilities name jbd.cachedir alternately configures this setting.
    Parameters:
    
    cacheDir - cache directory
    
    Returns:
    
    this Builder
  - cacheEntries
```
public Settings.Builder cacheEntries(int cacheEntries)
```
    Set maximum number of cached files on disk.
    Defaults to 10000.
    - Java system property jbd.cacheentries overrides this setting.
    - Capabilities name jbd.cacheentries alternately configures this setting.
    Parameters:
    
    cacheEntries -
    
    Returns:
    
    this Builder
  - cacheEntrySize
```
public Settings.Builder cacheEntrySize(long bytes)
```
    Set maximum size of a file to be cached. If it's greater than this max, it will not be cached.
    Defaults to 1 MB.
    - Java system property jbd.cacheentrysize overrides this setting.
    - Capabilities name jbd.cacheentrysize alternately configures this setting.
    Parameters:
    
    bytes -
    
    Returns:
    
    this Builder
  - connectionReqTimeout
```
public Settings.Builder connectionReqTimeout(int timeoutMS)
```
    Connection request timeout in milliseconds, which is the max time to wait when the max number of connections has already been reached.
    When the timeout is reached, the connection fails with an exception. Value of 0 means infinite timeout.
    Defaults to -1 (system default).
    - Java system property jbd.connectionreqtimeout overrides this setting.
    - Capabilities name jbd.connectionreqtimeout alternately configures this setting.
    Parameters:
    
    timeoutMS - Timeout in milliseconds
    
    Returns:
    
    this Builder
  - connectTimeout
```
public Settings.Builder connectTimeout(int timeoutMS)
```
    Connect timeout in milliseconds, which the is max time until a connection is established.
    Value of 0 means infinite timeout.
    Defaults to -1 (system default).
    - Java system property jbd.connecttimeout overrides this setting.
    - Capabilities name jbd.connecttimeout alternately configures this setting.
    Parameters:
    
    timeoutMS - Timeout in milliseconds
    
    Returns:
    
    this Builder
  - csrf
```
public Settings.Builder csrf()
```
    Enables CSRF token handling. Searches for XSRF-TOKEN in response headers and sends X-XSRF-TOKEN in request headers.
    
    Returns:
    
    this Builder
  - csrf
```
public Settings.Builder csrf(String requestToken,
                             String responseToken)
```
    Enables CSRF token handling
    
    Parameters:
    
    requestToken - The header to send in each request header
    
    responseToken - The token to search for in response headers
    
    Returns:
    
    this Builder
  - headless
```
public Settings.Builder headless(boolean headless)
```
    Whether to run in headless mode (no GUI windows).
    Screenshots are available in headless mode (see JBrowserDriver.getScreenshotAs(org.openqa.selenium.OutputType)).
    Defaults to true.
    - Java system property jbd.headless overrides this setting.
    - Capabilities name jbd.headless alternately configures this setting.
    Parameters:
    
    headless -
    
    Returns:
    
    this Builder
  - headScript
```
public Settings.Builder headScript(String headScript)
```
    Script to be injected in the HTML Head section.
    Omit <script> tags; they will be added automatically.
    Defaults to Settings.HEAD_SCRIPT.
    - Java system property jbd.headscript overrides this setting.
    - Capabilities name jbd.headscript alternately configures this setting.
    Parameters:
    
    headScript - Script to be injected
    
    Returns:
    
    this Builder
  - hostnameVerification
```
public Settings.Builder hostnameVerification(boolean hostnameVerification)
```
    Whether the hostname in certificates should be verified.
    Defaults to true.
    - Java system property jbd.hostnameverification overrides this setting.
    - Capabilities name jbd.hostnameverification alternately configures this setting.
    Parameters:
    
    hostnameVerification -
    
    Returns:
    
    this Builder
  - ignoreDialogs
```
public Settings.Builder ignoreDialogs(boolean ignoreDialogs)
```
    Whether JavaScript alerts, prompts, and confirm dialogs should be auto-dismissed and ignored. Otherwise, you will need to use JBrowserDriver.switchTo().alert() to accept/dismiss these dialogs.
    Note that if dialogs are not ignored and you are handling them, that calls to alert.accept(), alert.dismiss(), and alert.sendKeys(String) are queued, so there is no need to wait for the dialog to actually be displayed and these calls will not block. Calls to alert.getText() block until an alert is shown (unless a script timeout is reached first).
    Defaults to true.
    - Java system property jbd.ignoredialogs overrides this setting.
    - Capabilities name jbd.ignoredialogs alternately configures this setting.
    Parameters:
    
    ignoreDialogs - True to auto-dismiss alert/prompt/confirm dialogs and relieve the user from having to handle them. False to allow these dialogs to have an effect on the page and force the user to accept/dismiss them.
    
    Returns:
    
    this Builder
  - javaBinary
```
public Settings.Builder javaBinary(String javaBinary)
```
    The path to the Java executable or the Java command used to launch child JRE browser processes.
    Defaults to null, meaning that the same Java executable running the parent process will be used to launch the child processes.
    - Java system property jbd.javabinary overrides this setting.
    - Capabilities name jbd.javabinary alternately configures this setting.
    Parameters:
    
    javaBinary -
    
    Returns:
    
    this Builder
  - javaExportModules
```
public Settings.Builder javaExportModules(boolean javaExportModules)
```
    Allows this library to run on Java 9. Enabling this option precludes running on Java 8.
    Defaults to false (i.e., Java 8 compatible).
    - Java system property jbd.javaexportmodules overrides this setting.
    - Capabilities name jbd.javaexportmodules alternately configures this setting.
    Parameters:
    
    javaExportModules -
    
    Returns:
    
    this Builder
  - javaOptions
```
public Settings.Builder javaOptions(String... options)
```
    JVM options, such as Java system properties or Java HotSpot VM options.
    Each option is a separate string in the array passed in. E.g.,
    .javaOptions("-XX:+PrintCommandLineFlags", "-Xmx1g", "-Djsse.enableSNIExtension=false")
    Note that browser instances are run in a separate Java process which doesn't inherit any options set in the parent process (thus the need for this API).
    By default no options are set.
    - Java system property jbd.javaoptions overrides this setting. The options must be separated by tab (\t).
    - Capabilities name jbd.javaoptions alternately configures this setting. The options must be separated by tab (\t).
    Parameters:
    
    options -
    
    Returns:
    
    this Builder
  - javascript
```
public Settings.Builder javascript(boolean isEnabled)
```
    Whether javascript is enabled in the browser.
    Defaults to true.
    - Java system property jbd.javascript overrides this setting.
    - Capabilities name jbd.javascript alternately configures this setting.
    Parameters:
    
    isEnabled - true to enable Javascript, false otherwise
    
    Returns:
    
    this Builder
  - localIp
```
public Settings.Builder localIp(InetAddress nicAddress)
```
    Used for binding to a specific NIC
    
    Parameters:
    
    nicAddress -
    
    Returns:
  - logger
```
public Settings.Builder logger(String name)
```
    The name of a Java Logger to handle log messages.
    Logs are also available via the Selenium logging APIs--this logger has no effect on that.
    The name can be null or "" meaning no Java Logger will be used.
    Defaults to com.machinepublishers.jbrowserdriver which echos messages to standard out/error.
    - Java system property jbd.logger overrides this setting.
    - Capabilities name jbd.logger alternately configures this setting.
    Parameters:
    
    name -
    
    Returns:
    
    this Builder
  - loggerLevel
```
public Settings.Builder loggerLevel(Level loggerLevel)
```
    At what log level the logger should log
    Defaults to Level.ALL
    The loggerLevel can be null meaning no logging will be done.
    
    Parameters:
    
    loggerLevel -
    
    Returns:
    
    this Builder
  - logJavascript
```
public Settings.Builder logJavascript(boolean logJavascript)
```
    Log the browser console output.
    Defaults to false
    - Java system property jbd.logjavascript overrides this setting.
    - Capabilities name jbd.logjavascript alternately configures this setting.
    Parameters:
    
    logJavascript -
    
    Returns:
  - logsMax
```
public Settings.Builder logsMax(int logsMax)
```
    Maximum number of log messages (per log type) to store in memory (per process), accessible via the Selenium logging APIs.
    Logs are also available via a Java Logger--this max has no effect on that.
    The oldest log entry is dropped once the max is reached. Regardless of this setting, logs are cleared per instance of JBrowserDriver after a call to quit(), reset(), or Logs.get(String).
    A value of zero disables Selenium logging.
    Defaults to 1000.
    - Java system property jbd.logsmax overrides this setting.
    - Capabilities name jbd.logsmax alternately configures this setting.
    Parameters:
    
    logsMax -
    
    Returns:
    
    this Builder
  - logTrace
```
public Settings.Builder logTrace(boolean logTrace)
```
    Log details of HTTP requests performed and other info useful for monitoring runtime performance.
    Defaults to false
    - Java system property jbd.logtrace overrides this setting.
    - Capabilities name jbd.logtrace alternately configures this setting.
    Parameters:
    
    logTrace -
    
    Returns:
    
    this Builder
  - logWarnings
```
public Settings.Builder logWarnings(boolean logWarnings)
```
    Log errors, exceptions, and important notices.
    Defaults to true
    - Java system property jbd.logwarnings overrides this setting.
    - Capabilities name jbd.logwarnings alternately configures this setting.
    Parameters:
    
    logWarnings -
    
    Returns:
    
    this Builder
  - logWire
```
public Settings.Builder logWire(boolean logWire)
```
    Log full requests and responses (excluding response bodies).
    Defaults to false
    - Java system property jbd.logwire overrides this setting.
    - Capabilities name jbd.logwire alternately configures this setting.
    Parameters:
    
    logWire -
    
    Returns:
    
    this Builder
  - maxConnections
```
public Settings.Builder maxConnections(int maxConnections)
```
    Maximum number of concurrent connections overall (per process).
    Defaults to 300.
    - Java system property jbd.maxconnections overrides this setting.
    - Capabilities name jbd.maxconnections alternately configures this setting.
    Parameters:
    
    maxConnections -
    
    Returns:
    
    this Builder
  - maxRouteConnections
```
public Settings.Builder maxRouteConnections(int maxRouteConnections)
```
    Maximum number of concurrent connections (per process) to a specific host+proxy combo.
    Defaults to 8.
    - Java system property jbd.maxrouteconnections overrides this setting.
    - Capabilities name jbd.maxrouteconnections alternately configures this setting.
    Parameters:
    
    maxRouteConnections -
    
    Returns:
    
    this Builder
  - processes
```
public Settings.Builder processes(int maxProcesses)
```
    The number of JBrowserDriver instances that can run concurrently, using any available port.
    Each instance of JBrowserDriver is backed by a separate Java process operated via RMI.
    Overwrites settings specified by any previous calls to processes(..)
    By default any available ports are used, the host is 127.0.0.1, and the max number of concurrent instances is 2 * Runtime.getRuntime().availableProcessors()
    - Java system property jbd.processes overrides this setting.
    - Capabilities name jbd.processes alternately configures this setting.
    Parameters:
    
    maxProcesses -
    
    Returns:
    
    this Builder
  - processes
```
public Settings.Builder processes(int maxProcesses,
                                  String host)
```
    The number of JBrowserDriver instances that can run concurrently, using any available port, and the host name or IP of the local machine.
    Each instance of JBrowserDriver is backed by a separate Java process operated via RMI.
    Overwrites settings specified by any previous calls to processes(..)
    By default any available ports are used, the host is 127.0.0.1, and the max number of concurrent instances is 2 * Runtime.getRuntime().availableProcessors()
    - Java system properties jbd.processes and jbd.host override this setting.
    - Capabilities name jbd.processes and jbd.host alternately configure this setting.
    Parameters:
    
    maxProcesses -
    
    host -
    
    Returns:
    
    this Builder
  - processes
```
public Settings.Builder processes(String portRanges)
```
    The ports used by JBrowserDriver instances and the parent process.
    The max number of instances that can run concurrently is inferred from the number of ports provided (every instance requires three ports -- e.g., for up to 8 instances you need 24 ports).
    Each instance of JBrowserDriver is backed by a separate Java process operated via RMI.
    Overwrites settings specified by any previous calls to processes(..)
    By default any available ports are used, the host is 127.0.0.1, and the max number of concurrent instances is 2 * Runtime.getRuntime().availableProcessors()
    - Java system property jbd.portranges overrides this setting.
    - Capabilities name jbd.portranges alternately configures this setting.
    Parameters:
    
    portRanges - A comma separated list of ports and/or port ranges (ranges are inclusive and separated by a dash) -- e.g., 10000-10007,12500,12502,15376-15380
    
    Returns:
    
    this Builder
  - processes
```
public Settings.Builder processes(String portRanges,
                                  String host)
```
    The ports and host/IP used by JBrowserDriver instances and the parent process.
    The max number of instances that can run concurrently is inferred from the number of ports provided (every instance requires three ports -- e.g., for up to 8 instances you need 24 ports).
    Each instance of JBrowserDriver is backed by a separate Java process operated via RMI.
    Overwrites settings specified by any previous calls to processes(..)
    By default any available ports are used, the host is 127.0.0.1, and the max number of concurrent instances is 2 * Runtime.getRuntime().availableProcessors()
    - Java system properties jbd.portranges and jbd.host override this setting.
    - Capabilities names jbd.portranges and jbd.host alternately configure this setting.
    Parameters:
    
    portRanges - A comma separated list of ports and/or port ranges (ranges are inclusive and separated by a dash) -- e.g., 10000-10007,12500,12502,15376-15380
    
    host -
    
    Returns:
    
    this Builder
  - proxy
```
public Settings.Builder proxy(ProxyConfig proxy)
```
    Proxy server to be used.
    Defaults to a direct connection (no proxy).
    - Java system properties jbd.proxytype, jbd.proxyhost, jbd.proxyport, jbd.proxyusername, jbd.proxypassword, and jbd.proxyexpectcontinue override this setting.
    - Capabilities names jbd.proxytype, jbd.proxyhost, jbd.proxyport, jbd.proxyusername, jbd.proxypassword, and jbd.proxyexpectcontinue alternately configure this setting.
    Parameters:
    
    proxy - Proxy configuration or null.
    
    Returns:
    
    this Builder
  - quickRender
```
public Settings.Builder quickRender(boolean quickRender)
```
    Exclude web page images and binary data from rendering.
    These resources are still requested and can optionally be saved to disk (see the Settings options). Some older versions of Java are inefficient (memory-wise) in rendering images.
    Defaults to false.
    - Java system property jbd.quickrender overrides this setting.
    - Capabilities name jbd.quickrender alternately configures this setting.
    Parameters:
    
    quickRender -
    
    Returns:
    
    this Builder
  - requestHeaders
```
public Settings.Builder requestHeaders(RequestHeaders requestHeaders)
```
    Headers to be sent on each request.
    Defaults to RequestHeaders.TOR.
    (Not configurable via Java system properties or Capabilities. See userAgent(UserAgent) instead.)
    
    Parameters:
    
    requestHeaders -
    
    Returns:
    
    this Builder
    
    See Also:
    
    userAgent(UserAgent)
  - saveAttachments
```
public Settings.Builder saveAttachments(boolean saveAttachments)
```
    Whether to save links to disk when prompted by the browser.
    Attachments are saved as two files in the mediaDir: <identifier>.content (which has the binary content) and <identifier>.metadata (the first line of this file is the URL of the request for this media, the second line is the Content-Type header, and the third line is the Content-Disposition header).
    Saved files are deleted when the JVM exits, so copy them to a different location to persist them permanently.
    The temporary directory where these files are saved is availble from JBrowserDriver.attachmentsDir()
    Defaults to false.
    - Java system property jbd.saveattachments overrides this setting.
    - Capabilities name jbd.saveattachments alternately configures this setting.
    Parameters:
    
    saveAttachments -
    
    Returns:
    
    this Builder
  - saveMedia
```
public Settings.Builder saveMedia(boolean saveMedia)
```
    Whether to save media (e.g., images) to disk.
    Media is saved as two files in the mediaDir: <identifier>.content (which has the binary content) and <identifier>.metadata (the first line of this file is the URL of the request for this media, the second line is the Content-Type header, and the third line is the Content-Disposition header).
    Saved media files are deleted when the JVM exits, so copy them to a different location to persist them permanently.
    The temporary directory where these files are saved is availble from JBrowserDriver.mediaDir()
    Defaults to false.
    - Java system property jbd.savemedia overrides this setting.
    - Capabilities name jbd.savemedia alternately configures this setting.
    Parameters:
    
    saveMedia - Whether to save media (e.g., images) to disk.
    
    Returns:
    
    this Builder
  - screen
```
public Settings.Builder screen(Dimension screen)
```
    Size of the screen and initial size of the window.
    Defaults to 1000x600. This is a typical size for Tor Browser but if you're not using the Tor user agent you might want to specify a more common size such as 1366x768.
    - Java system properties jbd.screenwidth and jbd.screenheight override this setting.
    - Capabilities names jbd.screenwidth and jbd.screenheight alternately configure this setting.
    Parameters:
    
    screen - Screen and window size.
    
    Returns:
    
    this Builder
  - socketTimeout
```
public Settings.Builder socketTimeout(int timeoutMS)
```
    Socket timeout in milliseconds, which is the max idle time between any two packets.
    Value of 0 means infinite timeout.
    Defaults to -1 (system default).
    - Java system property jbd.sockettimeout overrides this setting.
    - Capabilities name jbd.sockettimeout alternately configures this setting.
    Parameters:
    
    timeoutMS - Timeout in milliseconds
    
    Returns:
    
    this Builder
  - ssl
```
public Settings.Builder ssl(String ssl)
```
    Specifies a source of trusted certificate authorities.
    Can take one of four values:
    (1) compatible to accept standard browser certs,
    (2) trustanything to accept any SSL cert,
    (3) a file path, or
    (4) a URL.
    If a file or URL is specified it must follow exactly the format of content like this: https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt
    The default when this property is not set (i.e., when it's null) is your JRE's keystore, so you can use JDK's keytool to import specific certs.
    - Java system property jbd.ssl overrides this setting.
    - Capabilities name jbd.ssl alternately configures this setting.
    Parameters:
    
    ssl -
    
    Returns:
    
    this Builder
  - timezone
```
public Settings.Builder timezone(Timezone timezone)
```
    Timezone of the browser.
    Defaults to Timezone.UTC. This is the timezone of Tor Browser but if you're not using the Tor user agent you might want to use a locale nearer your actual computer, such as Timezone.AMERICA_LOSANGELES if you're in San Francisco.
    - Java system property jbd.timezone overrides this setting. For value, see Timezone.name().
    - Capabilities name jbd.timezone alternately configures this setting. For value, see Timezone.name().
    Parameters:
    
    timezone - Timezone of the browser.
    
    Returns:
    
    this Builder
  - userAgent
```
public Settings.Builder userAgent(UserAgent userAgent)
```
    User agent and window.navigator properties.
    Defaults to UserAgent.TOR.
    - Java system property jbd.useragent overrides this setting and the requestHeaders(RequestHeaders) setting. The value must be one of: tor, chrome.
    - Capabilities name jbd.useragent alternately configures this setting and the requestHeaders(RequestHeaders) setting. The value must be one of: tor, chrome.
    Parameters:
    
    userAgent - Browser's user agent
    
    Returns:
    
    this Builder
    
    See Also:
    
    requestHeaders(RequestHeaders)
  - userDataDirectory
```
public Settings.Builder userDataDirectory(File userDataDirectory)
```
    User data/local storage directory used by the browser. Callers may provide their own directory to share user data across instances or to prevent the user data from being automatically deleted after resets or quits.
    Defaults to null, meaning that a temp directory will be automatically created and destroyed as needed for user data.
    - Java system property jbd.userdatadirectory overrides this setting. Use a string file path as the value.
    - Capabilities name jbd.userdatadirectory alternately configures this setting. Use a string file path as the value.
    Parameters:
    
    userDataDirectory - A directory to store user website data, e.g. localStorage.
    
    Returns:
    
    this Builder
    
    See Also:
    
    WebEngine.userDataDirectory

Class Settings.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

ajaxResourceTimeout

ajaxWait

blockAds

build

buildCapabilities

cache

cacheDir

cacheEntries

cacheEntrySize

connectionReqTimeout

connectTimeout

csrf

csrf

headless

headScript

hostnameVerification

ignoreDialogs

javaBinary

javaExportModules

javaOptions

javascript

localIp

logger

loggerLevel

logJavascript

logsMax

logTrace

logWarnings

logWire

maxConnections

maxRouteConnections

processes

processes

processes

processes

proxy

quickRender

requestHeaders

saveAttachments

saveMedia

screen

socketTimeout

ssl

timezone

userAgent

userDataDirectory