Settings

java.lang.Object
- com.screenscraper.Settings

public class Settings
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`BUILTIN_BROWSER`
`static java.lang.String`	`DEFAULT_CHARACTER_SET` The character set to use if it hasn't been set previously.
`static java.lang.String`	`DEFAULT_LOOK_AND_FEEL` The Look & Feel if it hasn't been set previously.
`static java.lang.String`	`DEFAULT_USER_AGENT` The default user agent string to use when none is explicitly specified
`static java.lang.String`	`DEFAULT_WEB_BROWSER` Constants to define possible values for the help browser setting.
`static int`	`EDITION_BASIC` Define possible editions.
`static int`	`EDITION_ENTERPRISE`
`static int`	`EDITION_PROFESSIONAL`
`static int`	`EXPORT_CANCEL`
`static int`	`EXPORT_NO`
`static int`	`EXPORT_YES` Constants used in the export prompt.
`static int`	`EXPORT_YES_TO_ALL`
`static java.lang.String`	`iaPropertiesFilePath` The InstallAnywhere settings file path.
`static int`	`IMPORT_CANCEL`
`static int`	`IMPORT_NO`
`static int`	`IMPORT_YES` Constants used in the import prompt.
`static int`	`IMPORT_YES_TO_ALL`
`static org.apache.log4j.Logger`	`log` Used for logging.
`static java.lang.String`	`LOOK_AND_FEEL_NATIVE` The different Look & Feels (Native).
`static java.lang.String`	`LOOK_AND_FEEL_SILVER` The different Look & Feels (Silver).
`static java.lang.String`	`lwsPropertiesFilePath` The LWS settings file path.
`static int`	`RUN_MODE_COMMAND_LINE` Command line run mode
`static int`	`RUN_MODE_SERVER` Server run mode
`static int`	`RUN_MODE_WORKBENCH` Workbench run mode
`static java.lang.String`	`serverVMOptionsFilePath` The screen-scraper.vmoptions path.
`static java.lang.String`	`ssInfoPlistFilePath` The Info.plist path.
`static java.lang.String`	`ssVMOptionsFilePath` The screen-scraper.vmoptions path.
`static int`	`TIDY_DEFAULT_TIDIER`
`static int`	`TIDY_HTML_DONT_TIDY` Used to indicate the type of tidying that should be done.
`static int`	`TIDY_HTML_JERICHO`
`static int`	`TIDY_HTML_JSOUP`
`static int`	`TIDY_HTML_JTIDY`
`static int`	`TIDY_HTML_NEKO`
`static int`	`TIDY_JSON`
`static int`	`TIDY_XML`
`static java.lang.String`	`wPropertiesFilePath` The wrapper settings file path.

Constructor Summary

Constructors
Constructor and Description

Settings()

Constructors
Constructor and Description
`Settings()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`allowNavigationActions()` Indicates whether or not navigation actions are to be allowed.
`static boolean`	`allowScriptExport()` Flag to skip script exports.
`static java.lang.String`	`convertEditionNumberToString(int edition)` Converts the given number to the edition name
`static boolean`	`displayBreakpointWindowOutsideOfWorkbench()` Indicates whether or not the breakpoint window should be displayed outside of the workbench.
`static boolean`	`doesUserWantToViewTutorials()` Indicates whether or not the user would like to view the tutorials.
`static boolean`	`enableCachingAndFilteringDataSets()` Indicates whether or not caching and filtering of data sets should be enabled.
`static boolean`	`enableCodeFoldingInLastResponse()` Returns whether code folding should be enabled in the last response tab or not
`static boolean`	`filterHTTPTransactions()` Indicates whether or not HTTP transactions in the proxy should be filtered by their usefulness.
`static java.lang.String`	`getALEFilePath()` Gets the path to the ALE file, based on the edition running.
`static java.lang.Object[]`	`getAllAvailableFontNames()` Gets a list of the names of all fonts on the system.
`static boolean`	`getAllowMultipleSimultaneousInstances()` Indicates whether or not to disallow multiple instances of ss running simultaneously (e.g., workbench and server running at the same time).
`static boolean`	`getAllowProxyScripting()` Indicates whether or not proxy scripting should be allowed.
`static boolean`	`getAllowUnstableWindowsFeatures()` Indicates whether or not unstable Windows features should be made available in the workbench UI.
`static java.lang.String`	`getAnonymizationURLPrepend()` Gets the URL to pre-pend to anonymization requests.
`static java.lang.String`	`getAPIURLPrepend()` Gets the URL to pre-pend to API requests.
`static int`	`getAutoCompleteDelay()` Gets how long to delay before the auto-complete box appears.
`static boolean`	`getCheckForUpdatesOnStartup()` Indicates whether or not a check for updates should occur when ss starts up.
`static boolean`	`getCheckLogAutoScroll()` Indicates whether or not the auto-scroll checkbox should be checked.
`static int`	`getConnectionTimeout()` Returns the connection timeout, in seconds, for the http connections
`static boolean`	`getConvertHTMLEntitiesByDefault()` Indicates whether or not the "Convert HTML entities" checkbox should be checked by default.
`static long`	`getDataExtractorTimeout()` Gets the data extractor timeout value.
`static java.lang.String`	`getDefaultCharacterSet()` Gets the default character set to use when displaying HTML, extractor patterns, and extracted data.
`static java.awt.Font`	`getDefaultFont()` Gets the default font to use when displaying HTML, extractor patterns, and extracted data.
`static int`	`getEdition()` Gets the edition we're running as.
`static java.lang.String`	`getEditionAsString()` Gets a string representative of the edition.
`static boolean`	`getForceOverwriteScripts()` Indicates whether or not all scripts should be force overwritten.
`static java.lang.String`	`getIPAddressesToAllow()` Gets the IP addresses that should be allowed to connect to the ss server.
`static java.lang.String`	`getKeyManagerFactory()` The key manager factory to use.
`static java.lang.String`	`getLookAndFeel()` Gets the Look & Feel.
`static boolean`	`getMarkScriptOccurrences()` Returns whether or not hovering the caret in the script editor should highlight matching text
`static int`	`getMaxConcurrentScrapingSessions()` Returns the maximum number of concurrent scraping sessions allowed
`static int`	`getMaximumDisplayedLastResponseLength()` Gets the maximum length of displayed text in the "Last Response" tab.
`static int`	`getMaximumMemoryAllocation()` Gets the value of the MaximumMemoryAllocation property.
`static int`	`getMaximumNumberOfRedirects()` Gets the maximum number of times an HTTP redirect should be allowed for a given transaction.
`static int`	`getMaximumNumberOfScrapeableSessions()` Gets the maximum number of scrapeable sessions that should be loaded from the database.
`static int`	`getMaximumProxyWaits()` Gets the maximum number of times screen-scraper should attempt to connect to a proxy before giving up.
`static int`	`getMaxScrapingSessionLogFileSize()` Gets the maximum size of a scraping session log file in megabytes.
`static int`	`getMinLoggingLevel()` Returns the minimum logging level the instance will allow for all scrapes.
`static int`	`getNumRecentScriptsToShow()` Returns how many recent scripts to show in the script selection dropdown
`static int`	`getNumTimesCommandLineHasBeenRun()` Gets the number of times the command line has been run.
`static int`	`getNumTimesServerHasBeenRun()` Gets the number of times the server has been run.
`static int`	`getNumTimesWorkbenchHasBeenRun()` Gets the number of times the workbench has been run.
`static java.util.Properties`	`getProperties()` Returns a reference to the `Properties` object.
`static int`	`getRequestTimeout()` Returns the timeout, in seconds, for the downloading a page or block of content.
`static int`	`getRunMode()` Gets the current run mode, as defined by one of the RUN_MODE constants defined in this class.
`static java.lang.String`	`getRunModeAsString()` Returns a string representation of the run mode.
`static boolean`	`getSaveLargeFields()` Indicates whether or not large fields should be saved to the database.
`static java.lang.String`	`getScriptScrapeNamePrefixDelimiter()` Returns the delimiter to use between scrape name and script name.
`static boolean`	`getShouldHideWrapNotifications()` Gets the user's preference on whether or not screen-scraper should hide notifications when a ScrapeableFile's response can't be wrapped.
`static int`	`getSocketLinger()` The socket linger amount, or negative to use the default value.
`static java.lang.String`	`getStartPageURLPrepend()` Gets the URL to be pre-pended when displaying the start page.
`static boolean`	`getTrimWhiteSpaceByDefault()` Indicates whether or not the "Convert HTML entities" checkbox should be checked by default.
`static int`	`getTruncateWorkbenchRequestPOSTDataLength()` Gets the length at which to truncate POST data in the workbench, for display purposes
`static boolean`	`getUseGlobalExternalProxyForAllScrapingSessions()` Indicates whether or not the global proxy settings should be used for all scraping sessions.
`static java.lang.String`	`getWebInterfacePassword()` Returns the password that can access the web interface by login (rather than by being on the correct ip)
`static java.lang.String`	`getWebInterfaceUser()` Returns the username that can access the web interface by login (rather than by being on the correct ip)
`static int`	`getWebPort()` Gets the web port as an int.
`static void`	`incrementNumTimesCommandLineHasBeenRun()` Increments the number of times the command line has been run.
`static void`	`incrementNumTimesServerHasBeenRun()` Increments the number of times the server has been run.
`static void`	`incrementNumTimesWorkbenchHasBeenRun()` Increments the number of times the workbench has been run.
`static boolean`	`instrumentationEnabled()` Indicates whether or not instrumentation is enabled for memory profiling.
`static boolean`	`isActionAllowed(int requiredEdition, int originatorEdition)` Indicates whether or not an action is allowed based on the required edition.
`static boolean`	`isEditionEnterpriseOrBetter()` Indicates whether or not the edition is Enterprise or better.
`static boolean`	`isEditionProOrBetter()` Indicates whether or not the edition is Professional or better.
`static boolean`	`isFalseEnterprise()` Ensures that someone hasn't tried to upgrade to enterprise simply by altering the property in the properties file.
`static boolean`	`isFalseProfessional()` Ensures that someone hasn't tried to upgrade from basic to professional simply by altering the property in the properties file.
`static void`	`load()` Loads the settings.
`static void`	`main(java.lang.String[] args)` An entry point for programmatically manipulating settings.
`static void`	`regenerateBatchAndShellScripts()` Regenerates the batch files and shell scripts.
`static void`	`reload()` Reloads the properties from the properties file.
`static void`	`save()` Saves the settings.
`static void`	`setDefaultCharacterSet(java.lang.String characterSet)` Sets the default character set.
`static void`	`setInstallDirectory(java.lang.String installDirectory)` Sets the install directory, including modifying the batch/shell scripts.
`static void`	`setLookAndFeel(java.lang.String lookAndFeel)` Sets the Look & Feel.
`static void`	`setMaximumMemoryAllocation(int heapSize)` Sets the maximum heap size the app will use when being run in GUI mode.
`static void`	`setRunMode(int runMode)` Sets the current run mode, as defined by one of the RUN_MODE constants defined in this class.
`static void`	`setShouldHideWrapNotifications(boolean wrap)` Sets the "HideTextWrapNotifications" property to the given value.
`static void`	`setSOAPPort(int port)` Sets the port that SOAP listens on in both the screen-scraper properties and in the LWS conf file.
`static boolean`	`shouldBackUpInternalDb()` Indicates whether or not the internal db should be automatically backed up.
`static boolean`	`shouldLogHighMemoryUse()` Returns whether high memory use information should be logged.
`static boolean`	`shouldWrapLastRequestText()` Indicates whether or not text in the last request text box should be wrapped.
`static boolean`	`shouldWrapLastResponseText()` Indicates whether or not text in the last response text box should be wrapped.
`static boolean`	`shouldWrapScriptText()` Indicates whether or not text in the script text box should be wrapped.
`static boolean`	`useFastWorkbenchLogging()` Returns whether or not fast workbench logging should be used.
`static void`	`userDoesNotWantToViewTutorials()` Indicates that the user does not want to view the tutorials.
`static void`	`userWantsToViewTutorials()` Indicates that the user wants to view the tutorials.
`static void`	`verifyMemoryAllocationSetting()` Verifies that the InstallAnywhere properties file has received the memory allocation setting.

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

- Field Detail
  - DEFAULT_USER_AGENT
```
public static final java.lang.String DEFAULT_USER_AGENT
```
    The default user agent string to use when none is explicitly specified
    
    See Also:
    
    Constant Field Values
  - log
```
public static org.apache.log4j.Logger log
```
    Used for logging.
  - iaPropertiesFilePath
```
@NotNull
public static java.lang.String iaPropertiesFilePath
```
    The InstallAnywhere settings file path.
  - wPropertiesFilePath
```
@NotNull
public static java.lang.String wPropertiesFilePath
```
    The wrapper settings file path.
  - lwsPropertiesFilePath
```
@NotNull
public static java.lang.String lwsPropertiesFilePath
```
    The LWS settings file path.
  - ssVMOptionsFilePath
```
@NotNull
public static java.lang.String ssVMOptionsFilePath
```
    The screen-scraper.vmoptions path.
  - serverVMOptionsFilePath
```
@NotNull
public static java.lang.String serverVMOptionsFilePath
```
    The screen-scraper.vmoptions path.
  - ssInfoPlistFilePath
```
@NotNull
public static java.lang.String ssInfoPlistFilePath
```
    The Info.plist path.
  - DEFAULT_WEB_BROWSER
```
public static final java.lang.String DEFAULT_WEB_BROWSER
```
    Constants to define possible values for the help browser setting.
    
    See Also:
    
    Constant Field Values
  - BUILTIN_BROWSER
```
public static final java.lang.String BUILTIN_BROWSER
```
    See Also:
    
    Constant Field Values
  - EDITION_BASIC
```
public static final int EDITION_BASIC
```
    Define possible editions.
    
    See Also:
    
    Constant Field Values
  - EDITION_PROFESSIONAL
```
public static final int EDITION_PROFESSIONAL
```
    See Also:
    
    Constant Field Values
  - EDITION_ENTERPRISE
```
public static final int EDITION_ENTERPRISE
```
    See Also:
    
    Constant Field Values
  - IMPORT_YES
```
public static final int IMPORT_YES
```
    Constants used in the import prompt.
    
    See Also:
    
    Constant Field Values
  - IMPORT_NO
```
public static final int IMPORT_NO
```
    See Also:
    
    Constant Field Values
  - IMPORT_YES_TO_ALL
```
public static final int IMPORT_YES_TO_ALL
```
    See Also:
    
    Constant Field Values
  - IMPORT_CANCEL
```
public static final int IMPORT_CANCEL
```
    See Also:
    
    Constant Field Values
  - EXPORT_YES
```
public static final int EXPORT_YES
```
    Constants used in the export prompt.
    
    See Also:
    
    Constant Field Values
  - EXPORT_NO
```
public static final int EXPORT_NO
```
    See Also:
    
    Constant Field Values
  - EXPORT_YES_TO_ALL
```
public static final int EXPORT_YES_TO_ALL
```
    See Also:
    
    Constant Field Values
  - EXPORT_CANCEL
```
public static final int EXPORT_CANCEL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARACTER_SET
```
public static final java.lang.String DEFAULT_CHARACTER_SET
```
    The character set to use if it hasn't been set previously.
    
    See Also:
    
    Constant Field Values
  - LOOK_AND_FEEL_NATIVE
```
public static final java.lang.String LOOK_AND_FEEL_NATIVE
```
    The different Look & Feels (Native).
    
    See Also:
    
    Constant Field Values
  - LOOK_AND_FEEL_SILVER
```
public static final java.lang.String LOOK_AND_FEEL_SILVER
```
    The different Look & Feels (Silver).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOOK_AND_FEEL
```
public static final java.lang.String DEFAULT_LOOK_AND_FEEL
```
    The Look & Feel if it hasn't been set previously.
    
    See Also:
    
    Constant Field Values
  - RUN_MODE_COMMAND_LINE
```
public static final int RUN_MODE_COMMAND_LINE
```
    Command line run mode
    
    See Also:
    
    Constant Field Values
  - RUN_MODE_SERVER
```
public static final int RUN_MODE_SERVER
```
    Server run mode
    
    See Also:
    
    Constant Field Values
  - RUN_MODE_WORKBENCH
```
public static final int RUN_MODE_WORKBENCH
```
    Workbench run mode
    
    See Also:
    
    Constant Field Values
  - TIDY_HTML_DONT_TIDY
```
public static final int TIDY_HTML_DONT_TIDY
```
    Used to indicate the type of tidying that should be done.
    
    See Also:
    
    Constant Field Values
  - TIDY_HTML_JTIDY
```
public static final int TIDY_HTML_JTIDY
```
    See Also:
    
    Constant Field Values
  - TIDY_HTML_NEKO
```
public static final int TIDY_HTML_NEKO
```
    See Also:
    
    Constant Field Values
  - TIDY_HTML_JERICHO
```
public static final int TIDY_HTML_JERICHO
```
    See Also:
    
    Constant Field Values
  - TIDY_HTML_JSOUP
```
public static final int TIDY_HTML_JSOUP
```
    See Also:
    
    Constant Field Values
  - TIDY_JSON
```
public static final int TIDY_JSON
```
    See Also:
    
    Constant Field Values
  - TIDY_XML
```
public static final int TIDY_XML
```
    See Also:
    
    Constant Field Values
  - TIDY_DEFAULT_TIDIER
```
public static final int TIDY_DEFAULT_TIDIER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - load
```
public static void load()
```
    Loads the settings.
  - reload
```
public static void reload()
```
    Reloads the properties from the properties file.
  - getMaxConcurrentScrapingSessions
```
public static int getMaxConcurrentScrapingSessions()
```
    Returns the maximum number of concurrent scraping sessions allowed
    
    Returns:
    
    The maximum number of concurrent scraping sessions allowed
  - save
```
public static void save()
```
    Saves the settings.
  - getProperties
```
@NotNull
public static java.util.Properties getProperties()
```
    Returns a reference to the Properties object.
    
    Returns:
    
    The Properties object.
  - getMaximumDisplayedLastResponseLength
```
public static int getMaximumDisplayedLastResponseLength()
```
    Gets the maximum length of displayed text in the "Last Response" tab.
    
    Returns:
    
    The maximum length.
  - getMaximumNumberOfRedirects
```
public static int getMaximumNumberOfRedirects()
```
    Gets the maximum number of times an HTTP redirect should be allowed for a given transaction.
    
    Returns:
    
    The maximum number of redirects.
  - getAutoCompleteDelay
```
public static int getAutoCompleteDelay()
```
    Gets how long to delay before the auto-complete box appears.
    
    Returns:
    
    The amount of time in milliseconds.
  - getMaximumProxyWaits
```
public static int getMaximumProxyWaits()
```
    Gets the maximum number of times screen-scraper should attempt to connect to a proxy before giving up.
    
    Returns:
    
    The maximum number of waits.
  - useFastWorkbenchLogging
```
public static boolean useFastWorkbenchLogging()
```
    Returns whether or not fast workbench logging should be used. The downsides are the logs can get choppy since it doesn't render them fast enough, but the logs will also be faster
    
    Returns:
    
    Whether or not fast workbench logging should be used
  - getShouldHideWrapNotifications
```
public static boolean getShouldHideWrapNotifications()
```
    Gets the user's preference on whether or not screen-scraper should hide notifications when a ScrapeableFile's response can't be wrapped.
    
    Returns:
    
    True if the user wants to hide text-wrap notifications, false otherwise.
  - setShouldHideWrapNotifications
```
public static void setShouldHideWrapNotifications(boolean wrap)
```
    Sets the "HideTextWrapNotifications" property to the given value.
    
    Parameters:
    
    wrap - The value to set the "HideTextWrapNotifications" property to.
  - getLookAndFeel
```
@Nullable
public static java.lang.String getLookAndFeel()
```
    Gets the Look & Feel.
    
    Returns:
    
    The Look & Feel.
  - setLookAndFeel
```
public static void setLookAndFeel(java.lang.String lookAndFeel)
```
    Sets the Look & Feel.
    
    Parameters:
    
    lookAndFeel - The Look & Feel to use.
  - getIPAddressesToAllow
```
@Nullable
public static java.lang.String getIPAddressesToAllow()
```
    Gets the IP addresses that should be allowed to connect to the ss server.
    
    Returns:
    
    Whatever the settings file contains for this setting.
  - getDefaultCharacterSet
```
@NotNull
public static java.lang.String getDefaultCharacterSet()
```
    Gets the default character set to use when displaying HTML, extractor patterns, and extracted data.
    
    Returns:
    
    The character set.
  - setDefaultCharacterSet
```
public static void setDefaultCharacterSet(java.lang.String characterSet)
```
    Sets the default character set.
    
    Parameters:
    
    characterSet - The default character set to use.
  - getDefaultFont
```
public static java.awt.Font getDefaultFont()
```
    Gets the default font to use when displaying HTML, extractor patterns, and extracted data.
    
    Returns:
    
    The font.
  - getMaximumMemoryAllocation
```
public static int getMaximumMemoryAllocation()
```
    Gets the value of the MaximumMemoryAllocation property.
    
    Returns:
    
    The value as an int.
  - verifyMemoryAllocationSetting
```
public static void verifyMemoryAllocationSetting()
```
    Verifies that the InstallAnywhere properties file has received the memory allocation setting.
  - getAllAvailableFontNames
```
@NotNull
public static java.lang.Object[] getAllAvailableFontNames()
```
    Gets a list of the names of all fonts on the system.
    
    Returns:
    
    An array of strings containing the names.
  - getNumTimesWorkbenchHasBeenRun
```
public static int getNumTimesWorkbenchHasBeenRun()
```
    Gets the number of times the workbench has been run.
    
    Returns:
    
    The number of times it's been run.
  - incrementNumTimesWorkbenchHasBeenRun
```
public static void incrementNumTimesWorkbenchHasBeenRun()
```
    Increments the number of times the workbench has been run.
  - getNumTimesServerHasBeenRun
```
public static int getNumTimesServerHasBeenRun()
```
    Gets the number of times the server has been run.
    
    Returns:
    
    The number of times it's been run.
  - incrementNumTimesServerHasBeenRun
```
public static void incrementNumTimesServerHasBeenRun()
```
    Increments the number of times the server has been run.
  - getNumTimesCommandLineHasBeenRun
```
public static int getNumTimesCommandLineHasBeenRun()
```
    Gets the number of times the command line has been run.
    
    Returns:
    
    The number of times it's been run.
  - getMaxScrapingSessionLogFileSize
```
public static int getMaxScrapingSessionLogFileSize()
```
    Gets the maximum size of a scraping session log file in megabytes.
    
    Returns:
    
    The maximum size.
  - incrementNumTimesCommandLineHasBeenRun
```
public static void incrementNumTimesCommandLineHasBeenRun()
```
    Increments the number of times the command line has been run.
  - getDataExtractorTimeout
```
public static long getDataExtractorTimeout()
```
    Gets the data extractor timeout value.
    
    Returns:
    
    A long.
  - getScriptScrapeNamePrefixDelimiter
```
@NotNull
public static java.lang.String getScriptScrapeNamePrefixDelimiter()
```
    Returns the delimiter to use between scrape name and script name. This value is used when showing scripts in the selection box to put scripts with the current scrape name near the top of the list
    
    Returns:
    
    The delimiter to use between scrape name and script name. This value is used when showing scripts in the selection box to put scripts with the current scrape name near the top of the list
  - doesUserWantToViewTutorials
```
public static boolean doesUserWantToViewTutorials()
```
    Indicates whether or not the user would like to view the tutorials.
    
    Returns:
    
    A boolean.
  - allowNavigationActions
```
public static boolean allowNavigationActions()
```
    Indicates whether or not navigation actions are to be allowed.
    
    Returns:
    
    A boolean.
  - instrumentationEnabled
```
public static boolean instrumentationEnabled()
```
    Indicates whether or not instrumentation is enabled for memory profiling.
    
    Returns:
    
    A boolean.
  - shouldBackUpInternalDb
```
public static boolean shouldBackUpInternalDb()
```
    Indicates whether or not the internal db should be automatically backed up.
    
    Returns:
    
    A boolean.
  - getStartPageURLPrepend
```
public static java.lang.String getStartPageURLPrepend()
```
    Gets the URL to be pre-pended when displaying the start page.
    
    Returns:
    
    The base URL.
  - enableCachingAndFilteringDataSets
```
public static boolean enableCachingAndFilteringDataSets()
```
    Indicates whether or not caching and filtering of data sets should be enabled.
    
    Returns:
    
    A boolean.
  - displayBreakpointWindowOutsideOfWorkbench
```
public static boolean displayBreakpointWindowOutsideOfWorkbench()
```
    Indicates whether or not the breakpoint window should be displayed outside of the workbench.
    
    Returns:
    
    A boolean.
  - shouldWrapScriptText
```
public static boolean shouldWrapScriptText()
```
    Indicates whether or not text in the script text box should be wrapped.
    
    Returns:
    
    A boolean.
  - shouldWrapLastResponseText
```
public static boolean shouldWrapLastResponseText()
```
    Indicates whether or not text in the last response text box should be wrapped.
    
    Returns:
    
    A boolean.
  - shouldWrapLastRequestText
```
public static boolean shouldWrapLastRequestText()
```
    Indicates whether or not text in the last request text box should be wrapped.
    
    Returns:
    
    A boolean.
  - filterHTTPTransactions
```
public static boolean filterHTTPTransactions()
```
    Indicates whether or not HTTP transactions in the proxy should be filtered by their usefulness.
    
    Returns:
    
    A boolean.
  - userDoesNotWantToViewTutorials
```
public static void userDoesNotWantToViewTutorials()
```
    Indicates that the user does not want to view the tutorials.
  - userWantsToViewTutorials
```
public static void userWantsToViewTutorials()
```
    Indicates that the user wants to view the tutorials.
  - setMaximumMemoryAllocation
```
public static void setMaximumMemoryAllocation(int heapSize)
```
    Sets the maximum heap size the app will use when being run in GUI mode.
    
    Parameters:
    
    heapSize - The heap size, in mega-bytes.
  - setSOAPPort
```
public static void setSOAPPort(int port)
```
    Sets the port that SOAP listens on in both the screen-scraper properties and in the LWS conf file.
    
    Parameters:
    
    port - The port number that SOAP will listen on.
  - getWebPort
```
public static int getWebPort()
```
    Gets the web port as an int.
    
    Returns:
    
    The web port.
  - getAPIURLPrepend
```
public static java.lang.String getAPIURLPrepend()
```
    Gets the URL to pre-pend to API requests.
    
    Returns:
    
    A string.
  - getAnonymizationURLPrepend
```
public static java.lang.String getAnonymizationURLPrepend()
```
    Gets the URL to pre-pend to anonymization requests.
    
    Returns:
    
    A string.
  - getCheckForUpdatesOnStartup
```
public static boolean getCheckForUpdatesOnStartup()
```
    Indicates whether or not a check for updates should occur when ss starts up.
    
    Returns:
    
    A boolean.
  - getCheckLogAutoScroll
```
public static boolean getCheckLogAutoScroll()
```
    Indicates whether or not the auto-scroll checkbox should be checked.
    
    Returns:
    
    A boolean.
  - getForceOverwriteScripts
```
public static boolean getForceOverwriteScripts()
```
    Indicates whether or not all scripts should be force overwritten.
    
    Returns:
    
    A boolean.
  - getConvertHTMLEntitiesByDefault
```
public static boolean getConvertHTMLEntitiesByDefault()
```
    Indicates whether or not the "Convert HTML entities" checkbox should be checked by default.
    
    Returns:
    
    A boolean.
  - getKeyManagerFactory
```
public static java.lang.String getKeyManagerFactory()
```
    The key manager factory to use.
    
    Returns:
    
    A string.
  - getTrimWhiteSpaceByDefault
```
public static boolean getTrimWhiteSpaceByDefault()
```
    Indicates whether or not the "Convert HTML entities" checkbox should be checked by default.
    
    Returns:
    
    A boolean.
  - getAllowProxyScripting
```
public static boolean getAllowProxyScripting()
```
    Indicates whether or not proxy scripting should be allowed.
    
    Returns:
    
    A boolean.
  - getAllowUnstableWindowsFeatures
```
public static boolean getAllowUnstableWindowsFeatures()
```
    Indicates whether or not unstable Windows features should be made available in the workbench UI.
    
    Returns:
    
    A boolean.
  - getUseGlobalExternalProxyForAllScrapingSessions
```
public static boolean getUseGlobalExternalProxyForAllScrapingSessions()
```
    Indicates whether or not the global proxy settings should be used for all scraping sessions.
    
    Returns:
    
    A boolean.
  - getAllowMultipleSimultaneousInstances
```
public static boolean getAllowMultipleSimultaneousInstances()
```
    Indicates whether or not to disallow multiple instances of ss running simultaneously (e.g., workbench and server running at the same time).
    
    Returns:
    
    A boolean.
  - getSaveLargeFields
```
public static boolean getSaveLargeFields()
```
    Indicates whether or not large fields should be saved to the database.
    
    Returns:
    
    A boolean.
  - setInstallDirectory
```
public static void setInstallDirectory(@NotNull
                                       java.lang.String installDirectory)
```
    Sets the install directory, including modifying the batch/shell scripts.
    
    Parameters:
    
    installDirectory - The install directory.
  - regenerateBatchAndShellScripts
```
public static void regenerateBatchAndShellScripts()
```
    Regenerates the batch files and shell scripts.
  - getEdition
```
public static int getEdition()
```
    Gets the edition we're running as.
    
    Returns:
    
    The edition, as defined by one of the "EDITION" constants.
  - isEditionProOrBetter
```
public static boolean isEditionProOrBetter()
```
    Indicates whether or not the edition is Professional or better.
    
    Returns:
    
    A boolean.
  - isEditionEnterpriseOrBetter
```
public static boolean isEditionEnterpriseOrBetter()
```
    Indicates whether or not the edition is Enterprise or better.
    
    Returns:
    
    A boolean.
  - getEditionAsString
```
public static java.lang.String getEditionAsString()
```
    Gets a string representative of the edition.
    
    Returns:
    
    The edition, as a string.
  - convertEditionNumberToString
```
public static java.lang.String convertEditionNumberToString(int edition)
```
    Converts the given number to the edition name
    
    Parameters:
    
    edition - The edition value, as an int
    
    Returns:
    
    The name of the edition, as a string
  - isFalseProfessional
```
public static boolean isFalseProfessional()
```
    Ensures that someone hasn't tried to upgrade from basic to professional simply by altering the property in the properties file.
    
    Returns:
    
    True if this is a false professional install, false if it is valid
  - isFalseEnterprise
```
public static boolean isFalseEnterprise()
```
    Ensures that someone hasn't tried to upgrade to enterprise simply by altering the property in the properties file.
    
    Returns:
    
    True if this is a false enterprise install, false if it is valid
  - getALEFilePath
```
@NotNull
public static java.lang.String getALEFilePath()
```
    Gets the path to the ALE file, based on the edition running.
    
    Returns:
    
    The path to the ALE file.
  - getRunMode
```
public static int getRunMode()
```
    Gets the current run mode, as defined by one of the RUN_MODE constants defined in this class.
    
    Returns:
    
    The run mode.
  - getNumRecentScriptsToShow
```
public static int getNumRecentScriptsToShow()
```
    Returns how many recent scripts to show in the script selection dropdown
    
    Returns:
    
    How many recent scripts to show in the script selection dropdown
  - setRunMode
```
public static void setRunMode(int runMode)
```
    Sets the current run mode, as defined by one of the RUN_MODE constants defined in this class.
    
    Parameters:
    
    runMode - The run mode.
  - getRunModeAsString
```
public static java.lang.String getRunModeAsString()
```
    Returns a string representation of the run mode.
    
    Returns:
    
    A string representing the run mode.
  - getMaximumNumberOfScrapeableSessions
```
public static int getMaximumNumberOfScrapeableSessions()
```
    Gets the maximum number of scrapeable sessions that should be loaded from the database.
    
    Returns:
    
    The number.
  - isActionAllowed
```
public static boolean isActionAllowed(int requiredEdition,
                                      int originatorEdition)
```
    Indicates whether or not an action is allowed based on the required edition.
    
    Parameters:
    
    requiredEdition - The required edition.
    
    originatorEdition - The edition under which the scraping session was developed.
    
    Returns:
    
    A boolean indicating whether or not it's allowed.
  - main
```
public static void main(@NotNull
                        java.lang.String[] args)
```
    An entry point for programmatically manipulating settings. Currently this only allows setting the "InstallationDirectory" property, which is done by passing as the first parameter InstallationDirectory and as the second parameter the directory terminated by the platform path delimiter.
    
    Parameters:
    
    args - The command line arguments
  - getWebInterfaceUser
```
@Nullable
public static java.lang.String getWebInterfaceUser()
```
    Returns the username that can access the web interface by login (rather than by being on the correct ip)
    
    Returns:
    
    The username that can access the web interface by login (rather than by being on the correct ip)
  - getWebInterfacePassword
```
@Nullable
public static java.lang.String getWebInterfacePassword()
```
    Returns the password that can access the web interface by login (rather than by being on the correct ip)
    
    Returns:
    
    The password that can access the web interface by login (rather than by being on the correct ip)
  - getMarkScriptOccurrences
```
public static boolean getMarkScriptOccurrences()
```
    Returns whether or not hovering the caret in the script editor should highlight matching text
    
    Returns:
    
    Whether or not hovering the caret in the script editor should highlight matching text
  - getConnectionTimeout
```
public static int getConnectionTimeout()
```
    Returns the connection timeout, in seconds, for the http connections
    
    Returns:
    
    The connection timeout, in seconds
  - getRequestTimeout
```
public static int getRequestTimeout()
```
    Returns the timeout, in seconds, for the downloading a page or block of content. By default this is really high
    
    Returns:
    
    The timeout for downloading a page
  - enableCodeFoldingInLastResponse
```
public static boolean enableCodeFoldingInLastResponse()
```
    Returns whether code folding should be enabled in the last response tab or not
    
    Returns:
    
    Whether code folding should be enabled in the last response tab or not
  - shouldLogHighMemoryUse
```
public static boolean shouldLogHighMemoryUse()
```
    Returns whether high memory use information should be logged. When enabled, when memory use goes above 80% it will launch code to determine what is using the memory. That will in and of itself use a bunch of memory (effectively reducing the amount for scraping) but can help track down leaks in code
    
    Returns:
    
    Whether high memory use information should be logged
  - getMinLoggingLevel
```
public static int getMinLoggingLevel()
```
    Returns the minimum logging level the instance will allow for all scrapes. If a scrape is info level but this returns warn level, the scrape will use warn.
    
    Returns:
    
    The minimum logging level the instance will allow for all scrapes. If a scrape is info level but this returns warn level, the scrape will use warn.
  - getTruncateWorkbenchRequestPOSTDataLength
```
public static int getTruncateWorkbenchRequestPOSTDataLength()
```
    Gets the length at which to truncate POST data in the workbench, for display purposes
    
    Returns:
    
    The length at which to truncate POST data in the workbench
    
    Since:
    
    7.0.6a
  - getSocketLinger
```
public static int getSocketLinger()
```
    The socket linger amount, or negative to use the default value. Note some HTTP clients don't support this
    
    Returns:
    
    The socket linger value to use, or negative to use the default value. Note some HTTP clients don't support this
    
    Since:
    
    7.0.10a
  - allowScriptExport
```
public static boolean allowScriptExport()
```
    Flag to skip script exports. Mainly useful if doing a bulk export but only sessions need to be exported
    
    Returns:
    
    True if script export should be allowed, false otherwise

Class Settings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USER_AGENT

log

iaPropertiesFilePath

wPropertiesFilePath

lwsPropertiesFilePath

ssVMOptionsFilePath

serverVMOptionsFilePath

ssInfoPlistFilePath

DEFAULT_WEB_BROWSER

BUILTIN_BROWSER

EDITION_BASIC

EDITION_PROFESSIONAL

EDITION_ENTERPRISE

IMPORT_YES

IMPORT_NO

IMPORT_YES_TO_ALL

IMPORT_CANCEL

EXPORT_YES

EXPORT_NO

EXPORT_YES_TO_ALL

EXPORT_CANCEL

DEFAULT_CHARACTER_SET

LOOK_AND_FEEL_NATIVE

LOOK_AND_FEEL_SILVER

DEFAULT_LOOK_AND_FEEL

RUN_MODE_COMMAND_LINE

RUN_MODE_SERVER

RUN_MODE_WORKBENCH

TIDY_HTML_DONT_TIDY

TIDY_HTML_JTIDY

TIDY_HTML_NEKO

TIDY_HTML_JERICHO

TIDY_HTML_JSOUP

TIDY_JSON

TIDY_XML

TIDY_DEFAULT_TIDIER

Constructor Detail

Settings

Method Detail

load

reload

getMaxConcurrentScrapingSessions

save

getProperties

getMaximumDisplayedLastResponseLength

getMaximumNumberOfRedirects

getAutoCompleteDelay

getMaximumProxyWaits

useFastWorkbenchLogging

getShouldHideWrapNotifications

setShouldHideWrapNotifications

getLookAndFeel

setLookAndFeel

getIPAddressesToAllow

getDefaultCharacterSet

setDefaultCharacterSet

getDefaultFont

getMaximumMemoryAllocation

verifyMemoryAllocationSetting

getAllAvailableFontNames

getNumTimesWorkbenchHasBeenRun

incrementNumTimesWorkbenchHasBeenRun

getNumTimesServerHasBeenRun

incrementNumTimesServerHasBeenRun

getNumTimesCommandLineHasBeenRun

getMaxScrapingSessionLogFileSize

incrementNumTimesCommandLineHasBeenRun

getDataExtractorTimeout

getScriptScrapeNamePrefixDelimiter

doesUserWantToViewTutorials

allowNavigationActions

instrumentationEnabled

shouldBackUpInternalDb

getStartPageURLPrepend