IBM Rational Functional Tester
Version 8.2.1
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.services
Class FtInstallOptions

java.lang.Object
  extended by com.rational.test.ft.services.FtInstallOptions

public class FtInstallOptions
extends java.lang.Object

Provides access to the options that define the runtime environment that a script runs in. This is not a general purpose properties file access class, only specific options can be accessed via this class. Options other then those specifically understood will be rejected.


Field Summary
static java.lang.String ALLOW_VBNET_REMOTE_TESTING
           
static java.lang.String BACK2IVDEBUG
           
static java.lang.String CHANNEL_WAIT_TIMEOUT
          The property controls the wait-timout for a threadchannel .
static java.lang.String CHROME_BROWSER_COMMANDLINEFLAGS
          The property controls the commandline flags for the Chrome browser when it is started from RFT .
static java.lang.String CLEARSCRIPT_OPTIMIZE_IMAGE_CAPTURE
          Clearscript flag
static java.lang.String DEBUG_CLEAR
           
static java.lang.String DEBUG_ENABLED
           
static java.lang.String DEBUG_FACILITIES
           
static java.lang.String DEBUG_FILENAME
           
static java.lang.String DEBUG_FORMAT
           
static java.lang.String DEV_USER
           
static java.lang.String DISABLE_HTML_SUBDOMAIN_FIND_OPTIMIZATION
           
static java.lang.String DYNAMIC_ENABLE_SWT_APP
          This property if set will assist in dynamically enabling SWT apps
static java.lang.String DYNAMIC_ENABLE_SWT_APP_PROCESS_NAMES
          The property is to dynamically enable SWT process.
static java.lang.String DYNAMIC_JAVA_ENABLEMENT
          F
static java.lang.String ECLIPSE_ENABLER_PLUGIN_VERSION
           
static java.lang.String ECLIPSE_GEFENABLER_PLUGIN_VERSION
           
static java.lang.String ENABLE_GTK_NATIVE_WINDOWS
           
static java.lang.String ENABLE_LOCALIZATION
           
static java.lang.String ENABLE_SOLMAN
           
static java.lang.String FT_CM_OPTIONS
           
static java.lang.String FT_DATAPOOL_MAX_ITEM_COUNT
          The option if set overrides the set datapool item count.
static java.lang.String FT_ECLIPSE_DOMAIN_ENABLE
           
static java.lang.String FT_JVM_OPTIONS
           
static java.lang.String HTML_DEBUG_ENABLED
           
static java.lang.String HTML_DOCUMENT_AJAX_TIMEOUTATTEMPTS
           
static java.lang.String HTML_DOCUMENT_USE_DOCUMENTTESTOBJECT
           
static java.lang.String HTML_ENABLE_CLICK_WITHOUT_MOUSE
           
static java.lang.String HTML_ENABLE_DOJOFEATURE
           
static java.lang.String HTML_ENABLE_DYNAMICLLYIGNOREPROPS
           
static java.lang.String HTML_ENABLE_IE7PERFORMCHANGES
           
static java.lang.String HTML_ENABLE_SAPWEBPORTALFEATURE
           
static java.lang.String HTML_ENABLE_TOSCORE_FOR_DYNAMICLLYIGNOREPROPS
           
static java.lang.String HTML_SET_BROWSERREADYSTATE
           
static java.lang.String HTML_TRY_WHEN_STATE_LOADED
           
static java.lang.String HTML_USE_SCRIPTFIND
           
static java.lang.String HTML_USE_SCRIPTFINDXPATH
           
static java.lang.String HTMLPROXYCHANNELRUNNABLE_TIMEOUT
           
static java.lang.String IE7BROKENDOM_CLIPTODOCUMENT
           
static java.lang.String IGNORE_CGI
           
static java.lang.String IGNORECLASSINDEX_INPLAYBACK
           
static java.lang.String IMAGE_TOLERANCE
           
static java.lang.String IMAGE_TRANSLATION
           
static java.lang.String INSPECTOR_SLEEPLOOP
           
static java.lang.String INSPECTOR_SLEEPTIME
           
static java.lang.String INSTALLDIR_IGNORE_MISMATCH
           
static java.lang.String ITLM_LOG_LOCATION
           
static java.lang.String ITLM_LOG_VERBOSE
           
protected static java.util.Properties ivoryProperties
           
static java.lang.String JAVA_JFC_JDESKTOP_MAPPED
           
static java.lang.String JAVA_JFC_JSCROLLPANE_MAPPED
           
static java.lang.String JAVA_SWT_COMPOSITE_MAPPED
           
static java.lang.String JAVA_SWT_TOOLITEM_RECORDED
           
static java.lang.String JAVAC
           
static java.lang.String JAVAC_OPTIONS
           
static java.lang.String MAX_ENUM_COUNT
           
static java.lang.String MESSAGESBASE
           
static java.lang.String MISMATCH_AREA_TOLERANCE
           
static java.lang.String MOZILLA_ENABLED
           
static java.lang.String NATIVEPATH
           
static java.lang.String OCR_ENABLED
          OCR Options :- OCR_ENABLED : if true, tells us that the ocr feature has been enbaled through "ivory.properties" OCR_TYPE : Stores the type of OCR being used.
static java.lang.String OCR_TYPE
           
static java.lang.String RECORD_OBJECT_BASED_VP
           
static java.lang.String SCORE_FOR_FIND_BYIDORNAME
           
static java.lang.String SCRIPT_PAUSE_HOTKEY
           
static java.lang.String SCRIPT_STOP_HOTKEY
           
static java.lang.String SOLMAN_ENABLETRACE
           
static java.lang.String SOLMAN_UNC_LOGSFOLDER
           
static java.lang.String STRING
           
static java.lang.String TRACE_SPY_LOCK
           
static java.lang.String USE_FIND_BY_IDORNAME
           
static java.lang.String USE_OPTIMIZED_FIND
           
static java.lang.String USE_TOLERANCE
           
static java.lang.String VOM_VERIFY_OBJECT_HIERARCHY
          VisualScript Visual Object Map Optimizations
static java.lang.String VSLOGEXTENSION_PROCESS_POLL_DELAY
           
static java.lang.String WEBSERVER_ENABLEMENT
          The property is to dynamically enable SWT process.
static java.lang.String WINDOWLISTENER
           
static java.lang.String WINDOWS_TONOT_LISTEN_ON
           
static java.lang.String XMLLOG_ENHANCED
           
 
Constructor Summary
FtInstallOptions()
           
 
Method Summary
static boolean getBooleanOption(java.lang.String option, boolean defaultIfNotSet)
          Return a boolean value for an install option.
static java.lang.String getInstallDir()
          Get the install directory
static int getIntOption(java.lang.String option, int defaultIfNotSet)
          Return a integer value for an install option.
static java.lang.String getLocalizationDir()
           
static java.lang.String getOption(java.lang.String option)
          Return the value of an install option.
static void setInstallDir(java.lang.String dir)
          Set where the install directory is.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ivoryProperties

protected static java.util.Properties ivoryProperties

MOZILLA_ENABLED

public static final java.lang.String MOZILLA_ENABLED
See Also:
Constant Field Values

MESSAGESBASE

public static final java.lang.String MESSAGESBASE
See Also:
Constant Field Values

NATIVEPATH

public static final java.lang.String NATIVEPATH
See Also:
Constant Field Values

WINDOWLISTENER

public static final java.lang.String WINDOWLISTENER
See Also:
Constant Field Values

BACK2IVDEBUG

public static final java.lang.String BACK2IVDEBUG
See Also:
Constant Field Values

DEBUG_ENABLED

public static final java.lang.String DEBUG_ENABLED
See Also:
Constant Field Values

DEBUG_CLEAR

public static final java.lang.String DEBUG_CLEAR
See Also:
Constant Field Values

DEBUG_FACILITIES

public static final java.lang.String DEBUG_FACILITIES
See Also:
Constant Field Values

DEBUG_FORMAT

public static final java.lang.String DEBUG_FORMAT
See Also:
Constant Field Values

DEBUG_FILENAME

public static final java.lang.String DEBUG_FILENAME
See Also:
Constant Field Values

JAVAC

public static final java.lang.String JAVAC
See Also:
Constant Field Values

JAVAC_OPTIONS

public static final java.lang.String JAVAC_OPTIONS
See Also:
Constant Field Values

STRING

public static final java.lang.String STRING
See Also:
Constant Field Values

IGNORE_CGI

public static final java.lang.String IGNORE_CGI
See Also:
Constant Field Values

MAX_ENUM_COUNT

public static final java.lang.String MAX_ENUM_COUNT
See Also:
Constant Field Values

ALLOW_VBNET_REMOTE_TESTING

public static final java.lang.String ALLOW_VBNET_REMOTE_TESTING
See Also:
Constant Field Values

ENABLE_LOCALIZATION

public static final java.lang.String ENABLE_LOCALIZATION
See Also:
Constant Field Values

ECLIPSE_ENABLER_PLUGIN_VERSION

public static final java.lang.String ECLIPSE_ENABLER_PLUGIN_VERSION
See Also:
Constant Field Values

ECLIPSE_GEFENABLER_PLUGIN_VERSION

public static final java.lang.String ECLIPSE_GEFENABLER_PLUGIN_VERSION
See Also:
Constant Field Values

JAVA_JFC_JDESKTOP_MAPPED

public static final java.lang.String JAVA_JFC_JDESKTOP_MAPPED
See Also:
Constant Field Values

JAVA_JFC_JSCROLLPANE_MAPPED

public static final java.lang.String JAVA_JFC_JSCROLLPANE_MAPPED
See Also:
Constant Field Values

JAVA_SWT_COMPOSITE_MAPPED

public static final java.lang.String JAVA_SWT_COMPOSITE_MAPPED
See Also:
Constant Field Values

JAVA_SWT_TOOLITEM_RECORDED

public static final java.lang.String JAVA_SWT_TOOLITEM_RECORDED
See Also:
Constant Field Values

DEV_USER

public static final java.lang.String DEV_USER
See Also:
Constant Field Values

INSTALLDIR_IGNORE_MISMATCH

public static final java.lang.String INSTALLDIR_IGNORE_MISMATCH
See Also:
Constant Field Values

INSPECTOR_SLEEPTIME

public static final java.lang.String INSPECTOR_SLEEPTIME
See Also:
Constant Field Values

INSPECTOR_SLEEPLOOP

public static final java.lang.String INSPECTOR_SLEEPLOOP
See Also:
Constant Field Values

RECORD_OBJECT_BASED_VP

public static final java.lang.String RECORD_OBJECT_BASED_VP
See Also:
Constant Field Values

SCRIPT_STOP_HOTKEY

public static final java.lang.String SCRIPT_STOP_HOTKEY
See Also:
Constant Field Values

SCRIPT_PAUSE_HOTKEY

public static final java.lang.String SCRIPT_PAUSE_HOTKEY
See Also:
Constant Field Values

WINDOWS_TONOT_LISTEN_ON

public static final java.lang.String WINDOWS_TONOT_LISTEN_ON
See Also:
Constant Field Values

ITLM_LOG_LOCATION

public static final java.lang.String ITLM_LOG_LOCATION
See Also:
Constant Field Values

ITLM_LOG_VERBOSE

public static final java.lang.String ITLM_LOG_VERBOSE
See Also:
Constant Field Values

FT_JVM_OPTIONS

public static final java.lang.String FT_JVM_OPTIONS
See Also:
Constant Field Values

HTML_TRY_WHEN_STATE_LOADED

public static final java.lang.String HTML_TRY_WHEN_STATE_LOADED
See Also:
Constant Field Values

FT_CM_OPTIONS

public static final java.lang.String FT_CM_OPTIONS
See Also:
Constant Field Values

FT_ECLIPSE_DOMAIN_ENABLE

public static final java.lang.String FT_ECLIPSE_DOMAIN_ENABLE
See Also:
Constant Field Values

HTML_DOCUMENT_AJAX_TIMEOUTATTEMPTS

public static final java.lang.String HTML_DOCUMENT_AJAX_TIMEOUTATTEMPTS
See Also:
Constant Field Values

HTML_DOCUMENT_USE_DOCUMENTTESTOBJECT

public static final java.lang.String HTML_DOCUMENT_USE_DOCUMENTTESTOBJECT
See Also:
Constant Field Values

HTML_USE_SCRIPTFIND

public static final java.lang.String HTML_USE_SCRIPTFIND
See Also:
Constant Field Values

HTML_USE_SCRIPTFINDXPATH

public static final java.lang.String HTML_USE_SCRIPTFINDXPATH
See Also:
Constant Field Values

USE_OPTIMIZED_FIND

public static final java.lang.String USE_OPTIMIZED_FIND
See Also:
Constant Field Values

USE_FIND_BY_IDORNAME

public static final java.lang.String USE_FIND_BY_IDORNAME
See Also:
Constant Field Values

SCORE_FOR_FIND_BYIDORNAME

public static final java.lang.String SCORE_FOR_FIND_BYIDORNAME
See Also:
Constant Field Values

IGNORECLASSINDEX_INPLAYBACK

public static final java.lang.String IGNORECLASSINDEX_INPLAYBACK
See Also:
Constant Field Values

IE7BROKENDOM_CLIPTODOCUMENT

public static final java.lang.String IE7BROKENDOM_CLIPTODOCUMENT
See Also:
Constant Field Values

HTML_ENABLE_IE7PERFORMCHANGES

public static final java.lang.String HTML_ENABLE_IE7PERFORMCHANGES
See Also:
Constant Field Values

HTML_ENABLE_DOJOFEATURE

public static final java.lang.String HTML_ENABLE_DOJOFEATURE
See Also:
Constant Field Values

HTML_ENABLE_SAPWEBPORTALFEATURE

public static final java.lang.String HTML_ENABLE_SAPWEBPORTALFEATURE
See Also:
Constant Field Values

HTML_SET_BROWSERREADYSTATE

public static final java.lang.String HTML_SET_BROWSERREADYSTATE
See Also:
Constant Field Values

HTML_ENABLE_DYNAMICLLYIGNOREPROPS

public static final java.lang.String HTML_ENABLE_DYNAMICLLYIGNOREPROPS
See Also:
Constant Field Values

HTML_ENABLE_TOSCORE_FOR_DYNAMICLLYIGNOREPROPS

public static final java.lang.String HTML_ENABLE_TOSCORE_FOR_DYNAMICLLYIGNOREPROPS
See Also:
Constant Field Values

HTML_ENABLE_CLICK_WITHOUT_MOUSE

public static final java.lang.String HTML_ENABLE_CLICK_WITHOUT_MOUSE
See Also:
Constant Field Values

FT_DATAPOOL_MAX_ITEM_COUNT

public static final java.lang.String FT_DATAPOOL_MAX_ITEM_COUNT
The option if set overrides the set datapool item count. By default the item count is 300.

See Also:
Constant Field Values

HTML_DEBUG_ENABLED

public static final java.lang.String HTML_DEBUG_ENABLED
See Also:
Constant Field Values

IMAGE_TOLERANCE

public static final java.lang.String IMAGE_TOLERANCE
See Also:
Constant Field Values

MISMATCH_AREA_TOLERANCE

public static final java.lang.String MISMATCH_AREA_TOLERANCE
See Also:
Constant Field Values

IMAGE_TRANSLATION

public static final java.lang.String IMAGE_TRANSLATION
See Also:
Constant Field Values

USE_TOLERANCE

public static final java.lang.String USE_TOLERANCE
See Also:
Constant Field Values

TRACE_SPY_LOCK

public static final java.lang.String TRACE_SPY_LOCK
See Also:
Constant Field Values

VSLOGEXTENSION_PROCESS_POLL_DELAY

public static final java.lang.String VSLOGEXTENSION_PROCESS_POLL_DELAY
See Also:
Constant Field Values

SOLMAN_ENABLETRACE

public static final java.lang.String SOLMAN_ENABLETRACE
See Also:
Constant Field Values

SOLMAN_UNC_LOGSFOLDER

public static final java.lang.String SOLMAN_UNC_LOGSFOLDER
See Also:
Constant Field Values

XMLLOG_ENHANCED

public static final java.lang.String XMLLOG_ENHANCED
See Also:
Constant Field Values

OCR_ENABLED

public static final java.lang.String OCR_ENABLED
OCR Options :- OCR_ENABLED : if true, tells us that the ocr feature has been enbaled through "ivory.properties" OCR_TYPE : Stores the type of OCR being used. Presently - "vop". Can be changed through "ivory.properties"

See Also:
Constant Field Values

OCR_TYPE

public static final java.lang.String OCR_TYPE
See Also:
Constant Field Values

ENABLE_SOLMAN

public static final java.lang.String ENABLE_SOLMAN
See Also:
Constant Field Values

ENABLE_GTK_NATIVE_WINDOWS

public static final java.lang.String ENABLE_GTK_NATIVE_WINDOWS
See Also:
Constant Field Values

VOM_VERIFY_OBJECT_HIERARCHY

public static final java.lang.String VOM_VERIFY_OBJECT_HIERARCHY
VisualScript Visual Object Map Optimizations

See Also:
Constant Field Values

CLEARSCRIPT_OPTIMIZE_IMAGE_CAPTURE

public static final java.lang.String CLEARSCRIPT_OPTIMIZE_IMAGE_CAPTURE
Clearscript flag

See Also:
Constant Field Values

DYNAMIC_JAVA_ENABLEMENT

public static final java.lang.String DYNAMIC_JAVA_ENABLEMENT
F

See Also:
Constant Field Values

DYNAMIC_ENABLE_SWT_APP

public static final java.lang.String DYNAMIC_ENABLE_SWT_APP
This property if set will assist in dynamically enabling SWT apps

See Also:
Constant Field Values

DYNAMIC_ENABLE_SWT_APP_PROCESS_NAMES

public static final java.lang.String DYNAMIC_ENABLE_SWT_APP_PROCESS_NAMES
The property is to dynamically enable SWT process. This is a comma separated.

See Also:
Constant Field Values

WEBSERVER_ENABLEMENT

public static final java.lang.String WEBSERVER_ENABLEMENT
The property is to dynamically enable SWT process. This is a comma separated.

See Also:
Constant Field Values

CHANNEL_WAIT_TIMEOUT

public static final java.lang.String CHANNEL_WAIT_TIMEOUT
The property controls the wait-timout for a threadchannel .

See Also:
Constant Field Values

CHROME_BROWSER_COMMANDLINEFLAGS

public static final java.lang.String CHROME_BROWSER_COMMANDLINEFLAGS
The property controls the commandline flags for the Chrome browser when it is started from RFT .

See Also:
Constant Field Values

HTMLPROXYCHANNELRUNNABLE_TIMEOUT

public static final java.lang.String HTMLPROXYCHANNELRUNNABLE_TIMEOUT
See Also:
Constant Field Values

DISABLE_HTML_SUBDOMAIN_FIND_OPTIMIZATION

public static final java.lang.String DISABLE_HTML_SUBDOMAIN_FIND_OPTIMIZATION
See Also:
Constant Field Values
Constructor Detail

FtInstallOptions

public FtInstallOptions()
Method Detail

getOption

public static java.lang.String getOption(java.lang.String option)
Return the value of an install option.

Parameters:
option - The option to retrieve

getIntOption

public static int getIntOption(java.lang.String option,
                               int defaultIfNotSet)
Return a integer value for an install option.


getBooleanOption

public static boolean getBooleanOption(java.lang.String option,
                                       boolean defaultIfNotSet)
Return a boolean value for an install option.


setInstallDir

public static void setInstallDir(java.lang.String dir)
Set where the install directory is.
For the AUT the bootstrap code (com.rational.test.bootstrap.Bootstrap) will figure this out by looking in the registry.
For rational_ft the install directory is passed in on the command line
IDE will set install directory it is running from.

Parameters:
dir - The install directory

getInstallDir

public static java.lang.String getInstallDir()
Get the install directory

Returns:
The install directory

getLocalizationDir

public static java.lang.String getLocalizationDir()