Class BrowserConfiguration


  • @Immutable
    public class BrowserConfiguration
    extends Object
    • Field Detail

      • BROWSER_START_RETRIES

        public static final int BROWSER_START_RETRIES
        The total number of retries when a browser can not be created.
        See Also:
        Constant Field Values
      • BROWSER_SLEEP_FAILURE

        public static final long BROWSER_SLEEP_FAILURE
        The number of milliseconds to sleep when a browser can not be created.
      • DEFAULT_BROWSER_BUILDER

        private static final javax.inject.Provider<EmbeddedBrowser> DEFAULT_BROWSER_BUILDER
      • numberOfBrowsers

        private final int numberOfBrowsers
      • browserBuilder

        private final javax.inject.Provider<EmbeddedBrowser> browserBuilder
      • remoteHubUrl

        private String remoteHubUrl
      • desiredCapabilities

        private org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities
    • Constructor Detail

      • BrowserConfiguration

        public BrowserConfiguration​(EmbeddedBrowser.BrowserType browserType)
        This configuration will start one browser of the selected type.
        Parameters:
        browserType - The browser you would like to run.
      • BrowserConfiguration

        public BrowserConfiguration​(EmbeddedBrowser.BrowserType browserType,
                                    int numberOfBrowsers)
        Parameters:
        browserType - The browser you'd like to use.
        numberOfBrowsers - The number of browsers you'd like to use. They will be started as soon as the crawl starts.
      • BrowserConfiguration

        public BrowserConfiguration​(EmbeddedBrowser.BrowserType browserType,
                                    int numberOfBrowsers,
                                    BrowserOptions browserOptions)
        Parameters:
        browserType - The browser you'd like to use.
        numberOfBrowsers - The number of browsers you'd like to use. They will be started as soon as the crawl starts.
        browserOptions - Can specify parameters like pixel density for retina screens or headless options for chrome
      • BrowserConfiguration

        public BrowserConfiguration​(EmbeddedBrowser.BrowserType browserType,
                                    int numberOfBrowsers,
                                    javax.inject.Provider<EmbeddedBrowser> builder)
        Parameters:
        browserType - The browser you'd like to use.
        numberOfBrowsers - The number of browsers you'd like to use. They will be started as soon as the crawl starts.
        builder - a custom WebDriverBrowserBuilder.
    • Method Detail

      • remoteConfig

        public static BrowserConfiguration remoteConfig​(int numberOfBrowsers,
                                                        String remoteUrl,
                                                        org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)
        Parameters:
        numberOfBrowsers - The number of browsers you'd like to use. They will be started as soon as the crawl starts.
        remoteUrl - the URL of the remote HUB
        desiredCapabilities - the desired capabilities to use.
      • getNumberOfBrowsers

        public int getNumberOfBrowsers()
      • getBrowserBuilder

        public javax.inject.Provider<EmbeddedBrowser> getBrowserBuilder()
      • getRemoteHubUrl

        public String getRemoteHubUrl()
      • isDefaultBuilder

        public boolean isDefaultBuilder()
      • getDesiredCapabilities

        public org.openqa.selenium.remote.DesiredCapabilities getDesiredCapabilities()
      • setDesiredCapabilities

        public void setDesiredCapabilities​(org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getLangOrNull

        public String getLangOrNull()
        Returns:
        the language header setting or null if not set.
      • setLang

        public void setLang​(String lang)
        Parameters:
        lang - the language header in http requests
      • setBrowserOptions

        public void setBrowserOptions​(BrowserOptions options)