ClientProperties (Extensions for WebDriver 1.5.5 API)

java.lang.Object
- org.finra.jtaf.ewd.impl.ClientProperties

```
public class ClientProperties
extends Object
```
Enables storage of and access to driver and browser configuration.

Constructor Summary

Constructors
Constructor and Description

ClientProperties(Map<String,String> options)

ClientProperties(String filePath)
Constructs a ClientProperties from the given file.

Constructors
Constructor and Description
`ClientProperties(Map<String,String> options)`
`ClientProperties(String filePath)` Constructs a `ClientProperties` from the given file.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAppearWaitTime()` Returns the maximum wait time for elements to appear.
`String`	`getBinaryPath()` Returns the path to the Firefox executable binary.
`String`	`getBrowser()` Returns the name of the browser.
`int`	`getBrowserInitPositionX()` Returns the initial horizontal offset of the browser window.
`int`	`getBrowserInitPositionY()` Returns the initial vertical offset of the browser window.
`String`	`getBrowserVersion()` Returns the version of the browser.
`URL`	`getClient()` Returns the URL represented by this `ClientProperties`.
`boolean`	`getDebugMode()` Returns whether debug mode is enabled.
`String`	`getDownloadFolder()` Returns the directory for downloads.
`List<String>`	`getFirefoxExtensions()` Returns a `List` of Firefox extensions.
`String`	`getFirefoxProfileFile()` Returns the path to the Firefox profile.
`String`	`getFirefoxProfileFolder()` Returns the name of the browser.
`String`	`getGridPlatform()` Returns the Selenium Grid platform.
`String`	`getGridProperties()` Returns the Selenium Grid properties.
`String`	`getGridSaucefile()` Returns the Selenium Grid Sauce File.
`String`	`getGridUrl()` Returns the Saucelabs URL.
`String`	`getHighlightColor(String colorMode)`
`Map<String,String>`	`getHighlightColorMap()`
`String`	`getMaxAllowedSessions()` Returns the maximum allowed number of sessions.
`int`	`getMaxDownloadWaitTime()` Returns the maximum wait time for downloads.
`int`	`getMaxPageWait()` Returns the maximum wait time for pages.
`int`	`getMaxRequestTimeout()` Returns the maximum time out for requests as an `int`.
`String`	`getMaxRequestTimeoutString()` Returns the maximum timeout for requests as a `String`.
`int`	`getNumberOfDaysToKeepTempFolders()` Returns the number of days temporary folders are kept.
`String`	`getOS()` Returns the name of the operating system.
`String`	`getOSVersion()` Returns the version of the operating system.
`String`	`getProxy()` Returns the proxy.
`String`	`getProxyHttps()` Returns the HTTPS proxy.
`String`	`getTempFolderNameContainsList()` Returns the list of folder names to be cleaned with the temp folders.
`String`	`getTunnelIdentifier()`
`String`	`getUploadFolder()` Returns the directory for uploads.
`String`	`getWebDriverChromeDriver()` Returns the path to chromedriver.exe.
`String`	`getWebDriverGeckoDriver()` Returns the path to geckodriver.exe
`String`	`getWebDriverIEDriver()` Returns the path to IEDriverServer.exe.
`boolean`	`isHighlight()` Returns whether elements will be highlighted during execution.
`boolean`	`isKillTasksAtStartup()` Returns whether running driver services are killed at the beginning of execution.
`boolean`	`isUseGrid()` Returns whether Selenium Grid or Saucelabs will be used.
`boolean`	`shouldIgnoreSecurityDomains()`
`boolean`	`shouldSelectLastFrame()` Returns whther the last frame will be automatically selected.

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

- Constructor Detail
  - ClientProperties
```
public ClientProperties(String filePath)
```
    Constructs a ClientProperties from the given file.
    
    Parameters:
    
    filePath - the file to be loaded
  - ClientProperties
```
public ClientProperties(Map<String,String> options)
```
- Method Detail
  - getHighlightColor
```
public String getHighlightColor(String colorMode)
```
  - getHighlightColorMap
```
public Map<String,String> getHighlightColorMap()
```
  - getBrowser
```
public final String getBrowser()
```
    Returns the name of the browser.
    
    Returns:
    
    the name of the browser
  - getBrowserVersion
```
public final String getBrowserVersion()
```
    Returns the version of the browser.
    
    Returns:
    
    the version of the browser
  - getProxy
```
public final String getProxy()
```
    Returns the proxy.
    
    Returns:
    
    the proxy
  - getOS
```
public final String getOS()
```
    Returns the name of the operating system.
    
    Returns:
    
    the name of the operating system
  - getOSVersion
```
public final String getOSVersion()
```
    Returns the version of the operating system.
    
    Returns:
    
    the version of the operating system
  - getMaxDownloadWaitTime
```
public final int getMaxDownloadWaitTime()
```
    Returns the maximum wait time for downloads.
    
    Returns:
    
    the maximum wait time for downloads
  - getDownloadFolder
```
public final String getDownloadFolder()
```
    Returns the directory for downloads.
    
    Returns:
    
    the directory for downloads
  - getUploadFolder
```
public final String getUploadFolder()
```
    Returns the directory for uploads.
    
    Returns:
    
    the directory for uploads
  - getMaxRequestTimeoutString
```
public final String getMaxRequestTimeoutString()
```
    Returns the maximum timeout for requests as a String.
    
    Returns:
    
    the maximum timeout for requests as a String
  - getMaxRequestTimeout
```
public final int getMaxRequestTimeout()
```
    Returns the maximum time out for requests as an int.
    
    Returns:
    
    the maximum time out for requests as an int
  - getMaxPageWait
```
public int getMaxPageWait()
```
    Returns the maximum wait time for pages.
    
    Returns:
    
    the maximum wait time for pages
  - getAppearWaitTime
```
public int getAppearWaitTime()
```
    Returns the maximum wait time for elements to appear.
    
    Returns:
    
    the maximum wait time for elements to appear
  - getMaxAllowedSessions
```
public String getMaxAllowedSessions()
```
    Returns the maximum allowed number of sessions.
    
    Returns:
    
    the maximum allowed number of sessions
  - getBinaryPath
```
public String getBinaryPath()
```
    Returns the path to the Firefox executable binary.
    
    Returns:
    
    the path to the Firefox executable binary
  - getWebDriverIEDriver
```
public String getWebDriverIEDriver()
```
    Returns the path to IEDriverServer.exe.
    
    Returns:
    
    the path to IEDriverServer.exe
  - getWebDriverChromeDriver
```
public String getWebDriverChromeDriver()
```
    Returns the path to chromedriver.exe.
    
    Returns:
    
    the path to chromedriver.exe
  - getWebDriverGeckoDriver
```
public String getWebDriverGeckoDriver()
```
    Returns the path to geckodriver.exe
    
    Returns:
  - getFirefoxProfileFolder
```
public String getFirefoxProfileFolder()
```
    Returns the name of the browser.
    
    Returns:
    
    the name of the browser
  - getFirefoxProfileFile
```
public String getFirefoxProfileFile()
```
    Returns the path to the Firefox profile.
    
    Returns:
    
    the path to the Firefox profile
  - isHighlight
```
public boolean isHighlight()
```
    Returns whether elements will be highlighted during execution.
    
    Returns:
    
    true if and only if elements will be highlighted during execution
  - getFirefoxExtensions
```
public List<String> getFirefoxExtensions()
```
    Returns a List of Firefox extensions.
    
    Returns:
    
    a List of Firefox extensions
  - getNumberOfDaysToKeepTempFolders
```
public int getNumberOfDaysToKeepTempFolders()
```
    Returns the number of days temporary folders are kept.
    
    Returns:
    
    the number of days temporary folders are kept
  - getTempFolderNameContainsList
```
public String getTempFolderNameContainsList()
```
    Returns the list of folder names to be cleaned with the temp folders.
    
    Returns:
    
    the list of folder names to be cleaned with the temp folders
  - getDebugMode
```
public boolean getDebugMode()
```
    Returns whether debug mode is enabled.
    
    Returns:
    
    true if and only if debug mode is enabled
  - isKillTasksAtStartup
```
public boolean isKillTasksAtStartup()
```
    Returns whether running driver services are killed at the beginning of execution.
    
    Returns:
    
    true if and only if running driver services are killed at the beginning of execution
  - shouldSelectLastFrame
```
public boolean shouldSelectLastFrame()
```
    Returns whther the last frame will be automatically selected.
    
    Returns:
    
    true if and only if the last frame will be automatically selected
  - isUseGrid
```
public boolean isUseGrid()
```
    Returns whether Selenium Grid or Saucelabs will be used.
    
    Returns:
    
    true if and only if Selenium Grid or Saucelabs will be used
  - getGridSaucefile
```
public String getGridSaucefile()
```
    Returns the Selenium Grid Sauce File.
    
    Returns:
    
    the Selenium Grid Sauce File
  - getGridPlatform
```
public String getGridPlatform()
```
    Returns the Selenium Grid platform.
    
    Returns:
    
    the Selenium Grid platform
  - getGridProperties
```
public String getGridProperties()
```
    Returns the Selenium Grid properties.
    
    Returns:
    
    the Selenium Grid properties
  - getGridUrl
```
public String getGridUrl()
```
    Returns the Saucelabs URL.
    
    Returns:
    
    the Saucelabs URL
  - getProxyHttps
```
public String getProxyHttps()
```
    Returns the HTTPS proxy.
    
    Returns:
    
    the HTTPS proxy
  - getBrowserInitPositionX
```
public int getBrowserInitPositionX()
```
    Returns the initial horizontal offset of the browser window.
    
    Returns:
    
    the initial horizontal offset of the browser window
  - getBrowserInitPositionY
```
public int getBrowserInitPositionY()
```
    Returns the initial vertical offset of the browser window.
    
    Returns:
    
    the initial vertical offset of the browser window
  - getClient
```
public URL getClient()
```
    Returns the URL represented by this ClientProperties.
    
    Returns:
    
    the URL represented by this ClientProperties
  - getTunnelIdentifier
```
public String getTunnelIdentifier()
```
  - shouldIgnoreSecurityDomains
```
public boolean shouldIgnoreSecurityDomains()
```

Class ClientProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientProperties

ClientProperties

Method Detail

getHighlightColor

getHighlightColorMap

getBrowser

getBrowserVersion

getProxy

getOS

getOSVersion

getMaxDownloadWaitTime

getDownloadFolder

getUploadFolder

getMaxRequestTimeoutString

getMaxRequestTimeout

getMaxPageWait

getAppearWaitTime

getMaxAllowedSessions

getBinaryPath

getWebDriverIEDriver

getWebDriverChromeDriver

getWebDriverGeckoDriver

getFirefoxProfileFolder

getFirefoxProfileFile

isHighlight

getFirefoxExtensions

getNumberOfDaysToKeepTempFolders

getTempFolderNameContainsList

getDebugMode

isKillTasksAtStartup

shouldSelectLastFrame

isUseGrid

getGridSaucefile

getGridPlatform

getGridProperties

getGridUrl

getProxyHttps

getBrowserInitPositionX

getBrowserInitPositionY

getClient

getTunnelIdentifier

shouldIgnoreSecurityDomains