org.safs.install

Interface IProductDetector

All Known Implementing Classes:

ProductDetectorDefault

interface IProductDetector

If a product (multiple versions of one product) has been installed, we may want to know:

• where it has (they have) been installed.
• what installation path is preferable to use if multiples are installed
• what are the possible executables

Author:

Lei Wang

Method Summary

Modifier and Type	Method and Description
java.lang.String	appendInstallDirOption(java.lang.String command, java.lang.String installDirectory) Append installation directory option to installer and uninstaller
java.lang.String	appendOptions(java.lang.String command, java.lang.String... options) Append options to installer and uninstaller
java.lang.String	appendSientOption(java.lang.String command) Append silent option to installer and uninstaller
java.lang.String	findUnInstaller(java.lang.String home)
java.lang.String[]	getBins()
java.lang.String	getDefaultHome()
java.util.Map<java.lang.String,java.lang.String>	getHomes() Note: The map's key is used for choosing product to use. User will decide key's format.
java.lang.String	getInstaller() The installer is always under the SAFS/SeleniumPlus install's folder.
java.lang.String[]	getPossibleExecutables()
java.lang.String	getPreferredHome()
InstallerImpl.BIT_OPTION	getProductBit()
java.lang.String	getUnInstaller() The un-installer is under the product itself folder.
java.io.File	getValidExecutable(java.io.File home, java.lang.String defaultExecutable) Find the valid executable for the product. The search logic could be: 1.
void	setProductBit(InstallerImpl.BIT_OPTION productBit)

Method Detail

getHomes

java.util.Map<java.lang.String,java.lang.String> getHomes()

Note: The map's key is used for choosing product to use.
User will decide key's format. It could be "ProductName+VersionNumber" or "VersionNumber".

Returns:

Map, a map containing pairs of (key, product_installation_full_path).
an empty map if non installation has been detected.

getPreferredHome

java.lang.String getPreferredHome()

Returns:

String, the preferred product_installation_full_path if multiple products have been installed.
null if non product installation is detected.

getDefaultHome

java.lang.String getDefaultHome()

Returns:

String, the default home directory to install the product

getBins

java.lang.String[] getBins()

Returns:

String[], an array of sub folder (relative to the product home) holding executables. An empty array if there is no possible value.

getPossibleExecutables

java.lang.String[] getPossibleExecutables()

Returns:

String[], an array of "relative path" for possible executables (relative to the product home).
The first element is the most favorable; the last the least favorable.
An empty array if no executable is possible.

getValidExecutable

java.io.File getValidExecutable(java.io.File home,
                                java.lang.String defaultExecutable)
                         throws java.io.FileNotFoundException

Find the valid executable for the product.
The search logic could be:
1. find the default executable under product home
2. find the default executable under the getBins() sub folder of product home
3. find the getPossibleExecutables() under the product home

Parameters:

home - File, the product home directory

defaultExecutable - String, the default executable. It could be name or "path relative to home".

Returns:

File, the valid executable

Throws:

java.io.FileNotFoundException - if no executable could be found

See Also:

ProductDetectorDefault

getProductBit

InstallerImpl.BIT_OPTION getProductBit()

Returns:

BIT_OPTION, the bit (32 or 64) of the product to detect.

setProductBit

void setProductBit(InstallerImpl.BIT_OPTION productBit)

Parameters:

productBit - BIT_OPTION, the bit (32 or 64) of the product to detect.

getUnInstaller

java.lang.String getUnInstaller()

The un-installer is under the product itself folder.

Returns:

String, the un-installer's file name, it might be different between 32 bits and 64 bits product.

getInstaller

java.lang.String getInstaller()

The installer is always under the SAFS/SeleniumPlus install's folder.

Returns:

String, the installer's file name, it might be different between 32 bits and 64 bits product.

findUnInstaller

java.lang.String findUnInstaller(java.lang.String home)
                          throws java.io.FileNotFoundException

Parameters:

home - String, the product's home directory

Returns:

String, the full path to the un-installer executable

Throws:

java.io.FileNotFoundException - if not found

appendSientOption

java.lang.String appendSientOption(java.lang.String command)

Append silent option to installer and uninstaller

appendInstallDirOption

java.lang.String appendInstallDirOption(java.lang.String command,
                                        java.lang.String installDirectory)

Append installation directory option to installer and uninstaller

appendOptions

java.lang.String appendOptions(java.lang.String command,
                               java.lang.String... options)

Append options to installer and uninstaller