org.safs.install

Class InstallerImpl

java.lang.Object

org.safs.install.InstallerImpl

All Implemented Interfaces:

InstallerInterface

Direct Known Subclasses:

AndroidInstaller, DLLInstaller, GhostScriptInstaller, OCRInstaller, RFTInstaller, SAFSInstaller, SeleniumPlusInstaller, STAFInstaller, TCAFSInstaller

public abstract class InstallerImpl
extends java.lang.Object
implements InstallerInterface

Author:

Carl Nagle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InstallerImpl.BIT_OPTION
protected static class	InstallerImpl.VERSION_OPTION

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARG_DEBUG -debug if in debug mode
static java.lang.String	ARG_INSTALLDIR -installdir optional command-line argument to explicitly set the installation directory for an installer. Ex: -installdir "C:\SAFS" (for SAFS proper) Ex: -installdir "C:\SeleniumPlus" (for SeleniumPlus proper) Ex: -installdir "C:\SeleniumPlus\extra\automation" (for SeleniumPlus OCR, etc.)
static java.lang.String	ARG_SAFS_DIR -safs Ex: -safs "C:\SAFS" (for SAFS product) Ex: -safs "C:\SeleniumPlus" (for SeleniumPlus product)
static java.lang.String	ARG_SILENT -silent if in silent mode
static java.lang.String	ARG_UNINSTALL -u command-line argument to signal an uninstall invocation.
static java.lang.String	ARG_VERBOSE -v if in verbose mode, more details will be output
protected boolean	debug if installation is in debug more, default is false.
static java.lang.String	DIR_BIN bin the sub directory holds executable
static java.lang.String	DIR_INSTALL install the sub directory where to find the install stuffs, such as installer executable file
static java.lang.String	DIR_SAFS_HOME_DEFAULT c:\safs the directory holds the SAFS product
protected java.lang.String	home The home directory where this product will be installed. It may be the same as safsHome if we are installing SAFS or SeleniumPlus.
protected static java.lang.String	PARAM_SWITCH
protected static java.lang.String	PARAM_USE_LATEST_VERSION
protected IProductDetector	productDetector The ProductDetector.
(package private) static ProgressIndicator	progresser
static java.lang.String	REGSVR32
protected static java.lang.String	rootdir
static java.lang.String	s
protected java.lang.String	safsHome The full path to the SAFS or SeleniumPlus, which provides the installer for other tools. We don't use this field as the installation directory to install SAFS or SeleniumPlus, we use home. It is only used to find install asserts (for other tools, products needed by SAFS/SeleniumPlus) provided by SAFS or SeleniumPlus.
protected boolean	silent if installation is in silent more, default is true.
static java.lang.String	SYSTEM32
static java.lang.String	SYSWOW64
protected boolean	verbose if installation is in verbose more, default is false.

Constructor Summary

Constructors

Constructor and Description
InstallerImpl() Default no-arg constructor.
InstallerImpl(java.lang.String _installDir) Preset the installation directory so it does not need to be deduced.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendSystemEnvironment(java.lang.String varname, java.lang.String append, java.lang.String sep) Append a value to an existing Environment variable (CLASSPATH, PATH, etc..) This adds the value at the end of any existing value.
protected java.lang.String	findInstaller(java.lang.String executable)
java.lang.String	getDefaultHome()
protected IProductDetector	getDefaultProductDetector()
static java.lang.String	getEnvValue(java.lang.String key) Return a System Environment String value.
java.lang.String	getHome() The home directory where this product will be installed.
protected java.lang.String	getInstallationRoot() Subclasses use this to determine what is the root directory of the current install/uninstall that is in-progress.
protected java.lang.String	getInstallerDir()
protected java.lang.String	getProductName()
static java.lang.String	getRegistryValue(java.lang.String key, java.lang.String valuename) Gets the (Windows) registry value, or null if it doesn't exist.
java.lang.String	getSafsHome()
protected IProductDetector	getUnixProductDetector()
protected IProductDetector	getWindowsProductDetector()
static boolean	hasRegistryEntry(java.lang.String key, java.lang.String valuename) True if the requested "registry key" already exists, false otherwise. This is currently only supported on Windows.
protected static void	increaseProgress(int increase)
protected void	initilizeProductDetector() Initialize the IProdcutDetector object according to the Operation System. A ProductDetectorDefault will be returned if the OS is not Windows or UNIX/LINUX.
static java.lang.String	prependSystemEnvironment(java.lang.String varname, java.lang.String prepend, java.lang.String sep) Prepend a value to an existing Environment variable (CLASSPATH, PATH, etc..) This puts the value at the beginning of any existing value.
static java.lang.String	removeSystemEnvironmentSubstring(java.lang.String varname, java.lang.String substring, java.lang.String sep) Remove a substring from an existing Environment variable (CLASSPATH, PATH, etc..)
static java.lang.String	removeSystemEnvironmentSubstringContaining(java.lang.String varname, java.lang.String substring, java.lang.String sep) Remove a string entry from an existing Environment variable (CLASSPATH, PATH, etc..) In this method, we attempt to do a partial match on an entry between separators to locate the item to remove from the variable.
void	setEnvironment(java.lang.String key, java.lang.String value) A convenient method to set/clear an environment. It will also write success/failure message to progresser.
static boolean	setEnvValue(java.lang.String key, java.lang.String value) Set a System Environment value.
void	setHome(java.lang.String home)
protected static void	setProgress(int percent)
static void	setProgressIndicator(ProgressIndicator _progresser)
protected static void	setProgressMessage(java.lang.String message)
protected static void	setProgressMessage(java.lang.String message, int logLevel)
static boolean	setRegistryValue(java.lang.String key, java.lang.String valuename, java.lang.String value)
void	setSafsHome(java.lang.String safsHome)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.safs.install.InstallerInterface

install, uninstall

Field Detail

progresser

static ProgressIndicator progresser

s

public static final java.lang.String s

SYSTEM32

public static final java.lang.String SYSTEM32

SYSWOW64

public static final java.lang.String SYSWOW64

REGSVR32

public static final java.lang.String REGSVR32

PARAM_USE_LATEST_VERSION

protected static final java.lang.String PARAM_USE_LATEST_VERSION

PARAM_SWITCH

protected static final java.lang.String PARAM_SWITCH

DIR_INSTALL

public static final java.lang.String DIR_INSTALL

install the sub directory where to find the install stuffs, such as installer executable file

See Also:

Constant Field Values

DIR_BIN

public static final java.lang.String DIR_BIN

bin the sub directory holds executable

See Also:

Constant Field Values

DIR_SAFS_HOME_DEFAULT

public static final java.lang.String DIR_SAFS_HOME_DEFAULT

c:\safs the directory holds the SAFS product

See Also:

Constant Field Values

verbose

protected boolean verbose

if installation is in verbose more, default is false.

silent

protected boolean silent

if installation is in silent more, default is true.

debug

protected boolean debug

if installation is in debug more, default is false.

safsHome

protected java.lang.String safsHome

The full path to the SAFS or SeleniumPlus, which provides the installer for other tools.
We don't use this field as the installation directory to install SAFS or SeleniumPlus, we use home.
It is only used to find install asserts (for other tools, products needed by SAFS/SeleniumPlus) provided by SAFS or SeleniumPlus.

home

protected java.lang.String home

The home directory where this product will be installed.
It may be the same as safsHome if we are installing SAFS or SeleniumPlus.

productDetector

protected IProductDetector productDetector

The ProductDetector. Sub-class may need to implement:

• getDefaultProductDetector()
• getUnixProductDetector()
• getWindowsProductDetector()

See Also:

initilizeProductDetector()

ARG_INSTALLDIR

public static final java.lang.String ARG_INSTALLDIR

-installdir
optional command-line argument to explicitly set the installation directory for an installer.
Ex: -installdir "C:\SAFS" (for SAFS proper)
Ex: -installdir "C:\SeleniumPlus" (for SeleniumPlus proper)
Ex: -installdir "C:\SeleniumPlus\extra\automation" (for SeleniumPlus OCR, etc.)

See Also:

Constant Field Values

ARG_UNINSTALL

public static final java.lang.String ARG_UNINSTALL

-u
command-line argument to signal an uninstall invocation.

See Also:

Constant Field Values

ARG_SAFS_DIR

public static final java.lang.String ARG_SAFS_DIR

-safs Ex: -safs "C:\SAFS" (for SAFS product)
Ex: -safs "C:\SeleniumPlus" (for SeleniumPlus product)

See Also:

Constant Field Values

ARG_DEBUG

public static final java.lang.String ARG_DEBUG

-debug if in debug mode

See Also:

Constant Field Values

ARG_SILENT

public static final java.lang.String ARG_SILENT

-silent if in silent mode

See Also:

Constant Field Values

ARG_VERBOSE

public static final java.lang.String ARG_VERBOSE

-v if in verbose mode, more details will be output

See Also:

Constant Field Values

rootdir

protected static java.lang.String rootdir

Constructor Detail

InstallerImpl

public InstallerImpl()

Default no-arg constructor.

InstallerImpl

public InstallerImpl(java.lang.String _installDir)

Preset the installation directory so it does not need to be deduced.

Method Detail

getProductName

protected java.lang.String getProductName()

getSafsHome

public java.lang.String getSafsHome()

Returns:

String, The full path to the SAFS or SeleniumPlus, which provides the installer for other tools

setSafsHome

public void setSafsHome(java.lang.String safsHome)

Parameters:

safsHome - String, The full path to the SAFS or SeleniumPlus, which provides the installer for other tools

getHome

public java.lang.String getHome()

The home directory where this product will be installed.

setHome

public void setHome(java.lang.String home)

Parameters:

home - String, The home directory where this product will be installed.

getDefaultHome

public java.lang.String getDefaultHome()

Returns:

String, the default home directory to install the product

getInstallerDir

protected java.lang.String getInstallerDir()

Returns:

String, the full path to get the installer executable file.
such as C:/safs/install or C:/SeleniumPlus/install

findInstaller

protected java.lang.String findInstaller(java.lang.String executable)
                                  throws java.io.FileNotFoundException

Parameters:

executable - String, the installer executable file name

Returns:

String, the full path of the installer executable file

Throws:

java.io.FileNotFoundException

getInstallationRoot

protected java.lang.String getInstallationRoot()

Subclasses use this to determine what is the root directory of the current install/uninstall that is in-progress.

Needs to be enhanced to temporarily flag what is in-progress, versus what might already exist as deduced from the normal SAFSDIREnv or SELENIUMDIREnv.

Returns:

initilizeProductDetector

protected void initilizeProductDetector()
                                 throws java.lang.UnsupportedOperationException

Initialize the IProdcutDetector object according to the Operation System.
A ProductDetectorDefault will be returned if the OS is not Windows or UNIX/LINUX.

Throws:

java.lang.UnsupportedOperationException

getWindowsProductDetector

protected IProductDetector getWindowsProductDetector()
                                              throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

getUnixProductDetector

protected IProductDetector getUnixProductDetector()
                                           throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

getDefaultProductDetector

protected IProductDetector getDefaultProductDetector()

Returns:

ProductDetectorDefault

See Also:

ProductDetectorDefault

setProgressIndicator

public static void setProgressIndicator(ProgressIndicator _progresser)

setProgress

protected static void setProgress(int percent)

increaseProgress

protected static void increaseProgress(int increase)

setProgressMessage

protected static void setProgressMessage(java.lang.String message)

setProgressMessage

protected static void setProgressMessage(java.lang.String message,
                                         int logLevel)

getEnvValue

public static java.lang.String getEnvValue(java.lang.String key)

Return a System Environment String value.

Note: Environment variables set or changed after JVM start are NOT available to the currently running JVM through System.getEnv(). This is because the JVM does not refresh its Environment variable space after launch. Use this routine to get the latest "refreshed" value of any System Environment Variable.

Parameters:

key - Environment variable value to retrieve.

Returns:

String value, or null if not found.

setEnvValue

public static boolean setEnvValue(java.lang.String key,
                                  java.lang.String value)

Set a System Environment value.

Note: Environment variables set or changed after JVM start are NOT available to the currently running JVM through System.getEnv(). This is because the JVM does not refresh its Environment variable space after launch. Use getEnvValue to get the latest "refreshed" value of any System Environment Variable.

Parameters:

key - name of variable to set

value - to be set. Null will remove the variable.

Returns:

true on succes, false otherwise.

See Also:

NativeWrapper.SetSystemEnvironmentVariable(Object, Object), getEnvValue(String)

setEnvironment

public void setEnvironment(java.lang.String key,
                           java.lang.String value)

A convenient method to set/clear an environment.
It will also write success/failure message to progresser.

Parameters:

key - name of variable to set

value - to be set. Null will remove the variable.

See Also:

setEnvValue(String, String)

appendSystemEnvironment

public static java.lang.String appendSystemEnvironment(java.lang.String varname,
                                                       java.lang.String append,
                                                       java.lang.String sep)

Append a value to an existing Environment variable (CLASSPATH, PATH, etc..)
This adds the value at the end of any existing value.

Parameters:

varname - -- name of Environment variable to modify. cannot be null.

append - -- the value to add if it is not already present. cannot be null.

sep - - optional separator to use between appends. if null, File.pathSeparator is used. Can also be an empty string to indicate no separator should be used.

Returns:

the new value of the variable, or null if a problem occurred.

prependSystemEnvironment

public static java.lang.String prependSystemEnvironment(java.lang.String varname,
                                                        java.lang.String prepend,
                                                        java.lang.String sep)

Prepend a value to an existing Environment variable (CLASSPATH, PATH, etc..)
This puts the value at the beginning of any existing value.

Parameters:

varname - -- name of Environment variable to modify. cannot be null.

prepend - -- the value to prepend if it is not already present. cannot be null.

sep - - optional separator to use between values. if null, File.pathSeparator is used. Can also be an empty string to indicate no separator should be used.

Returns:

the new value of the variable, or null if a problem occurred.

removeSystemEnvironmentSubstring

public static java.lang.String removeSystemEnvironmentSubstring(java.lang.String varname,
                                                                java.lang.String substring,
                                                                java.lang.String sep)

Remove a substring from an existing Environment variable (CLASSPATH, PATH, etc..)

Parameters:

varname - -- name of Environment variable to modify. cannot be null.

substring - -- the value to remove if it is present. cannot be null.

sep - - optional separator found between values. if null, File.pathSeparator is assumed. Can also be an empty string to indicate no separator should be considered.

Returns:

the new value of the variable, or null if a problem occurred or the variable no longer exists.

removeSystemEnvironmentSubstringContaining

public static java.lang.String removeSystemEnvironmentSubstringContaining(java.lang.String varname,
                                                                          java.lang.String substring,
                                                                          java.lang.String sep)

Remove a string entry from an existing Environment variable (CLASSPATH, PATH, etc..)
In this method, we attempt to do a partial match on an entry between separators to locate the item to remove from the variable. After making a partial match, we remove the full substring between the separators.

Ex: removeSystemEnvironmentSubstringContaining("CLASSPATH", "\\safs.jar", null);
This will remove the safs.jar reference in CLASSPATH no matter what the path to it might be.

Parameters:

varname - -- name of Environment variable to modify. cannot be null.

substring - -- the partial match value to remove, if it is present. cannot be null.

sep - - optional separator found between values. if null or zero-length then File.pathSeparator is used.

Returns:

the new value of the variable, or null if a problem occurred.

hasRegistryEntry

public static boolean hasRegistryEntry(java.lang.String key,
                                       java.lang.String valuename)

True if the requested "registry key" already exists, false otherwise.
This is currently only supported on Windows.

The Windows version uses Reg.EXE which is supplied with WindowsXP. If this EXE is not present on the Windows system then this function will return false.

Parameters:

key - For Windows this is a String. Ex:"HKCU\\Environment"

valuename - For Windows this is a String. Ex:"Path". Can be null.

Returns:

true if the key and value (if provided) exists, otherwise false.

getRegistryValue

public static java.lang.String getRegistryValue(java.lang.String key,
                                                java.lang.String valuename)

Gets the (Windows) registry value, or null if it doesn't exist.

Parameters:

key - -- Ex: "HKCU\\Environment"

valuename - -- Ex: "Path". can be null

Returns:

the value found in the registry, or null if not found.

See Also:

NativeWrapper.GetRegistryKeyValue(Object, Object)

setRegistryValue

public static boolean setRegistryValue(java.lang.String key,
                                       java.lang.String valuename,
                                       java.lang.String value)

Parameters:

key -

valuename -

value -

Returns:

See Also:

NativeWrapper.GetRegistryKeyValue(Object, Object)