Constants.BrowserConstants (SAFS API DOCUMENT)

java.lang.Object
- org.safs.Constants.BrowserConstants

Enclosing class:: Constants

public abstract static class Constants.BrowserConstants
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BROWSER_NAME_ANDROID_CHROME` 'android.chrome' chrome browser on android
`static java.lang.String`	`BROWSER_NAME_CHROME` 'chrome'
`static java.lang.String`	`BROWSER_NAME_EDGE` 'MicrosoftEdge'
`static java.lang.String`	`BROWSER_NAME_FIREFOX` 'firefox'
`static java.lang.String`	`BROWSER_NAME_HTMLUNIT` 'htmlunit'
`static java.lang.String`	`BROWSER_NAME_IE` 'explorer'
`static java.lang.String`	`BROWSER_NAME_IPAD_SAFARI` 'ipad.safari' safari browser on ios
`static java.lang.String`	`BROWSER_NAME_IPAD_SIMULATOR_SAFARI` 'ipad.sim.safari' simulator on ios
`static java.lang.String`	`BROWSER_NAME_OPERA` 'opera'
`static java.lang.String`	`BROWSER_NAME_OPERA_BLINK` 'operablink'
`static java.lang.String`	`BROWSER_NAME_SAFARI` 'safari'
`static java.lang.String`	`KEY_CHROME_DISABLE_EXTENSIONS` '--disable-extensions' is used to disable the use of Chrome extensions.
`static java.lang.String`	`KEY_CHROME_EXCLUDE_OPTIONS` 'excludeSwitches' the experimental option name for chrome options, it is used to turn off chrome starting options. The value is separated-options to exclude, the separator can be comma(,) or semicolon(;) , like "disable-component-update, ignore-certificate-errors" or "disable-component-update; ignore-certificate-errors", be careful, there are NO 2 hyphens before options, "--disable-component-update, --ignore-certificate-errors" is wrong. Note: As the value, excluded-options, may contain minus like "disable-component-update", it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("disable-component-update") to keep its value.
`static java.lang.String`	`KEY_CHROME_PREFERENCE` 'chrome.perference' the key for chrome command-line-options/preferences file, which contains command-line-options json data, such as { "lang":"zh-cn", "disable-download-notification":"" }, refer to detail options preferences json data, it is indicated by a special key `KEY_CHROME_PREFERENCE_JSON_KEY`, such as { "seplus.chrome.preference.json.key": { "intl.accept_languages":"zh-cn", intl.charset_default:"utf-8" } }, refer to detail preferences
`static java.lang.String`	`KEY_CHROME_PREFERENCE_JSON_KEY` 'seplus.chrome.preference.json.key' the key for chrome preferences, which points to json data, such as { "intl.accept_languages":"zh-cn", intl.charset_default:"utf-8" }, refer to detail preferences
`static java.lang.String`	`KEY_CHROME_PREFS` 'prefs' the key used to set chrome Experimental Option.
`static java.lang.String`	`KEY_CHROME_PROFILE_DIR` 'profile-directory' the parameter name for chrome options, a user-specific settings, it indicates a sub-folder under "user data directory". The value is specified in chrome options Note: As this "profile-directory" contains minus, it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("profile-directory") to keep its value.
`static java.lang.String`	`KEY_CHROME_USER_DATA_DIR` 'user-data-dir' the parameter name for chrome options, a general custom data settings. The value is specified in chrome options Note: As this "user-data-dir" contains minus, it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("user-data-dir") to keep its value.
`static java.lang.String`	`KEY_FIREFOX_PROFILE` 'FirefoxProfile' the key for firefox profile name/filename string; The value is something like "myprofile" or "<AbsolutePath>/ppc2784x.default"
`static java.lang.String`	`KEY_FIREFOX_PROFILE_PREFERENCE` 'firefox.perference' the key for firefox preference file, which contains json data, such as { "intl.accept_languages":"zh-cn", "accessibility.accesskeycausesactivation":false, "browser.download.folderList":2 } Note: Be careful when creating the json data file, do NOT quote boolean or integer value.
`static java.lang.String`	`KEY_PROXY_BYPASS_ADDRESS` 'KEY_PROXY_BYPASS_ADDRESS' the key for proxy bypass address string; The value is comma separated string as "localhost, internal.server"
`static java.lang.String`	`KEY_PROXY_SETTING` 'KEY_PROXY_SETTING' the key for proxy string; The value is colon separated string as "proxyserver:port"

Constructor Summary

Constructors
Constructor and Description

BrowserConstants()

Constructors
Constructor and Description
`BrowserConstants()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String[]`	`getExtraParameterKeys()` Return an array of keys for extra parameters. The format of value for each key is different, please refer to comment of the key.

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

- Field Detail
  - BROWSER_NAME_IE
```
public static final java.lang.String BROWSER_NAME_IE
```
    'explorer'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_CHROME
```
public static final java.lang.String BROWSER_NAME_CHROME
```
    'chrome'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_FIREFOX
```
public static final java.lang.String BROWSER_NAME_FIREFOX
```
    'firefox'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_SAFARI
```
public static final java.lang.String BROWSER_NAME_SAFARI
```
    'safari'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_EDGE
```
public static final java.lang.String BROWSER_NAME_EDGE
```
    'MicrosoftEdge'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_OPERA_BLINK
```
public static final java.lang.String BROWSER_NAME_OPERA_BLINK
```
    'operablink'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_OPERA
```
public static final java.lang.String BROWSER_NAME_OPERA
```
    'opera'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_HTMLUNIT
```
public static final java.lang.String BROWSER_NAME_HTMLUNIT
```
    'htmlunit'
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_ANDROID_CHROME
```
public static final java.lang.String BROWSER_NAME_ANDROID_CHROME
```
    'android.chrome' chrome browser on android
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_IPAD_SAFARI
```
public static final java.lang.String BROWSER_NAME_IPAD_SAFARI
```
    'ipad.safari' safari browser on ios
    
    See Also:
    
    Constant Field Values
  - BROWSER_NAME_IPAD_SIMULATOR_SAFARI
```
public static final java.lang.String BROWSER_NAME_IPAD_SIMULATOR_SAFARI
```
    'ipad.sim.safari' simulator on ios
    
    See Also:
    
    Constant Field Values
  - KEY_PROXY_SETTING
```
public static final java.lang.String KEY_PROXY_SETTING
```
    'KEY_PROXY_SETTING' the key for proxy string; The value is colon separated string as "proxyserver:port"
    
    See Also:
    
    Constant Field Values
  - KEY_PROXY_BYPASS_ADDRESS
```
public static final java.lang.String KEY_PROXY_BYPASS_ADDRESS
```
    'KEY_PROXY_BYPASS_ADDRESS' the key for proxy bypass address string; The value is comma separated string as "localhost, internal.server"
    
    See Also:
    
    Constant Field Values
  - KEY_FIREFOX_PROFILE
```
public static final java.lang.String KEY_FIREFOX_PROFILE
```
    'FirefoxProfile' the key for firefox profile name/filename string; The value is something like "myprofile" or "<AbsolutePath>/ppc2784x.default"
    
    See Also:
    
    Constant Field Values
  - KEY_FIREFOX_PROFILE_PREFERENCE
```
public static final java.lang.String KEY_FIREFOX_PROFILE_PREFERENCE
```
    'firefox.perference' the key for firefox preference file, which contains json data, such as { "intl.accept_languages":"zh-cn", "accessibility.accesskeycausesactivation":false, "browser.download.folderList":2 }
    Note: Be careful when creating the json data file, do NOT quote boolean or integer value.
    
    See Also:
    
    Constant Field Values
  - KEY_CHROME_PREFERENCE
```
public static final java.lang.String KEY_CHROME_PREFERENCE
```
    'chrome.perference' the key for chrome command-line-options/preferences file, which contains
    1. command-line-options json data, such as { "lang":"zh-cn", "disable-download-notification":"" }, refer to detail options
    2. preferences json data, it is indicated by a special key KEY_CHROME_PREFERENCE_JSON_KEY, such as { "seplus.chrome.preference.json.key": { "intl.accept_languages":"zh-cn", intl.charset_default:"utf-8" } }, refer to detail preferences
    See Also:
    
    Constant Field Values
  - KEY_CHROME_PREFERENCE_JSON_KEY
```
public static final java.lang.String KEY_CHROME_PREFERENCE_JSON_KEY
```
    'seplus.chrome.preference.json.key' the key for chrome preferences, which points to json data, such as { "intl.accept_languages":"zh-cn", intl.charset_default:"utf-8" }, refer to detail preferences
    
    See Also:
    
    Constant Field Values
  - KEY_CHROME_PREFS
```
public static final java.lang.String KEY_CHROME_PREFS
```
    'prefs' the key used to set chrome Experimental Option. Used internally.
    
    See Also:
    
    Constant Field Values
  - KEY_CHROME_USER_DATA_DIR
```
public static final java.lang.String KEY_CHROME_USER_DATA_DIR
```
    'user-data-dir' the parameter name for chrome options, a general custom data settings.
    The value is specified in chrome options
    Note: As this "user-data-dir" contains minus, it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("user-data-dir") to keep its value.
    
    See Also:
    
    KEY_CHROME_PROFILE_DIR, Constant Field Values
  - KEY_CHROME_PROFILE_DIR
```
public static final java.lang.String KEY_CHROME_PROFILE_DIR
```
    'profile-directory' the parameter name for chrome options, a user-specific settings, it indicates a sub-folder under "user data directory".
    The value is specified in chrome options
    Note: As this "profile-directory" contains minus, it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("profile-directory") to keep its value.
    
    See Also:
    
    KEY_CHROME_USER_DATA_DIR, Constant Field Values
  - KEY_CHROME_EXCLUDE_OPTIONS
```
public static final java.lang.String KEY_CHROME_EXCLUDE_OPTIONS
```
    'excludeSwitches' the experimental option name for chrome options, it is used to turn off chrome starting options.
    The value is separated-options to exclude, the separator can be comma(,) or semicolon(;) ,
    like "disable-component-update, ignore-certificate-errors" or "disable-component-update; ignore-certificate-errors",
    be careful, there are NO 2 hyphens before options, "--disable-component-update, --ignore-certificate-errors" is wrong.
    Note: As the value, excluded-options, may contain minus like "disable-component-update", it could be interpreted as an arithmetic expression, Use SeleniumPlus.quote("disable-component-update") to keep its value.
    
    See Also:
    
    Constant Field Values
  - KEY_CHROME_DISABLE_EXTENSIONS
```
public static final java.lang.String KEY_CHROME_DISABLE_EXTENSIONS
```
    '--disable-extensions' is used to disable the use of Chrome extensions. Usually, we use it as DEFAULT to avoid popping up 'Disable developer mode extensions' message. In 'SeleniumPlus.StartWebBrowser()' or 'WDLibrary.startBrowser()', we can use 'false' value to cancel this default 'disable' setting. E.g. WDLibrary.startBrowser(BrowserName, Url, Id, timeout, isRemote, quote(SelectBrowser.KEY_CHROME_DISABLE_EXTENSIONS), "false");
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BrowserConstants
```
public BrowserConstants()
```
- Method Detail
  - getExtraParameterKeys
```
public static java.lang.String[] getExtraParameterKeys()
```
    Return an array of keys for extra parameters.
    The format of value for each key is different, please refer to comment of the key.
    
    Returns:
    
    String[], an array of keys used to pass extra parameter in SeleniumPlus
    
    See Also:
    
    KEY_PROXY_BYPASS_ADDRESS, KEY_PROXY_SETTING, KEY_FIREFOX_PROFILE, KEY_FIREFOX_PROFILE_PREFERENCE, KEY_CHROME_PREFERENCE, KEY_CHROME_USER_DATA_DIR, KEY_CHROME_PROFILE_DIR, KEY_CHROME_EXCLUDE_OPTIONS, KEY_CHROME_DISABLE_EXTENSIONS, Constants.SeleniumConstants.KEY_GRID_NODES_SETTING

Class Constants.BrowserConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BROWSER_NAME_IE

BROWSER_NAME_CHROME

BROWSER_NAME_FIREFOX

BROWSER_NAME_SAFARI

BROWSER_NAME_EDGE

BROWSER_NAME_OPERA_BLINK

BROWSER_NAME_OPERA

BROWSER_NAME_HTMLUNIT

BROWSER_NAME_ANDROID_CHROME

BROWSER_NAME_IPAD_SAFARI

BROWSER_NAME_IPAD_SIMULATOR_SAFARI

KEY_PROXY_SETTING

KEY_PROXY_BYPASS_ADDRESS

KEY_FIREFOX_PROFILE

KEY_FIREFOX_PROFILE_PREFERENCE

KEY_CHROME_PREFERENCE

KEY_CHROME_PREFERENCE_JSON_KEY

KEY_CHROME_PREFS

KEY_CHROME_USER_DATA_DIR

KEY_CHROME_PROFILE_DIR

KEY_CHROME_EXCLUDE_OPTIONS

KEY_CHROME_DISABLE_EXTENSIONS

Constructor Detail

BrowserConstants

Method Detail

getExtraParameterKeys