com.denova.JExpress.Installer
Class CustomUninstaller

java.lang.Object
  com.denova.JExpress.Installer.CustomUninstaller

All Implemented Interfaces:

InstallPropertyNames, com.denova.JExpress.JExpressConstants, WindowsConstants

public class CustomUninstaller
extends java.lang.Object
implements com.denova.JExpress.JExpressConstants, WindowsConstants, InstallPropertyNames

Add commands to the uninstaller to remove files and directories that your custom installer classes or your app adds that you want removed when your app is deleted.

Author:

DeNova © 1997-2012 DeNova.com Last modified: 2012-04-04

Field Summary

Fields inherited from interface com.denova.JExpress.JExpressConstants

AdvancedApp, AdvancedEdition, AppDirVariable, AppNameVariable, ArchitectureVariable, AuthorVariable, AutoRunInfFilename, AutoStartupUninstallerFile, BackgroundImageLayout, BasedirPlaceHolder, BasePathArgument, BatchFileExtension, BuildDirArgumentNew, BuildDirArgumentOld, BuilderDirectory, BuilderPackage, BuilderWaitFilename, BuildX32Installer, BuildX64Installer, ClassFileExtension, Classpath, ConfigDirectory, ControlUrlPatchableString, CopyCheqApiJar, CopyCheqDirectory, CopyFileCommand, Copyright, CopyrightSuffix, CreatedFilename, CrossPlatformExecName, CrossPlatformJarVariable, CrossPlatformName, CurrentProjectFilename, CustomClassesCommand, CustomInstallClassesDir, CustomLoaderPrefix, CustomPlatformOptionsFilename, CustomUninstallClassesDir, CustomUninstallDir, CustomUpdateClassesDir, DefaultBackgroundColor, DefaultBrowser, DefaultButtonPosition, DefaultImagePosition, DefaultJpegInstallerImage, DefaultJpegUpdaterImage, DefaultLookAndFeel, DefaultOptionsFilename, DefaultParentAppDir, DefaultProgressBarColor, DefaultProjectFilename, DefaultShowIcons, DefaultShowLaunchDialog, DefaultSynthTheme, DefaultTempDirectory, DefaultTextColor, DefaultUninstallerIcon, DefaultUpdaterIcon, DefaultUseTooltips, DelDirIfEmptyCommand, DelFileCommand, DelManifestCommand, DelPropertyStorageCommand, DelTreeCommand, DownloadUrlFlag, DownloadUrlVariable, EditionEnds, EditionStarts, ExampleProject, ExitIconName, ExitLabel, ExtraParametersFlag, FilesList, GzipFileExtension, GzipListFilename, HtmlFileExtension, InstallerDirectory, InstallerExecVariable, InstallerMainClass, InstallerPackage, InstallersSubdir, InstallerUrlPatchableString, InstallOptionsFilename, JarFileExtension, JarFileSuffix, JavaAppArguments, JavaAppExecutable, JavaAppProgramName, JavaAppPropertiesAltDir, JavaAppPropertiesFilename, JavaAppStandardArguments, JavaAppStartDir, JavaHomeVariable, JexControlPropertiesFilename, JexDataDir, JexDataFilename, JExpressAdvancedApp, JExpressApp, JExpressCopyCheqClassname, JExpressCustomClassName, JExpressInstallerClassName, JExpressJpegLogoFilename, JExpressUninstallerClassName, JExpressUpdaterClassName, JExpressWizardApp, KdePngIconExtension, KdeXpmIconExtension, KeystoreDbFilename, LastTab, LicenseAccountTemplate, LicenseAppRightTemplate, LicenseCheckAppTemplate, LicenseCheckInstallTemplate, LicenseCheckUpdateTemplate, LicenseEmailTemplate, LicenseIDTemplate, LicenseNameTemplate, LicenseOptionsFilename, LicenseProductTemplate, LicenseRightTemplate, LicenseServerFailTemplate, LoaderIsInPackage, LoaderPrefixControl, LocalBuildProperty, LookAndFeelArgument, MacInstallerCommandFilename, MacOsXIconExtension, NativeInstallerLog, NativePropertiesFilename, NativeStartDirFilename, NimbusSubdir, NimRODSubdir, OverwriteFileCommand, PlatformOptionsFilename, PlatformsDirectory, PlatformsParentDir, PlatformVariable, ProgFilesDirVariable, ProjectFileSuffix, ProjectsSubdir, PropertiesFlag, PureJavaDirectory, RawLoaderFilename, RecentJexProjects, RegistrationFilename, RenFileCommand, SearchEverywhereForJvm, SearchIconName, SearchNowhereForJvm, SearchPathForJvm, SelectedNativePlatformsNoJvm, SelectedNativePlatformsWithJvm, SelectedSpecialPlatforms, SilentArgument, SilentFlag, SingleFileGroup, StandaloneDirectory, StandalonePureJavaPrefix, StandardJvmExtraParameters, StandardUserClasspath, SynthSubdir, SystemChangesFilename, TarGzipFileExtension, TellUserHowToStart, TempDirectory, TestDesktopIconPrefix, TestDesktopIcons, TestFlag, ThemesDirectory, TitleCommand, TooManyComputers, TooManyUsers, TrackUninstallCommand, TrialAccount, TrialExpired, TrialLicense, TrialProduct, UninstallerDirectory, UninstallerPackage, UninstallerSubdir, UninstallInstructions, UninstallLinuxServiceCommand, UninstallOptionsFilename, UninstallPathFilename, UninstallWinServiceCommand, UpdateControlPropertiesFilename, UpdateManifestDirectory, UpdateManifestFilename, UpdateMenuPrefix, UpdaterDirectory, UpdaterPackage, UpdateScriptName, UpdatesDirectory, UpdateUrlArgument, UploadDirArgumentNew, UploadDirArgumentOld, UserHomeVariable, UserInstallerDirectory, UserInterface, UserInterfacesFile, UserJExpressDirectory, VersionArgument, VersionEnds, VersionFilename, VersionStarts, VersionVariable, WebDirectory, WebPagesDirectory, WebsiteVariable, WebStartJarVariable, WebStartPlatformName, WebStartWrapperJar, WindowsDirectory, WindowsDirVariable, WindowsIconExtension, WizardApp, WizardEdition, WorkingDirVariable, ZipFileExtension, ZipSkipPatchableString

Fields inherited from interface com.denova.runtime.WindowsConstants

AddRegistryEntry, AllUsers, ArchitectureAMD64, ArchitectureIA64, ArchitectureIntel, ArchitectureUnknown, ArchitectureX64, ArchitectureX86, ArchitectureX86_64, BinaryType, CurrentUser, DeleteAttribute, DeleteRegistryEntry, DesktopSpecFilename, DWordType, ExecExtension, InvokerFilename, MenuSpecFilename, RegistrySpecFilename, ReplaceRegistryEntry, StringType, WindowsCleanupCommand, WindowsCmdLogFilename, WindowsDelDesktop, WindowsDelProgramsMenu, WindowsDelStartupMenu, WindowsProgramsMenuCommand, WindowsRegistryEditorCommand

Fields inherited from interface com.denova.JExpress.Installer.InstallPropertyNames

AbortIfErrorWithDefaultInstallDir, ApplicationDirectory, ApplicationDirectoryTarget, Author, AutoDetectLanguage, AutoupdateEveryStartup, AutoupdateNever, AutoupdateOnDemand, BackgroundColor, BasePath, CheckGuiRunningCommand, CheckLicenseDuringInstall, CheckLicenseDuringUpdate, CheckLicenseFromYourApp, CheckPreVersion, ClickFreeInstaller, ClickFreeUninstaller, ClickFreeUpdater, CompressedFileSize, ConfigureWinRegistry, CreatedMenuDirs, CustomAfterDirectoryWizardPanelClass, CustomAfterFilesInstalledWizardPanelClass, CustomAfterInstallWizardPanelClass, CustomAfterLicenseWizardPanelClass, CustomAfterMenusWizardPanelClass, CustomAfterMultipleInstallsWizardPanelClass, CustomAfterReadMeWizardPanelClass, CustomAfterWelcomeWizardPanelClass, CustomBeforeInstallWizardPanelClass, DefaultApplicationDirectory, DefaultLinuxParentAppDir, DefaultMacParentAppDir, DefaultOtherParentAppDir, DefaultSolarisParentAppDir, DefaultWindowsParentAppDir, DownloadUrl, ExtraParameters, FailIfNoLicenseServer, FileGroupsFolders, FileGroupsTypes, InitialUserName, InstallAsAdmin, InstallationStarted, InstallButtonsPosition, InstallerDefaultLanguage, InstallerExecutable, InstallerExtraFiles, InstallImageFilename, InstallImagePosition, InstallJvmParameters, InstallLicenseFilename, InstallPasswordDigest, InstallReadmeFilename, InstallSuccessful, InstallType, InstallUserClasspath, IsServlet, JavaAppFilesSigned, JvmClasspathSwitch, JvmCommandName, JvmExtraParameters, JvmHomeDir, JvmMaxVersion, JvmMinVersion, JvmName, JvmRequiredVersion, JvmSelfExtractor, JvmVersion, LAFTheme, LicenseAccount, LicenseAppRight, LicenseEndUser, LicenseError, LicenseIdCode, LicenseName, LicensePrimaryContact, LicenseProduct, LicenseRight, LoaderClasspath, LoaderJavaCommand, LookAndFeelInterface, MainClassname, MenuAllUsers, MenuArguments, MenuAssociatedInstallType, MenuAutoStartup, MenuAutoUpdate, MenuCommandLineArguments, MenuDesktopShortcut, MenuExecutableFile, MenuGnome, MenuIconName, MenuInstallAsService, MenuKDE, MenuLongName, MenuMac, MenuRunAsAdmin, MenusAttributeName, MenuShortName, MenuStartAfterInstall, MenuToStart, MenuUnix, MenuUseJavaCommandPrefix, MenuUseJavaConsole, MenuWindows, MenuWorkingDir, MenuXfce, MinimizedImageFilename, MultipleComponents, MultipleFileGroups, MultipleInstallTypes, NativeJvmHomeDir, NativeJvmInstalled, NativeJvmInstalledInTemp, NextInstallTypes, OldApplicationDirectory, OnDemandDesktopShortcut, PackageCopyright, PackageCreated, PackageName, PackageVersion, PackJarFile, PredefinedJvmInstallDir, PreviousApplicationDir, PreviousVersion, ProgressBarColor, PromptForInstallDir, PromptUserBeforeUninstalling, ProxyHost, ProxyPassword, ProxyPort, ProxyUserName, RelativeFileMap, SafePackageName, SaveFilePermissions, SaveInstallEnvironment, SearchForJvm, SecondaryUpdater, SelectedInstallTypes, SetLastModifiedDate, ShowFinalPanel, ShowFrame, ShowWelcomePanel, SilentConfigFilename, SilentInstall, SilentUninstaller, SilentUpdater, SingleInstallType, StartAppName, StartDirectory, StartGuiCommand, Submenu, SystemSecurityPolicyFilename, TestPropertiesFilename, TextColor, TextFileExtensions, TotalBytesNeeded, TotalCompressedFiles, TrackConversions, UncompressedTotalSize, UninstallCommand, UninstallerArgs, UninstallerIconPath, UninstallerPathname, UnzipExecutable, UserRequestedSilentInstall, UserSecurityPolicyFilename, WebSite

Constructor Summary

CustomUninstaller()
CustomUninstaller lets you customize the uninstaller for your app.

Method Summary

boolean	addSubkeyEntry(java.lang.String keyName, java.lang.String subKeyName, java.lang.String subKeyData) Adds the subKeyName and its data to the registry if and only if it doesn't already exist.
boolean	append(java.lang.String applicationDirectory) Append the commands to the uninstaller command file(s).
boolean	copyFileCommand(java.lang.String fromFilename, java.lang.String toFilename) Copy file, if the toFilename does not already exist.
boolean	deleteAttribute(java.lang.String keyName, java.lang.String attribute) Delete attribute from registry.
boolean	deleteDirIfEmpty(java.lang.String directoryName) Delete the directory if it's empty.
boolean	deleteDirTree(java.lang.String directoryName) Delete all the files in directory tree, including the directoryName
boolean	deleteFile(java.lang.String filename) Delete the file.
boolean	deleteKey(java.lang.String keyName, java.lang.String subKeyName) Delete subKeyName from registry.
boolean	deleteManifest(java.lang.String applicationDirectory) Delete all the files in the manifest.
boolean	deletePropertyStorage(java.lang.String productName) Delete the property storage for this product.
boolean	deleteSubkeyEntry(java.lang.String keyName, java.lang.String subKeyName) Delete subKeyName from registry.
boolean	deleteWindowsDesktopIcon(java.lang.String submenu, java.lang.String itemName, java.lang.String user) Delete icon from the desktop on Windows.
boolean	deleteWindowsMenuItem(java.lang.String submenu, java.lang.String itemName, java.lang.String user) Delete menu item from Start | Programs on Windows.
boolean	overwriteFileCommand(java.lang.String fromFilename, java.lang.String toFilename) Copy the fromFilename to the toFilename, even if the toFilename existed.
boolean	prepend(java.lang.String applicationDirectory) Add the commands to the beginning of the uninstaller command file(s).
boolean	removeLinuxService(java.lang.String executable) Remove a Linux service.
boolean	removeWindowsService(java.lang.String serviceName, java.lang.String executable) Remove a Windows service.
boolean	renameFile(java.lang.String fromFilename, java.lang.String toFilename) Rename file, if the toFilename does not already exist.
boolean	replaceDataEntry(java.lang.String keyName, java.lang.String subKeyName, java.lang.String subKeyData) Replaces the data for the subKeyName.
boolean	runThirdPartyApp(java.lang.String exec, java.lang.String[] args) Run a third party program.
boolean	save(java.lang.String applicationDirectory, java.lang.String productName) Save the commands for the uninstaller command file(s).
boolean	setCustomClasses(java.lang.String classes) Set the custom classes to run before uninstalling.
boolean	tempSave(java.lang.String applicationDirectory, java.lang.String filename) Save the commands for the uninstaller command file(s) to a temporary file.
boolean	trackUninstall(java.lang.String productName, java.lang.String website) Delete the property storage for this product.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUninstaller

public CustomUninstaller()

CustomUninstaller lets you customize the uninstaller for your app.

Method Detail

append

public boolean append(java.lang.String applicationDirectory)

Append the commands to the uninstaller command file(s). Clears all stored commands after appending the known commands.

Parameters:

applicationDirectory - directory where your app is installed.

Returns:

boolean true if successful appending commands to the uninstaller.

prepend

public boolean prepend(java.lang.String applicationDirectory)

Add the commands to the beginning of the uninstaller command file(s). Clears all stored commands after prepending the known commands.

Parameters:

applicationDirectory - directory where your app is installed.

Returns:

boolean true if successful prepending commands to the uninstaller.

save

public boolean save(java.lang.String applicationDirectory,
                    java.lang.String productName)

Save the commands for the uninstaller command file(s). Creates new uninstall command file(s) overwriting any existing file(s). Clears all stored commands after saving all known commands.

Parameters:

applicationDirectory - directory where your app is installed.

productName - name of product to be uninstalled.

Returns:

boolean true if successful saving commands to the uninstaller.

tempSave

public boolean tempSave(java.lang.String applicationDirectory,
                        java.lang.String filename)

Save the commands for the uninstaller command file(s) to a temporary file.

Parameters:

applicationDirectory - directory where your app is installed.

filename - filename for temp file.

Returns:

boolean true if successful saving commands to the temp file.

setCustomClasses

public boolean setCustomClasses(java.lang.String classes)

Set the custom classes to run before uninstalling. The customClasses replaces the existing list of classes. Pass an empty string to clear the custom classes.

Parameters:

classes - custom classnames, including package name, separated by a space.

Returns:

boolean true if successful.

deletePropertyStorage

public boolean deletePropertyStorage(java.lang.String productName)

Delete the property storage for this product.

Parameters:

productName - name of product.

Returns:

boolean true if successful.

deleteManifest

public boolean deleteManifest(java.lang.String applicationDirectory)

Delete all the files in the manifest.

Parameters:

applicationDirectory - directory where your app is installed.

Returns:

boolean true if successful.

deleteDirTree

public boolean deleteDirTree(java.lang.String directoryName)

Delete all the files in directory tree, including the directoryName

Parameters:

directoryName - name of the directory to start deleting files.

Returns:

boolean true if successful.

deleteDirIfEmpty

public boolean deleteDirIfEmpty(java.lang.String directoryName)

Delete the directory if it's empty.

Parameters:

directoryName - name of the directory, including full path, to delete.

Returns:

boolean true if successful.

deleteFile

public boolean deleteFile(java.lang.String filename)

Delete the file.

Parameters:

filename - name of file, including full path, to delete.

Returns:

boolean true if successful.

renameFile

public boolean renameFile(java.lang.String fromFilename,
                          java.lang.String toFilename)

Rename file, if the toFilename does not already exist.

Parameters:

fromFilename - the original name of the file, including full path.

toFilename - the new name of the file, including full path.

Returns:

boolean true if successful.

copyFileCommand

public boolean copyFileCommand(java.lang.String fromFilename,
                               java.lang.String toFilename)

Copy file, if the toFilename does not already exist. The fromFilename still exists after the copy.

Parameters:

fromFilename - the original name of the file, including full path.

toFilename - the new name of the file, including full path.

Returns:

boolean true if successful.

overwriteFileCommand

public boolean overwriteFileCommand(java.lang.String fromFilename,
                                    java.lang.String toFilename)

Copy the fromFilename to the toFilename, even if the toFilename existed. The fromFilename is effectively renamed to the toFilename regardless if the toFilename exists or not.

Parameters:

fromFilename - the original name of the file, including full path.

toFilename - the new name of the file, including full path.

Returns:

boolean true if successful.

removeWindowsService

public boolean removeWindowsService(java.lang.String serviceName,
                                    java.lang.String executable)

Remove a Windows service.

Parameters:

serviceName - is the name used internally by SCM

executable - is the pathname to the executable

Returns:

boolean true if successful.

removeLinuxService

public boolean removeLinuxService(java.lang.String executable)

Remove a Linux service.

Parameters:

executable - is the pathname to the executable

Returns:

boolean true if successful.

trackUninstall

public boolean trackUninstall(java.lang.String productName,
                              java.lang.String website)

Delete the property storage for this product.

Parameters:

productName - name of product.

Returns:

boolean true if successful.

addSubkeyEntry

public boolean addSubkeyEntry(java.lang.String keyName,
                              java.lang.String subKeyName,
                              java.lang.String subKeyData)

Adds the subKeyName and its data to the registry if and only if it doesn't already exist. The keyName must already exist.

Parameters:

keyName - the key (e.g., HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows).

subKeyName - the last element of the key.

subKeyData - the string data, if any, for the subKeyName.

Returns:

true if successful.

replaceDataEntry

public boolean replaceDataEntry(java.lang.String keyName,
                                java.lang.String subKeyName,
                                java.lang.String subKeyData)

Replaces the data for the subKeyName. If subKeyName does not exist, then it adds the subKeyName and its associated subKeyData. The keyName must already exist.

Parameters:

keyName - the key (e.g., HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows).

subKeyName - the last element of the key.

subKeyData - the string data, if any, for the subKeyName.

Returns:

true if successful.

deleteKey

public boolean deleteKey(java.lang.String keyName,
                         java.lang.String subKeyName)

Delete subKeyName from registry. The keyName must already exist.

Parameters:

keyName - the key (e.g., HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows).

subKeyName - the last element of the key.

Returns:

true if successful.

deleteSubkeyEntry

public boolean deleteSubkeyEntry(java.lang.String keyName,
                                 java.lang.String subKeyName)

Delete subKeyName from registry. The keyName must already exist.

Parameters:

keyName - the key (e.g., HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows).

subKeyName - the last element of the key.

Returns:

true if successful.

deleteAttribute

public boolean deleteAttribute(java.lang.String keyName,
                               java.lang.String attribute)

Delete attribute from registry. The keyName must already exist.

Parameters:

keyName - the key (e.g., HKEY_LOCAL_MACHINE\\SOFTWARE\\MySoftware).

attribute - the value name (e.g., Version).

Returns:

true if successful.

deleteWindowsMenuItem

public boolean deleteWindowsMenuItem(java.lang.String submenu,
                                     java.lang.String itemName,
                                     java.lang.String user)

Delete menu item from Start | Programs on Windows.

Parameters:

submenu - the submenu.

itemName - the menu item.

user - if currentUser, then delete menu from the HKEY_CURRENT_USER key; if allUsers, then try to delete from the HKEY_LOCAL_MACHINE key, but if that fails, then delete from the HKEY_CURRENT_USER key.

Returns:

true if successful.

deleteWindowsDesktopIcon

public boolean deleteWindowsDesktopIcon(java.lang.String submenu,
                                        java.lang.String itemName,
                                        java.lang.String user)

Delete icon from the desktop on Windows.

Parameters:

submenu - the submenu.

itemName - the menu item.

user - if currentUser, then delete menu from the HKEY_CURRENT_USER key; if allUsers, then try to delete from the HKEY_LOCAL_MACHINE key, but if that fails, then delete from the HKEY_CURRENT_USER key.

Returns:

true if successful.

runThirdPartyApp

public boolean runThirdPartyApp(java.lang.String exec,
                                java.lang.String[] args)

Run a third party program.

It's very important that you *not* pass the full command line, including arguments, as the first parameter. Also, the uninstaller can only run apps that have a fully qualified pathname for the exec and the args listed individually in a String[]. In other words, the first parameter must be the pathname for the program (e.g., C:\Program files\Java\bin\java.exe).

If the third party app is a part of the files that the installer installed, then be sure to call prepend() so your app is run before the standard part of the uninstaller runs.

If you want to run a batch file, then you should create a custom uninstaller class which uses Exec.execCommand() to start the batch file. Then add that custom class to the Custom | Uninstaller tab in the Advanced interface.

Parameters:

exec - program name.

args - arguments.

Returns:

true if successful.