SePlusInstallInfo (SAFS API DOCUMENT)

java.lang.Object
- org.safs.selenium.util.SePlusInstallInfo

```
public class SePlusInstallInfo
extends java.lang.Object
```
This class holds the information related to the Selenium, Embedded Java, Library etc.
We provide support of Selenium Engine in both SAFS and SeleniumPlus.
But the the file structure is different between SAFS and SeleniumPlus,
this class intends to detect automatically which one has been installed
and deduce the related appropriate resources to use.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHOROMEDRIVER_UNIX`
`static java.lang.String`	`CHOROMEDRIVER_WINDOWS`
`static java.lang.String`	`CHROMIUM_EDGEDRIVER_WINDOWS`
`static java.lang.String`	`EDGEDRIVER_WINDOWS`
`static java.lang.String`	`ENV_SAFSDIR`
`static java.lang.String`	`ENV_SELENIUM_PLUS`
`static java.lang.String`	`FAKE_DRIVER_NAME`
`static java.lang.String`	`GECKODRIVER_UNIX`
`static java.lang.String`	`GECKODRIVER_UNIX_64`
`static java.lang.String`	`GECKODRIVER_WINDOWS`
`static java.lang.String`	`GECKODRIVER_WINDOWS_64`
`static java.lang.String`	`IEDRIVER_WINDOWS`
`static java.lang.String`	`INDICATOR_SAFS`
`static java.lang.String`	`INDICATOR_SEPLUS`
`static java.lang.String`	`JAR_JSTAFEMBEDDED`
`static java.lang.String`	`JAR_SELENIUM_SAFS`
`static java.lang.String`	`JAR_SELENIUM_SEPLUS`
`static java.lang.String`	`NAME_PARTIAL_SELENIUM_SERVER_STDALONE`
`static java.lang.String`	`OPERADRIVER_WINDOWS`
`static java.lang.String`	`PRODUCT_SAFS`
`static java.lang.String`	`PRODUCT_SELENIUM_PLUS`
`static java.lang.String`	`PROPERTY_PRODUCT_NAME` The VM parameter "PRODUCT_NAME" to indicate the product being used.
`static java.lang.String`	`RELATIVE_DIR_ECLIPSE`
`static java.lang.String`	`RELATIVE_DIR_EXTRA_SAFS`
`static java.lang.String`	`RELATIVE_DIR_EXTRA_SEPLUS`
`static java.lang.String`	`RELATIVE_DIR_JAVA_BIN_SEPLUS`
`static java.lang.String`	`RELATIVE_DIR_JAVA32_BIN_SAFS`
`static java.lang.String`	`RELATIVE_DIR_JAVA64_BIN_SAFS`
`static java.lang.String`	`RELATIVE_DIR_LIB_SAFS`
`static java.lang.String`	`RELATIVE_DIR_LIB_SEPLUS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.io.File`	`getChromeDriver()`
`java.io.File`	`getChromniumEdgeDriver()`
`java.lang.String`	`getClassPath(boolean appendSystemClassPath)`
`java.io.File`	`getDriver(java.lang.String browserName)`
`java.lang.String`	`getEclipseConfig(java.lang.String property)` Get the value of a property from the Eclipse configuration file (under Eclipse directory `getEclipseDir()`) ".eclipseproduct" "configuration\config.ini"
`java.io.File`	`getEclipseDir()`
`java.io.File`	`getEdgeDriver()`
`java.io.File`	`getExtraDir()`
`java.io.File`	`getIEDriver()`
`java.lang.String`	`getJavaexe()`
`java.io.File`	`getLibraryDir()`
`java.io.File`	`getRootDir()`
`java.io.File`	`getSeleniumStandaloneJar()`
`static java.lang.String`	`getSourceLocation()`
`protected static java.lang.String`	`GetSystemEnvironmentVariable(java.lang.String env)`
`static java.lang.String`	`GetSystemPropertyOrEnvironmentVariable(java.lang.String env)` Get the value of the system property (ex.
`static SePlusInstallInfo`	`instance()`
`static boolean`	`isOverridePropertySet(java.lang.String env)` Deprecated. we don't use this anymore, we always prefer 'System property' over 'Environment'.
`boolean`	`isSAFS()`
`static boolean`	`IsSAFS()` To test if we are using product "SAFS". Either Satisfy: The environment `Constants.ENV_SAFSDIR` must exist.
`boolean`	`isSeleniumPlus()`
`static boolean`	`IsSeleniumPlus()` To test if we are using product "SeleniumPlus". Either Satisfy: The environment `Constants.ENV_SELENIUM_PLUS` must exist.
`void`	`setExtraDir(java.io.File extraDir)`
`void`	`setJavaexe(java.lang.String javaexe)`
`void`	`setLibraryDir(java.io.File libraryDir)`
`void`	`setRootDir(java.io.File rootDir)`
`void`	`setSeleniumStandaloneJar(java.io.File seleniumStandaloneJar)`
`java.lang.String`	`toString()`
`protected SePlusInstallInfo`	`validate()` Validate the path of Selenium, Embedded Java, Library etc.

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

- Field Detail
  - PRODUCT_SELENIUM_PLUS
```
public static final java.lang.String PRODUCT_SELENIUM_PLUS
```
    See Also:
    
    Constant Field Values
  - PRODUCT_SAFS
```
public static final java.lang.String PRODUCT_SAFS
```
    See Also:
    
    Constant Field Values
  - ENV_SELENIUM_PLUS
```
public static final java.lang.String ENV_SELENIUM_PLUS
```
    See Also:
    
    Constant Field Values
  - ENV_SAFSDIR
```
public static final java.lang.String ENV_SAFSDIR
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_ECLIPSE
```
public static final java.lang.String RELATIVE_DIR_ECLIPSE
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_EXTRA_SAFS
```
public static final java.lang.String RELATIVE_DIR_EXTRA_SAFS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_LIB_SAFS
```
public static final java.lang.String RELATIVE_DIR_LIB_SAFS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_JAVA64_BIN_SAFS
```
public static final java.lang.String RELATIVE_DIR_JAVA64_BIN_SAFS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_JAVA32_BIN_SAFS
```
public static final java.lang.String RELATIVE_DIR_JAVA32_BIN_SAFS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_EXTRA_SEPLUS
```
public static final java.lang.String RELATIVE_DIR_EXTRA_SEPLUS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_LIB_SEPLUS
```
public static final java.lang.String RELATIVE_DIR_LIB_SEPLUS
```
    See Also:
    
    Constant Field Values
  - RELATIVE_DIR_JAVA_BIN_SEPLUS
```
public static final java.lang.String RELATIVE_DIR_JAVA_BIN_SEPLUS
```
    See Also:
    
    Constant Field Values
  - JAR_SELENIUM_SAFS
```
public static final java.lang.String JAR_SELENIUM_SAFS
```
    See Also:
    
    Constant Field Values
  - JAR_SELENIUM_SEPLUS
```
public static final java.lang.String JAR_SELENIUM_SEPLUS
```
    See Also:
    
    Constant Field Values
  - JAR_JSTAFEMBEDDED
```
public static final java.lang.String JAR_JSTAFEMBEDDED
```
    See Also:
    
    Constant Field Values
  - INDICATOR_SEPLUS
```
public static final java.lang.String INDICATOR_SEPLUS
```
    See Also:
    
    Constant Field Values
  - INDICATOR_SAFS
```
public static final java.lang.String INDICATOR_SAFS
```
    See Also:
    
    Constant Field Values
  - CHOROMEDRIVER_WINDOWS
```
public static final java.lang.String CHOROMEDRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - CHOROMEDRIVER_UNIX
```
public static final java.lang.String CHOROMEDRIVER_UNIX
```
    See Also:
    
    Constant Field Values
  - GECKODRIVER_UNIX
```
public static final java.lang.String GECKODRIVER_UNIX
```
    See Also:
    
    Constant Field Values
  - GECKODRIVER_UNIX_64
```
public static final java.lang.String GECKODRIVER_UNIX_64
```
    See Also:
    
    Constant Field Values
  - IEDRIVER_WINDOWS
```
public static final java.lang.String IEDRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - EDGEDRIVER_WINDOWS
```
public static final java.lang.String EDGEDRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - CHROMIUM_EDGEDRIVER_WINDOWS
```
public static final java.lang.String CHROMIUM_EDGEDRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - OPERADRIVER_WINDOWS
```
public static final java.lang.String OPERADRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - GECKODRIVER_WINDOWS
```
public static final java.lang.String GECKODRIVER_WINDOWS
```
    See Also:
    
    Constant Field Values
  - GECKODRIVER_WINDOWS_64
```
public static final java.lang.String GECKODRIVER_WINDOWS_64
```
    See Also:
    
    Constant Field Values
  - FAKE_DRIVER_NAME
```
public static final java.lang.String FAKE_DRIVER_NAME
```
    See Also:
    
    Constant Field Values
  - NAME_PARTIAL_SELENIUM_SERVER_STDALONE
```
public static final java.lang.String NAME_PARTIAL_SELENIUM_SERVER_STDALONE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_PRODUCT_NAME
```
public static final java.lang.String PROPERTY_PRODUCT_NAME
```
    The VM parameter "PRODUCT_NAME" to indicate the product being used. It accepts
    - -DPRODUCT_NAME=PRODUCT_SELENIUM_PLUS
    - -DPRODUCT_NAME=PRODUCT_SAFS
    See Also:
    
    Constant Field Values
- Method Detail
  - isSeleniumPlus
```
public boolean isSeleniumPlus()
```
  - isSAFS
```
public boolean isSAFS()
```
  - instance
```
public static SePlusInstallInfo instance()
                                  throws SeleniumPlusException
```
    Throws:
    
    SeleniumPlusException
  - getRootDir
```
public java.io.File getRootDir()
```
  - setRootDir
```
public void setRootDir(java.io.File rootDir)
```
  - getExtraDir
```
public java.io.File getExtraDir()
```
  - setExtraDir
```
public void setExtraDir(java.io.File extraDir)
```
  - getEclipseDir
```
public java.io.File getEclipseDir()
```
    Returns:
    
    File, the Eclipse directory eclipseDir.
  - getLibraryDir
```
public java.io.File getLibraryDir()
```
  - setLibraryDir
```
public void setLibraryDir(java.io.File libraryDir)
```
  - getJavaexe
```
public java.lang.String getJavaexe()
```
  - setJavaexe
```
public void setJavaexe(java.lang.String javaexe)
```
  - getSeleniumStandaloneJar
```
public java.io.File getSeleniumStandaloneJar()
```
  - setSeleniumStandaloneJar
```
public void setSeleniumStandaloneJar(java.io.File seleniumStandaloneJar)
```
  - getClassPath
```
public java.lang.String getClassPath(boolean appendSystemClassPath)
```
  - isOverridePropertySet
```
@Deprecated
public static boolean isOverridePropertySet(java.lang.String env)
```
    Deprecated. we don't use this anymore, we always prefer 'System property' over 'Environment'.
  - GetSystemPropertyOrEnvironmentVariable
```
public static java.lang.String GetSystemPropertyOrEnvironmentVariable(java.lang.String env)
```
    Get the value of the system property (ex. SELENIUM_PLUS), if not found then get the value from the environment variables.
  - GetSystemEnvironmentVariable
```
protected static java.lang.String GetSystemEnvironmentVariable(java.lang.String env)
```
  - getEclipseConfig
```
public java.lang.String getEclipseConfig(java.lang.String property)
```
    Get the value of a property from the Eclipse configuration file (under Eclipse directory getEclipseDir())
    - ".eclipseproduct"
    - "configuration\config.ini"
    Parameters:
    
    property - String, the property name in Eclipse configuration file.
    
    Returns:
    
    String, the value of the property
    
    See Also:
    
    getEclipseDir()
  - getChromeDriver
```
public java.io.File getChromeDriver()
```
  - getIEDriver
```
public java.io.File getIEDriver()
```
  - getEdgeDriver
```
public java.io.File getEdgeDriver()
```
  - getChromniumEdgeDriver
```
public java.io.File getChromniumEdgeDriver()
```
  - getDriver
```
public java.io.File getDriver(java.lang.String browserName)
```
    Parameters:
    browserName - String, the key representing the browser, such as
    
    Constants.BrowserConstants.BROWSER_NAME_CHROME
    Constants.BrowserConstants.BROWSER_NAME_IE
    Constants.BrowserConstants.BROWSER_NAME_EDGE
    Returns:
    
    File, the driver executable file. The return value is never null, we need to call File.isFile() to verify its validity.
  - validate
```
protected SePlusInstallInfo validate()
                              throws SeleniumPlusException
```
    Validate the path of Selenium, Embedded Java, Library etc.
    
    Returns:
    
    SePlusInstallInfo, a valid SePlusInstallInfo holding correct information about Selenium, Embedded Java, Library etc.
    
    Throws:
    
    SeleniumPlusException - if the validation fails.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getSourceLocation
```
public static java.lang.String getSourceLocation()
```
    Returns:
    
    String, the source location of this class. ( xxx/libs/selenium-plus*.jar or xxx/lib/safsselenium.jar)
  - IsSeleniumPlus
```
public static boolean IsSeleniumPlus()
```
    To test if we are using product "SeleniumPlus".
    Either Satisfy:
    - The environment Constants.ENV_SELENIUM_PLUS must exist.
    - We are running from a SeleniumPlus installation (/libs/selenium-plus*.jar or Constants.ENV_SELENIUM_PLUS)
    OR
    Indicate the product by VM parameter -DPROPERTY_PRODUCT_NAME=PRODUCT_SELENIUM_PLUS OR
    The environment PROPERTY_PRODUCT_NAME is PRODUCT_SELENIUM_PLUS
    Returns:
    
    true if we are using product "SeleniumPlus"
  - IsSAFS
```
public static boolean IsSAFS()
```
    To test if we are using product "SAFS".
    Either Satisfy:
    - The environment Constants.ENV_SAFSDIR must exist.
    - We are running from a SAFS installation (/lib/safsselenium.jar or Constants.ENV_SAFSDIR)
    OR
    Indicate the product by VM parameter -DPROPERTY_PRODUCT_NAME=PRODUCT_SAFS
    Returns:
    
    boolean if we detect we are using product "SAFS"

Class SePlusInstallInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRODUCT_SELENIUM_PLUS

PRODUCT_SAFS

ENV_SELENIUM_PLUS

ENV_SAFSDIR

RELATIVE_DIR_ECLIPSE

RELATIVE_DIR_EXTRA_SAFS

RELATIVE_DIR_LIB_SAFS

RELATIVE_DIR_JAVA64_BIN_SAFS

RELATIVE_DIR_JAVA32_BIN_SAFS

RELATIVE_DIR_EXTRA_SEPLUS

RELATIVE_DIR_LIB_SEPLUS

RELATIVE_DIR_JAVA_BIN_SEPLUS

JAR_SELENIUM_SAFS

JAR_SELENIUM_SEPLUS

JAR_JSTAFEMBEDDED

INDICATOR_SEPLUS

INDICATOR_SAFS

CHOROMEDRIVER_WINDOWS

CHOROMEDRIVER_UNIX

GECKODRIVER_UNIX

GECKODRIVER_UNIX_64

IEDRIVER_WINDOWS

EDGEDRIVER_WINDOWS

CHROMIUM_EDGEDRIVER_WINDOWS

OPERADRIVER_WINDOWS

GECKODRIVER_WINDOWS

GECKODRIVER_WINDOWS_64

FAKE_DRIVER_NAME

NAME_PARTIAL_SELENIUM_SERVER_STDALONE

PROPERTY_PRODUCT_NAME

Method Detail

isSeleniumPlus

isSAFS

instance

getRootDir

setRootDir

getExtraDir

setExtraDir

getEclipseDir

getLibraryDir

setLibraryDir

getJavaexe

setJavaexe

getSeleniumStandaloneJar

setSeleniumStandaloneJar

getClassPath

isOverridePropertySet

GetSystemPropertyOrEnvironmentVariable

GetSystemEnvironmentVariable

getEclipseConfig

getChromeDriver

getIEDriver

getEdgeDriver

getChromniumEdgeDriver

getDriver

validate

toString

getSourceLocation

IsSeleniumPlus

IsSAFS