org.zaproxy.zap.control

Class AddOnInstaller

java.lang.Object

org.zaproxy.zap.control.AddOnInstaller

public final class AddOnInstaller
extends Object

Helper class responsible to install and uninstall add-ons and all its (dynamically installable) components (Extensions, Plugins, PassiveScanners and files).

Since:

2.3.0

See Also:

Extension, Plugin, PassiveScanner

Method Summary

Modifier and Type	Method and Description
static void	install(AddOnClassLoader addOnClassLoader, AddOn addOn) Installs all the (dynamically installable) components (Extensions, Plugins, PassiveScanners and files) of the given addOn.
static void	installAddOnExtension(AddOn addOn, Extension ext)
static void	installMissingAddOnFiles(AddOnClassLoader addOnClassLoader, AddOn addOn) Installs all the missing files declared by the given addOn.
static boolean	softUninstall(AddOn addOn, AddOnUninstallationProgressCallback callback) Uninstalls Java classes (Extensions, Plugins, PassiveScanners) of the given addOn.
static boolean	uninstall(AddOn addOn, AddOnUninstallationProgressCallback callback) Deprecated. (2.8.0) Use uninstall(AddOn, AddOnUninstallationProgressCallback, Set) instead.
static boolean	uninstall(AddOn addOn, AddOnUninstallationProgressCallback callback, Set<AddOn> installedAddOns) Uninstalls all the (dynamically installable) components (Extensions, Plugins, PassiveScanners and files) of the given addOn.
protected static boolean	uninstallAddOnExtension(AddOn addOn, Extension extension, AddOnUninstallationProgressCallback callback) Uninstalls the given extension.
static boolean	uninstallAddOnFiles(AddOn addOn, AddOnUninstallationProgressCallback callback) Deprecated. (2.8.0) Use uninstallAddOnFiles(AddOn, AddOnUninstallationProgressCallback, Set) instead.
static boolean	uninstallAddOnFiles(AddOn addOn, AddOnUninstallationProgressCallback callback, Set<AddOn> installedAddOns) Uninstalls the files of the given add-on.
static void	updateAddOnFiles(AddOnClassLoader addOnClassLoader, AddOn addOn) Updates the files declared by the given addOn.

Methods inherited from class java.lang.Object

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

Method Detail

install

public static void install(AddOnClassLoader addOnClassLoader,
                           AddOn addOn)

Installs all the (dynamically installable) components (Extensions, Plugins, PassiveScanners and files) of the given addOn.

It's also responsible to notify the installed extensions when the installation has finished by calling the method Extension#postInstall().

The components are installed in the following order:

1. ResourceBundle;
2. Files;
3. Extensions;
4. Active scanners;
5. Passive scanners.

The files are installed first as they might be required by extensions and scanners.

Parameters:

addOnClassLoader - the class loader of the given addOn

addOn - the add-on that will be installed

See Also:

Extension, PassiveScanner, Plugin, Extension.postInstall()

uninstall

@Deprecated
public static boolean uninstall(AddOn addOn,
                                            AddOnUninstallationProgressCallback callback)

Deprecated. (2.8.0) Use uninstall(AddOn, AddOnUninstallationProgressCallback, Set) instead.

Uninstalls all the (dynamically installable) components (Extensions, Plugins, PassiveScanners and files) of the given addOn.

The components are uninstalled in the following order (inverse to installation):

1. Passive scanners;
2. Active scanners;
3. Extensions;
4. Files;
5. ResourceBundle;

Parameters:

addOn - the add-on that will be uninstalled

callback - the callback that will be notified of the progress of the uninstallation

Returns:

true if the add-on was uninstalled without errors, false otherwise.

Throws:

IllegalArgumentException - if addOn or callback are null.

See Also:

softUninstall(AddOn, AddOnUninstallationProgressCallback), Extension, PassiveScanner, Plugin

uninstall

public static boolean uninstall(AddOn addOn,
                                AddOnUninstallationProgressCallback callback,
                                Set<AddOn> installedAddOns)

Uninstalls all the (dynamically installable) components (Extensions, Plugins, PassiveScanners and files) of the given addOn.

The components are uninstalled in the following order (inverse to installation):

1. Passive scanners;
2. Active scanners;
3. Extensions;
4. Files (if not in use by other add-ons);
5. ResourceBundle;

Parameters:

addOn - the add-on that will be uninstalled.

callback - the callback that will be notified of the progress of the uninstallation.

installedAddOns - the add-ons currently installed.

Returns:

true if the add-on was uninstalled without errors, false otherwise.

Throws:

IllegalArgumentException - if addOn or callback are null.

Since:

2.8.0

See Also:

softUninstall(AddOn, AddOnUninstallationProgressCallback), Extension, PassiveScanner, Plugin

softUninstall

public static boolean softUninstall(AddOn addOn,
                                    AddOnUninstallationProgressCallback callback)

Uninstalls Java classes (Extensions, Plugins, PassiveScanners) of the given addOn. Should be called when the add-on must be temporarily uninstalled for an update of a dependency.

The Java classes are uninstalled in the following order (inverse to installation):

1. Passive scanners;
2. Active scanners;
3. Extensions.

Parameters:

addOn - the add-on that will be softly uninstalled

callback - the callback that will be notified of the progress of the uninstallation

Returns:

true if the add-on was uninstalled without errors, false otherwise.

Since:

2.4.0

See Also:

Extension, PassiveScanner, Plugin

installAddOnExtension

public static void installAddOnExtension(AddOn addOn,
                                         Extension ext)

uninstallAddOnExtension

protected static boolean uninstallAddOnExtension(AddOn addOn,
                                                 Extension extension,
                                                 AddOnUninstallationProgressCallback callback)

Uninstalls the given extension.

Parameters:

addOn - the add-on that has the extension

extension - the extension that should be uninstalled

callback - the callback that will be notified of the progress of the uninstallation

Returns:

true if the extension was uninstalled without errors, false otherwise.

Since:

2.4.0

See Also:

Extension

installMissingAddOnFiles

public static void installMissingAddOnFiles(AddOnClassLoader addOnClassLoader,
                                            AddOn addOn)

Installs all the missing files declared by the given addOn.

Parameters:

addOnClassLoader - the class loader of the given addOn

addOn - the add-on that will have the missing declared files installed

updateAddOnFiles

public static void updateAddOnFiles(AddOnClassLoader addOnClassLoader,
                                    AddOn addOn)

Updates the files declared by the given addOn.

Parameters:

addOnClassLoader - the class loader of the given addOn.

addOn - the add-on that will have the declared files updated.

Since:

2.7.0

uninstallAddOnFiles

@Deprecated
public static boolean uninstallAddOnFiles(AddOn addOn,
                                                      AddOnUninstallationProgressCallback callback)

Deprecated. (2.8.0) Use uninstallAddOnFiles(AddOn, AddOnUninstallationProgressCallback, Set) instead.

Uninstalls the files of the given add-on.

Parameters:

addOn - the add-on

callback - the callback for notification of progress

Returns:

true if no error occurred while removing the files, false otherwise.

Throws:

IllegalArgumentException - if addOn or callback are null.

uninstallAddOnFiles

public static boolean uninstallAddOnFiles(AddOn addOn,
                                          AddOnUninstallationProgressCallback callback,
                                          Set<AddOn> installedAddOns)

Uninstalls the files of the given add-on.

Note: Files that are in use by other installed add-ons are not uninstalled.

Parameters:

addOn - the add-on whose files should be uninstalled.

callback - the callback for notification of progress.

installedAddOns - the add-ons currently installed (to check if the files can be safely uninstalled).

Returns:

true if no error occurred while removing the files, false otherwise.

Throws:

IllegalArgumentException - if addOn or callback are null.

Since:

2.8.0