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	gerPreferredHome()
java.lang.String[]	getBins()
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[]	getPossibleExecutables()
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.

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.

gerPreferredHome

java.lang.String gerPreferredHome()

Returns:

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

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