SeleniumPlusInstaller (SAFS API DOCUMENT)

java.lang.Object
- org.safs.install.InstallerImpl
- - org.safs.install.SeleniumPlusInstaller

All Implemented Interfaces:: InstallerInterface, DebugListener, NamedListener

public class SeleniumPlusInstaller
extends InstallerImpl
implements DebugListener

Nested Class Summary
- Nested classes/interfaces inherited from class org.safs.install.InstallerImpl
  InstallerImpl.BIT_OPTION, InstallerImpl.VERSION_OPTION

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static Console`	`console`
`(package private) static boolean`	`debug`
`static java.lang.String`	`DEFAULT_UNX_SELENIUMPLUS_DIR` "/usr/local/seleniumplus"
`(package private) static java.lang.String[]`	`findStrings`
`static java.lang.String`	`HKLM_RUN_KEY`
`static java.lang.String`	`HKLM_RUN_MONITOR`
`static java.lang.String`	`HKLM_RUN_SERVER`
`(package private) static java.lang.String`	`installedstafdir`
`(package private) static boolean`	`installsafs`
`(package private) static boolean`	`installstaf`
`(package private) static java.lang.String`	`installstafexe`
`(package private) static int`	`pctIncrement`
`(package private) static int`	`pctProgress`
`(package private) static int`	`pctSTAFInstall`
`(package private) static int`	`pctSTAFUninstall`
`(package private) static ProgressIndicator`	`progresser` progressbar is a swing panel to show the progress of installation.
`(package private) static boolean`	`propogate`
`(package private) static boolean`	`removesafs`
`(package private) static boolean`	`removestaf`
`static java.lang.String`	`SAFSJARPath`
`static java.lang.String`	`SELENIUMBINPath`
`(package private) static java.lang.String`	`seleniumdir`
`static java.lang.String`	`SELENIUMDIRAutomation`
`static java.lang.String`	`SELENIUMDIREnv`
`static java.lang.String`	`SELENIUMLIBPath`
`static java.lang.String`	`SELENIUMOCRPath`
`(package private) static boolean`	`silent`
`(package private) static java.lang.String`	`stafdir`
`static java.lang.String`	`STAFEmbeddedJARPath`
`(package private) static boolean`	`uninstall`
`(package private) static boolean`	`verbose`

Fields inherited from class org.safs.install.InstallerImpl
ARG_DEBUG, ARG_INSTALLDIR, ARG_SAFS_DIR, ARG_SILENT, ARG_UNINSTALL, ARG_VERBOSE, DIR_BIN, DIR_INSTALL, DIR_SAFS_HOME_DEFAULT, home, PARAM_SWITCH, PARAM_USE_LATEST_VERSION, productDetector, REGSVR32, rootdir, safsHome, SYSTEM32, SYSWOW64

Constructor Summary

Constructors
Constructor and Description

SeleniumPlusInstaller()

Constructors
Constructor and Description
`SeleniumPlusInstaller()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) java.lang.String`	`convertWinReplaceString(java.lang.String findStr, java.lang.String replaceStr)`
`(package private) static boolean`	`createSeleniumPlusProgramGroup()` Create SeleniumPlus Program Group and shortcuts.
`(package private) static int`	`doSTAFInstall()` Perform STAF install.
`(package private) static int`	`doSTAFUnInstall()` Perform uninstall STAF.
`java.lang.String`	`getListenerName()` Unique name to identify the listener.
`(package private) static void`	`initialize()`
`boolean`	`install(java.lang.String... args)` Currently assumes SeleniumPlus has been installed (unzipped) and SELENIUM_PLUS is already set.
`static boolean`	`isSelPlusProject(java.io.File directory)` Check if SeleniumPlus project or not
`static void`	`main(java.lang.String[] args)` This Installer provides no GUI, but will accept some configuration parameters.
`void`	`onReceiveDebug(java.lang.String message)` A remote client has sent a Debug message to be logged by the listener.
`(package private) static void`	`parseArgs(java.lang.String[] args)`
`(package private) static void`	`printArgs(java.lang.String[] args)`
`boolean`	`uninstall(java.lang.String... args)` Unset the System Environment Variables used by SeleniumPlus.

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

- Field Detail
  - SELENIUMDIREnv
```
public static final java.lang.String SELENIUMDIREnv
```
    See Also:
    
    Constant Field Values
  - SELENIUMDIRAutomation
```
public static final java.lang.String SELENIUMDIRAutomation
```
  - SELENIUMBINPath
```
public static final java.lang.String SELENIUMBINPath
```
  - SELENIUMOCRPath
```
public static final java.lang.String SELENIUMOCRPath
```
  - SELENIUMLIBPath
```
public static final java.lang.String SELENIUMLIBPath
```
  - SAFSJARPath
```
public static final java.lang.String SAFSJARPath
```
  - STAFEmbeddedJARPath
```
public static final java.lang.String STAFEmbeddedJARPath
```
  - HKLM_RUN_KEY
```
public static final java.lang.String HKLM_RUN_KEY
```
    See Also:
    
    Constant Field Values
  - HKLM_RUN_MONITOR
```
public static final java.lang.String HKLM_RUN_MONITOR
```
    See Also:
    
    Constant Field Values
  - HKLM_RUN_SERVER
```
public static final java.lang.String HKLM_RUN_SERVER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UNX_SELENIUMPLUS_DIR
```
public static final java.lang.String DEFAULT_UNX_SELENIUMPLUS_DIR
```
    "/usr/local/seleniumplus"
    
    See Also:
    
    Constant Field Values
  - installsafs
```
static boolean installsafs
```
  - removestaf
```
static boolean removestaf
```
  - removesafs
```
static boolean removesafs
```
  - installstaf
```
static boolean installstaf
```
  - installedstafdir
```
static java.lang.String installedstafdir
```
  - installstafexe
```
static java.lang.String installstafexe
```
  - seleniumdir
```
static java.lang.String seleniumdir
```
  - stafdir
```
static java.lang.String stafdir
```
  - uninstall
```
static boolean uninstall
```
  - propogate
```
static boolean propogate
```
  - debug
```
static boolean debug
```
  - silent
```
static boolean silent
```
  - verbose
```
static boolean verbose
```
  - console
```
static Console console
```
  - progresser
```
static ProgressIndicator progresser
```
    progressbar is a swing panel to show the progress of installation.
  - pctProgress
```
static int pctProgress
```
  - pctIncrement
```
static int pctIncrement
```
  - pctSTAFUninstall
```
static int pctSTAFUninstall
```
  - pctSTAFInstall
```
static int pctSTAFInstall
```
  - findStrings
```
static final java.lang.String[] findStrings
```
- Constructor Detail
  - SeleniumPlusInstaller
```
public SeleniumPlusInstaller()
```
- Method Detail
  - printArgs
```
static void printArgs(java.lang.String[] args)
```
  - parseArgs
```
static void parseArgs(java.lang.String[] args)
```
  - initialize
```
static void initialize()
```
  - doSTAFInstall
```
static int doSTAFInstall()
```
    Perform STAF install. If -silent parameter was specified then a silent install will be done.
    Currently all installs are silent.
    If -staf parameter was specified then the install will attempt to use any provided user-specified directory for the install.
  - doSTAFUnInstall
```
static int doSTAFUnInstall()
```
    Perform uninstall STAF. Uninstall STAF silently.
  - convertWinReplaceString
```
java.lang.String convertWinReplaceString(java.lang.String findStr,
                                         java.lang.String replaceStr)
```
  - createSeleniumPlusProgramGroup
```
static boolean createSeleniumPlusProgramGroup()
```
    Create SeleniumPlus Program Group and shortcuts.
    
    Returns:
    
    boolean true if successful
  - install
```
public boolean install(java.lang.String... args)
```
    Currently assumes SeleniumPlus has been installed (unzipped) and SELENIUM_PLUS is already set. Can set SELENIUM_PLUS if args[0] is given a valid value to use. If args[0] is provided, the path will be validated before it is used. Adds SeleniumPlus paths to CLASSPATH and PATH Environment Variables as long as SeleniumPlus JAR is found to exist.
    
    Specified by:
    
    install in interface InstallerInterface
  - uninstall
```
public boolean uninstall(java.lang.String... args)
```
    Unset the System Environment Variables used by SeleniumPlus. Remove SELENIUM_PLUS and paths from CLASSPATH and PATH Environment Variables. Can unset SELENIUM_PLUS if args[0] is given a value to use.
    
    Specified by:
    
    uninstall in interface InstallerInterface
    
    Parameters:
    
    args -
    
    Returns:
  - main
```
public static void main(java.lang.String[] args)
```
    This Installer provides no GUI, but will accept some configuration parameters. Any user-specified directories must exist; or, we must not be denied the ability to create them and write/copy files to them.
    Parameters:
    args - String[]
    The following parameters or arguments can be specified:
    
    <SeleniumPlusPath>
    the root directory where SeleniumPlus resides.
    This is usually the directory where the Setup script resides.
    
    -u
    perform an uninstall instead of install.
    
    -np
    If the -np option is not provided, then the installer will propogate and execute other necessary Installers.
    
    -nostaf
    Skip the installation of STAF.
    
    -staf "alternate STAF directory"
    Install STAF files and services to the user specified directory instead of the default install directory.
    The -staf argument does not have to be specified to install to the default directory (root\STAF).
    
    -removestaf installedstafdir
    Remove the installed STAF. installedstafdir indicates the directory where staf is installed, like "C:\STAF\" or "/usr/local/staf"
    
    -installstafexe alternateSTAFexecutable
    Indicate an alternate (newer) STAF installation executable to use.
    This will override the STAF 3 or later default executable.
    
    Main Java executable. Primarily to run standalone outside of a larger process.
    %SELENIUMPLUSDIR%\Java\jre\bin\java org.safs.install.SeleniumPlusInstaller [C:\SeleniumPlus]
    %SELENIUMPLUSDIR%\Java\jre\bin\java org.safs.install.SeleniumPlusInstaller -u [C:\SeleniumPlus]
    If the -np option is not provided, then the installer will propogate and execute other necessary SAFS Framework Installers.
    System.exit(0) on perceived success.
    System.exit(-1) on perceived failure.
    "-u" -- to perform an uninstall instead of install.
    "-np" -- do not propogate to other installers.
    Any first arg other than (-u or -np) will be considered the path for SELENIUMPLUSDIR.
    The path for SELENIUMPLUSDIR does NOT need to be provided if the System Environment Variable already exists with a valid setting.
    See Also:
    
    SilentInstaller, propogate
  - getListenerName
```
public java.lang.String getListenerName()
```
    Description copied from interface: NamedListener
    
    Unique name to identify the listener.
    
    Specified by:
    
    getListenerName in interface NamedListener
    
    Returns:
    
    name of listener. Might be null.
  - onReceiveDebug
```
public void onReceiveDebug(java.lang.String message)
```
    Description copied from interface: DebugListener
    
    A remote client has sent a Debug message to be logged by the listener.
    
    Specified by:
    
    onReceiveDebug in interface DebugListener
  - isSelPlusProject
```
public static boolean isSelPlusProject(java.io.File directory)
```
    Check if SeleniumPlus project or not
    
    Parameters:
    
    directory -
    
    Returns:
    
    -- true or false

Class SeleniumPlusInstaller

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.install.InstallerImpl

Field Summary

Fields inherited from class org.safs.install.InstallerImpl

Constructor Summary

Method Summary

Methods inherited from class org.safs.install.InstallerImpl

Methods inherited from class java.lang.Object

Field Detail

SELENIUMDIREnv

SELENIUMDIRAutomation

SELENIUMBINPath

SELENIUMOCRPath

SELENIUMLIBPath

SAFSJARPath

STAFEmbeddedJARPath

HKLM_RUN_KEY

HKLM_RUN_MONITOR

HKLM_RUN_SERVER

DEFAULT_UNX_SELENIUMPLUS_DIR

installsafs

removestaf

removesafs

installstaf

installedstafdir

installstafexe

seleniumdir

stafdir

uninstall

propogate

debug

silent

verbose

console

progresser

pctProgress

pctIncrement

pctSTAFUninstall

pctSTAFInstall

findStrings

Constructor Detail

SeleniumPlusInstaller

Method Detail

printArgs

parseArgs

initialize

doSTAFInstall

doSTAFUnInstall

convertWinReplaceString

createSeleniumPlusProgramGroup

install

uninstall

main

getListenerName

onReceiveDebug

isSelPlusProject