RunConfiguration (OXPath Project 1.0.4 API)

java.lang.Object
- uk.ac.ox.cs.diadem.webapi.configuration.RunConfiguration

```
public class RunConfiguration
extends Object
```
Adapter for the configuration related to the execution of OXPath.

Author:

Ruslan Fayzrakhmanov 19 Nov 2017

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_POSITION_PATH`
`static String`	`COLLECT_STATISTICS_PATH`
`static String`	`DISABLED_CONTENT_TYPE_RELPATH`
`static String`	`DISABLED_CONTENT_TYPES_PATH`
`static String`	`DISABLED_THIRDPARTY_CONTENT_TYPE_RELPATH`
`static String`	`DISABLED_THIRDPARTY_CONTENT_TYPES_PATH`
`static String`	`DISPLAY_NUMBER_PATH`
`static String`	`ENABLE_PLUGINS_PATH`
`static String`	`HEIGHT_PATH`
`static String`	`LATITUDE_PATH`
`static String`	`LONGITUDE_PATH`
`static String`	`PAGE_LOAD_SEC_PATH`
`static String`	`PATH_SEPARATOR`
`static String`	`SCRIPT_TIMEOUT_SEC_PATH`
`static String`	`TOP_LEFT_X_PATH`
`static String`	`TOP_LEFT_Y_PATH`
`static String`	`USE_DEFAULT_EXECUTABLES_PATH`
`static String`	`USE_XVFB_PATH`
`static String`	`USER_AGENT_PATH`
`static String`	`USER_EXECUTABLE_PATH`
`static String`	`WIDTH_PATH`

Constructor Summary

Constructors
Constructor and Description

RunConfiguration(ConfigurationObject config)

Constructors
Constructor and Description
`RunConfiguration(ConfigurationObject config)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RunConfiguration`	`doNotLoadAnyThirdPartyContent()` Shortcut for `#setDisabledThirdPartyContentTypes(WebBrowser.ContentType.values())`
`boolean`	`getAutoPosition()` Auto-position flag for positioning window on screen.
`int`	`getBrowserHeight()`
`int`	`getBrowserWidth()`
`boolean`	`getCollectStatistics()` "Collect statistics" attribute.
`List<WebBrowser.ContentType>`	`getDisabledContentTypes()` Content types (see WebBrowser.ContentType) to be disabled.
`List<WebBrowser.ContentType>`	`getDisabledThirdPartyContentTypes()` Content types (see WebBrowser.ContentType) of third-party web pages to be disabled.
`String`	`getDisplayNumber()` Display number for the XVFB mode enabled.
`boolean`	`getEnablePlugins()` "Enable plug-ins" flag.
`WebDriverBrowserImpl.GeoLocation`	`getGeoLocation()` Geolocation.
`int`	`getPageLoadTimeoutSec()`
`int`	`getPositionXMin()` Leftmost coordinates of the browser window.
`int`	`getPositionYMin()` Topmost coordinates of the browser window.
`int`	`getScriptTimeoutSec()`
`boolean`	`getUseDefaultExecutables()` Use default browser executables (binaries).
`String`	`getUserAgent()` User-Agent HTTP parameter.
`String`	`getUserExecutable()` User-provided browser executables (binaries).
`boolean`	`getXvfbMode()` XVFB Mode.
`RunConfiguration`	`loadOnlyRawHtml()` This is a shortcut for the invocation `#setDisabledContentTypes(WebBrowser.ContentType.values()))`.
`RunConfiguration`	`setAutoPosition(boolean autoPosition)` Auto-position flag for positioning window on screen.
`RunConfiguration`	`setBrowserHeight(int height)`
`RunConfiguration`	`setBrowserWidth(int width)`
`RunConfiguration`	`setCollectStatistics(boolean collectStats)` "Collect statistics" attribute.
`RunConfiguration`	`setDisabledContentTypes(Collection<WebBrowser.ContentType> contypes)` Content types (see WebBrowser.ContentType) to be disabled.
`RunConfiguration`	`setDisabledContentTypes(WebBrowser.ContentType... contypes)` Content types (see WebBrowser.ContentType) to be disabled.
`RunConfiguration`	`setDisabledThirdPartyContentTypes(Collection<WebBrowser.ContentType> contypes)` Content types (see WebBrowser.ContentType) of third-party web pages to be disabled.
`RunConfiguration`	`setDisabledThirdPartyContentTypes(WebBrowser.ContentType... contypes)` Content types (see WebBrowser.ContentType) of third-party web pages to be disabled.
`RunConfiguration`	`setDisplayNumber(String displayNumber)` Display number for the XVFB mode enabled.
`RunConfiguration`	`setEnablePlugins(boolean enablePlugins)` "Enable plug-ins" flag.
`RunConfiguration`	`setGeoLocation(double latitude, double longitude)` Specify a Geographical location.
`RunConfiguration`	`setGeoLocation(WebDriverBrowserImpl.GeoLocation location)` Specify a Geographical location.
`RunConfiguration`	`setPageLoadTimeoutSec(int pageLoadTimeoutSec)`
`RunConfiguration`	`setPositionXMin(int topLeftX)` Leftmost coordinates of the browser window.
`RunConfiguration`	`setPositionYMin(int topLeftY)` Topmost coordinates of the browser window.
`RunConfiguration`	`setScriptTimeoutSec(int scriptTimeoutSec)`
`RunConfiguration`	`setUseDefaultExecutables(boolean useDefaultExecutable)` Use default browser executables (binaries).
`RunConfiguration`	`setUserAgent(String userAgent)` User-Agent HTTP parameter.
`RunConfiguration`	`setUserExecutable(String binaryPath)` User-provided browser executables (binaries).
`RunConfiguration`	`setXvfbMode(boolean useXvfb)` XVFB Mode.

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

- Field Detail
  - PATH_SEPARATOR
```
public static final String PATH_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - COLLECT_STATISTICS_PATH
```
public static final String COLLECT_STATISTICS_PATH
```
    See Also:
    
    Constant Field Values
  - USER_AGENT_PATH
```
public static final String USER_AGENT_PATH
```
    See Also:
    
    Constant Field Values
  - ENABLE_PLUGINS_PATH
```
public static final String ENABLE_PLUGINS_PATH
```
    See Also:
    
    Constant Field Values
  - DISABLED_CONTENT_TYPES_PATH
```
public static final String DISABLED_CONTENT_TYPES_PATH
```
    See Also:
    
    Constant Field Values
  - DISABLED_CONTENT_TYPE_RELPATH
```
public static final String DISABLED_CONTENT_TYPE_RELPATH
```
    See Also:
    
    Constant Field Values
  - DISABLED_THIRDPARTY_CONTENT_TYPES_PATH
```
public static final String DISABLED_THIRDPARTY_CONTENT_TYPES_PATH
```
    See Also:
    
    Constant Field Values
  - DISABLED_THIRDPARTY_CONTENT_TYPE_RELPATH
```
public static final String DISABLED_THIRDPARTY_CONTENT_TYPE_RELPATH
```
    See Also:
    
    Constant Field Values
  - USE_XVFB_PATH
```
public static final String USE_XVFB_PATH
```
    See Also:
    
    Constant Field Values
  - DISPLAY_NUMBER_PATH
```
public static final String DISPLAY_NUMBER_PATH
```
    See Also:
    
    Constant Field Values
  - USE_DEFAULT_EXECUTABLES_PATH
```
public static final String USE_DEFAULT_EXECUTABLES_PATH
```
    See Also:
    
    Constant Field Values
  - USER_EXECUTABLE_PATH
```
public static final String USER_EXECUTABLE_PATH
```
    See Also:
    
    Constant Field Values
  - LATITUDE_PATH
```
public static final String LATITUDE_PATH
```
    See Also:
    
    Constant Field Values
  - LONGITUDE_PATH
```
public static final String LONGITUDE_PATH
```
    See Also:
    
    Constant Field Values
  - SCRIPT_TIMEOUT_SEC_PATH
```
public static final String SCRIPT_TIMEOUT_SEC_PATH
```
    See Also:
    
    Constant Field Values
  - PAGE_LOAD_SEC_PATH
```
public static final String PAGE_LOAD_SEC_PATH
```
    See Also:
    
    Constant Field Values
  - AUTO_POSITION_PATH
```
public static final String AUTO_POSITION_PATH
```
    See Also:
    
    Constant Field Values
  - TOP_LEFT_X_PATH
```
public static final String TOP_LEFT_X_PATH
```
    See Also:
    
    Constant Field Values
  - TOP_LEFT_Y_PATH
```
public static final String TOP_LEFT_Y_PATH
```
    See Also:
    
    Constant Field Values
  - WIDTH_PATH
```
public static final String WIDTH_PATH
```
    See Also:
    
    Constant Field Values
  - HEIGHT_PATH
```
public static final String HEIGHT_PATH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RunConfiguration
```
public RunConfiguration(ConfigurationObject config)
```
    Parameters:
    
    config - Configuration object, wrapping the original configuration.
- Method Detail
  - getCollectStatistics
```
public boolean getCollectStatistics()
```
    "Collect statistics" attribute.
    
    Returns:
  - setCollectStatistics
```
public RunConfiguration setCollectStatistics(boolean collectStats)
```
    "Collect statistics" attribute.
    
    Parameters:
    
    collectStats -
    
    Returns:
  - getUserAgent
```
public String getUserAgent()
```
    User-Agent HTTP parameter.
    
    Returns:
  - setUserAgent
```
public RunConfiguration setUserAgent(String userAgent)
```
    User-Agent HTTP parameter.
    
    Parameters:
    
    userAgent -
    
    Returns:
  - getDisabledContentTypes
```
public List<WebBrowser.ContentType> getDisabledContentTypes()
```
    Content types (see WebBrowser.ContentType) to be disabled.
    
    Returns:
  - setDisabledContentTypes
```
public RunConfiguration setDisabledContentTypes(WebBrowser.ContentType... contypes)
```
    Content types (see WebBrowser.ContentType) to be disabled.
    
    Parameters:
    
    contypes -
    
    Returns:
  - setDisabledContentTypes
```
public RunConfiguration setDisabledContentTypes(Collection<WebBrowser.ContentType> contypes)
```
    Content types (see WebBrowser.ContentType) to be disabled.
    
    Parameters:
    
    contypes -
    
    Returns:
  - loadOnlyRawHtml
```
public RunConfiguration loadOnlyRawHtml()
```
    This is a shortcut for the invocation #setDisabledContentTypes(WebBrowser.ContentType.values())). This will block the loading of any additional resource resulting only in the raw HTML of the page.
    
    Returns:
  - getDisabledThirdPartyContentTypes
```
public List<WebBrowser.ContentType> getDisabledThirdPartyContentTypes()
```
    Content types (see WebBrowser.ContentType) of third-party web pages to be disabled.
    
    Returns:
  - setDisabledThirdPartyContentTypes
```
public RunConfiguration setDisabledThirdPartyContentTypes(WebBrowser.ContentType... contypes)
```
    Content types (see WebBrowser.ContentType) of third-party web pages to be disabled. Blocks the loading of any additional resource of the given content types coming from third-parties (external websites).
    
    Parameters:
    
    contypes -
    
    Returns:
  - setDisabledThirdPartyContentTypes
```
public RunConfiguration setDisabledThirdPartyContentTypes(Collection<WebBrowser.ContentType> contypes)
```
    Content types (see WebBrowser.ContentType) of third-party web pages to be disabled. Blocks the loading of any additional resource of the given content types coming from third-parties (external websites).
    
    Parameters:
    
    contypes -
    
    Returns:
  - doNotLoadAnyThirdPartyContent
```
public RunConfiguration doNotLoadAnyThirdPartyContent()
```
    Shortcut for #setDisabledThirdPartyContentTypes(WebBrowser.ContentType.values())
    
    Returns:
  - getEnablePlugins
```
public boolean getEnablePlugins()
```
    "Enable plug-ins" flag.
    
    Returns:
  - setEnablePlugins
```
public RunConfiguration setEnablePlugins(boolean enablePlugins)
```
    "Enable plug-ins" flag.
    
    Parameters:
    
    enablePlugins -
    
    Returns:
  - getXvfbMode
```
public boolean getXvfbMode()
```
    XVFB Mode.
    
    Returns:
  - setXvfbMode
```
public RunConfiguration setXvfbMode(boolean useXvfb)
```
    XVFB Mode.
    
    Parameters:
    
    useXvfb -
    
    Returns:
  - getDisplayNumber
```
public String getDisplayNumber()
```
    Display number for the XVFB mode enabled.
    
    Returns:
  - setDisplayNumber
```
public RunConfiguration setDisplayNumber(String displayNumber)
```
    Display number for the XVFB mode enabled.
    
    Parameters:
    
    displayNumber -
    
    Returns:
  - getUseDefaultExecutables
```
public boolean getUseDefaultExecutables()
```
    Use default browser executables (binaries).
    
    Returns:
  - setUseDefaultExecutables
```
public RunConfiguration setUseDefaultExecutables(boolean useDefaultExecutable)
```
    Use default browser executables (binaries).
    
    Parameters:
    
    useDefaultExecutable - true: Forces the usage of the provided browser binary, false: user default executables.
    
    Returns:
  - getUserExecutable
```
public String getUserExecutable()
```
    User-provided browser executables (binaries).
    
    Returns:
  - setUserExecutable
```
public RunConfiguration setUserExecutable(String binaryPath)
```
    User-provided browser executables (binaries).
    
    Parameters:
    
    binaryPath -
    
    Returns:
  - getGeoLocation
```
public WebDriverBrowserImpl.GeoLocation getGeoLocation()
```
    Geolocation.
    
    Returns:
  - setGeoLocation
```
public RunConfiguration setGeoLocation(WebDriverBrowserImpl.GeoLocation location)
```
    Specify a Geographical location.
    
    Parameters:
    
    location -
    
    Returns:
  - setGeoLocation
```
public RunConfiguration setGeoLocation(double latitude,
                                       double longitude)
```
    Specify a Geographical location.
    
    Parameters:
    
    latitude -
    
    longitude -
    
    Returns:
  - getScriptTimeoutSec
```
public int getScriptTimeoutSec()
```
    Returns:
  - setScriptTimeoutSec
```
public RunConfiguration setScriptTimeoutSec(int scriptTimeoutSec)
```
    Parameters:
    
    scriptTimeoutSec -
    
    Returns:
  - getPageLoadTimeoutSec
```
public int getPageLoadTimeoutSec()
```
    Returns:
  - setPageLoadTimeoutSec
```
public RunConfiguration setPageLoadTimeoutSec(int pageLoadTimeoutSec)
```
    Parameters:
    
    pageLoadTimeoutSec -
    
    Returns:
  - getBrowserWidth
```
public int getBrowserWidth()
```
    Returns:
  - setBrowserWidth
```
public RunConfiguration setBrowserWidth(int width)
```
    Parameters:
    
    width -
    
    Returns:
  - getBrowserHeight
```
public int getBrowserHeight()
```
    Returns:
  - setBrowserHeight
```
public RunConfiguration setBrowserHeight(int height)
```
    Parameters:
    
    height -
    
    Returns:
  - getAutoPosition
```
public boolean getAutoPosition()
```
    Auto-position flag for positioning window on screen.
    
    Returns:
  - setAutoPosition
```
public RunConfiguration setAutoPosition(boolean autoPosition)
```
    Auto-position flag for positioning window on screen.
    
    Parameters:
    
    autoPosition -
    
    Returns:
  - getPositionXMin
```
public int getPositionXMin()
```
    Leftmost coordinates of the browser window.
    
    Returns:
  - setPositionXMin
```
public RunConfiguration setPositionXMin(int topLeftX)
```
    Leftmost coordinates of the browser window.
    
    Parameters:
    
    topLeftX -
    
    Returns:
  - getPositionYMin
```
public int getPositionYMin()
```
    Topmost coordinates of the browser window.
    
    Returns:
  - setPositionYMin
```
public RunConfiguration setPositionYMin(int topLeftY)
```
    Topmost coordinates of the browser window.
    
    Parameters:
    
    topLeftY -
    
    Returns:

Class RunConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_SEPARATOR

COLLECT_STATISTICS_PATH

USER_AGENT_PATH

ENABLE_PLUGINS_PATH

DISABLED_CONTENT_TYPES_PATH

DISABLED_CONTENT_TYPE_RELPATH

DISABLED_THIRDPARTY_CONTENT_TYPES_PATH

DISABLED_THIRDPARTY_CONTENT_TYPE_RELPATH

USE_XVFB_PATH

DISPLAY_NUMBER_PATH

USE_DEFAULT_EXECUTABLES_PATH

USER_EXECUTABLE_PATH

LATITUDE_PATH

LONGITUDE_PATH

SCRIPT_TIMEOUT_SEC_PATH

PAGE_LOAD_SEC_PATH

AUTO_POSITION_PATH

TOP_LEFT_X_PATH

TOP_LEFT_Y_PATH

WIDTH_PATH

HEIGHT_PATH

Constructor Detail

RunConfiguration

Method Detail

getCollectStatistics

setCollectStatistics

getUserAgent

setUserAgent

getDisabledContentTypes

setDisabledContentTypes

setDisabledContentTypes

loadOnlyRawHtml

getDisabledThirdPartyContentTypes

setDisabledThirdPartyContentTypes

setDisabledThirdPartyContentTypes

doNotLoadAnyThirdPartyContent

getEnablePlugins

setEnablePlugins

getXvfbMode

setXvfbMode

getDisplayNumber

setDisplayNumber

getUseDefaultExecutables

setUseDefaultExecutables

getUserExecutable

setUserExecutable

getGeoLocation

setGeoLocation

setGeoLocation

getScriptTimeoutSec

setScriptTimeoutSec

getPageLoadTimeoutSec

setPageLoadTimeoutSec

getBrowserWidth

setBrowserWidth

getBrowserHeight

setBrowserHeight

getAutoPosition

setAutoPosition

getPositionXMin

setPositionXMin

getPositionYMin

setPositionYMin