org.safs.selenium.util

Class SePlusInstallInfo

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	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	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	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

Modifier and Type	Method and Description
java.io.File	getChromeDriver()
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 SePlusInstallInfo	instance()
boolean	isSAFS()
static boolean	IsSAFS() To test if we are using product "SAFS".
boolean	isSeleniumPlus()
static boolean	IsSeleniumPlus() To test if we are using product "SeleniumPlus".
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

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

OPERADRIVER_WINDOWS

public static final java.lang.String OPERADRIVER_WINDOWS

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

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)

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()

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". Needs 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)

Returns:

true if we are using product "SeleniumPlus"

IsSAFS

public static boolean IsSAFS()

To test if we are using product "SAFS". Needs satisfy:

• The environment Constants.ENV_SAFSDIR must exist.
• We are running from a SAFS installation (/lib/safsselenium.jar or Constants.ENV_SAFSDIR)

Returns:

boolean if we detect we are using product "SAFS"