AddOn (OWASP Zed Attack Proxy)

java.lang.Object
- org.zaproxy.zap.control.AddOn

```
public class AddOn
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AddOn.AddOnRunRequirements` The requirements to run an `AddOn`.
`static class`	`AddOn.BaseRunRequirements`
`static class`	`AddOn.BundleData` The data of the bundle declared in the manifest of an add-on.
`static class`	`AddOn.ExtensionRunRequirements` The requirements to run an `extension` (with add-on dependencies).
`static class`	`AddOn.HelpSetData` The data to load a `HelpSet`, declared in the manifest of an add-on.
`static class`	`AddOn.InstallationStatus` The installation status of the add-on.
`static class`	`AddOn.InvalidAddOnException` An `IOException` that indicates that a file is not a valid add-on.
`static class`	`AddOn.Status`
`static class`	`AddOn.ValidationResult` The result of checking if a file is a valid add-on.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILE_EXTENSION` The file extension of ZAP add-ons.
`static String`	`MANIFEST_FILE_NAME` The name of the manifest file, contained in the add-ons.

Constructor Summary

Constructors
Constructor and Description
`AddOn(File file)` Deprecated. (2.6.0) Use `AddOn(Path)` instead.
`AddOn(Path file)` Constructs an `AddOn` from the given `file`.
`AddOn(String fileName)` Deprecated. (2.6.0) Use `AddOn(Path)` instead.
`AddOn(String id, File baseDir, org.apache.commons.configuration.SubnodeConfiguration xmlData)` Constructs an `AddOn` from an add-on entry of `ZapVersions.xml` file.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLoadedExtension(Extension extension)` Adds the given `extension` to the list of loaded extensions of this add-on.
`AddOn.AddOnRunRequirements`	`calculateExtensionInstallRequirements(Extension extension, Collection<AddOn> availableAddOns)` Calculates the requirements to install/run the given `extension`, same as `calculateExtensionRunRequirements(Extension, Collection)` but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
`AddOn.AddOnRunRequirements`	`calculateExtensionInstallRequirements(String classname, Collection<AddOn> availableAddOns)` Calculates the requirements to install/run the given `extension`, same as `calculateExtensionRunRequirements(String, Collection)` but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
`AddOn.AddOnRunRequirements`	`calculateExtensionRunRequirements(Extension extension, Collection<AddOn> availableAddOns)` Calculates the requirements to run the given `extension`, in the current ZAP and Java versions and with the given `availableAddOns`.
`AddOn.AddOnRunRequirements`	`calculateExtensionRunRequirements(String classname, Collection<AddOn> availableAddOns)` Calculates the requirements to run the extension with the given `classname`, in the current ZAP and Java versions and with the given `availableAddOns`.
`AddOn.AddOnRunRequirements`	`calculateInstallRequirements(Collection<AddOn> availableAddOns)` Calculates the requirements to install/run this add-on, same as `calculateRunRequirements(Collection)` but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
`AddOn.AddOnRunRequirements`	`calculateRunRequirements(Collection<AddOn> availableAddOns)` Calculates the requirements to run this add-on, in the current ZAP and Java versions and with the given `availableAddOns`.
`boolean`	`canLoad()` Deprecated. (2.4.0) Use `calculateRunRequirements(Collection)` instead. Returns `false`.
`boolean`	`canLoadInCurrentVersion()` Tells whether or not this add-on can be loaded in the currently running ZAP version, as given by `Constant.PROGRAM_VERSION`.
`boolean`	`canLoadInVersion(String zapVersion)` Tells whether or not this add-on can be loaded in the given `zapVersion`.
`boolean`	`canRunInCurrentJavaVersion()` Tells whether or not this add-on can be run in the currently running Java version.
`boolean`	`canRunInJavaVersion(String javaVersion)` Tells whether or not this add-on can be run in the given `javaVersion`.
`static Optional<AddOn>`	`createAddOn(Path file)` Convenience method that attempts to create an `AddOn` from the given file.
`boolean`	`dependsOn(AddOn addOn)` Tells whether or not this add-on has a (direct) dependency on the given `addOn` (including version).
`boolean`	`dependsOn(Collection<AddOn> addOns)` Tells whether or not this add-on has a (direct) dependency on any of the given `addOns` (including version).
`boolean`	`dependsOn(Extension extension, AddOn addOn)` Tells whether or not the given `extension` has a (direct) dependency on the given `addOn` (including version).
`boolean`	`equals(Object obj)` Two add-ons are considered equal if both add-ons have the same ID and version.
`org.zaproxy.zap.control.AddOnClassnames`	`getAddOnClassnames()` Gets the classnames that can be loaded for the add-on.
`List<String>`	`getAscanrules()`
`String`	`getAuthor()`
`AddOn.BundleData`	`getBundleData()` Gets the data of the bundle declared in the manifest.
`String`	`getChanges()`
`ClassLoader`	`getClassLoader()` Gets the class loader of the add-on.
`String`	`getDescription()`
`org.zaproxy.zap.control.AddOnClassnames`	`getExtensionAddOnClassnames(String classname)` Returns the classnames that can be loaded for the given `Extension` (with dependencies).
`List<String>`	`getExtensions()`
`List<String>`	`getExtensionsWithDeps()` Returns the classnames of `Extension`sthat have dependencies on add-ons.
`File`	`getFile()` Gets the file of the add-on.
`List<String>`	`getFiles()`
`int`	`getFileVersion()` Deprecated. (2.7.0) Use `getVersion()` instead.
`String`	`getHash()`
`AddOn.HelpSetData`	`getHelpSetData()` Gets the data for the HelpSet, declared in the manifest.
`String`	`getId()`
`List<String>`	`getIdsAddOnDependencies()` Returns the IDs of the add-ons dependencies, an empty collection if none.
`URL`	`getInfo()`
`AddOn.InstallationStatus`	`getInstallationStatus()` Gets installations status of the add-on.
`List<AbstractPlugin>`	`getLoadedAscanrules()` Gets the active scan rules of this add-on that were loaded.
`List<Extension>`	`getLoadedExtensions()` Gets the extensions of this add-on that were loaded.
`List<Extension>`	`getLoadedExtensionsWithDeps()` Gets the extensions of this add-on that have dependencies and were loaded.
`List<PluginPassiveScanner>`	`getLoadedPscanrules()` Gets the passive scan rules of this add-on that were loaded.
`String`	`getMinimumJavaVersion()` Returns the minimum Java version required to run this add-on or an empty `String` if there's no minimum version.
`String`	`getName()`
`String`	`getNormalisedFileName()` Gets the normalised file name of the add-on.
`String`	`getNotBeforeVersion()`
`String`	`getNotFromVersion()`
`List<String>`	`getPscanrules()`
`String`	`getReleaseDate()` Gets the date when the add-on was released.
`URL`	`getRepo()` Gets the URL to the browsable repo.
`ResourceBundle`	`getResourceBundle()` Gets the resource bundle of the add-on.
`long`	`getSize()`
`AddOn.Status`	`getStatus()`
`URL`	`getUrl()`
`Version`	`getVersion()` Gets the semantic version of this add-on.
`boolean`	`hasExtensionsWithDeps()` Tells whether or not this add-on has at least one extension with dependencies.
`int`	`hashCode()`
`boolean`	`hasZapAddOnEntry()`
`static boolean`	`isAddOn(File f)` Deprecated. (2.6.0) Use `isAddOn(Path)` instead.
`static boolean`	`isAddOn(Path file)` Tells whether or not the given file is a ZAP add-on.
`static boolean`	`isAddOn(String fileName)` Deprecated. (2.6.0) Use `isAddOnFileName(String)` instead, the checks done in this method are more strict than it needs to.
`static boolean`	`isAddOnFileName(String fileName)` Tells whether or not the given file name matches the name of a ZAP add-on.
`boolean`	`isExtensionLoaded(String classname)` Tells whether or not the extension with the given `classname` is loaded.
`boolean`	`isSameAddOn(AddOn addOn)`
`boolean`	`isUpdateTo(AddOn addOn)`
`static AddOn.ValidationResult`	`isValidAddOn(Path file)` Tells whether or not the given file is a ZAP add-on.
`void`	`removeLoadedExtension(Extension extension)` Removes the given `extension` from the list of loaded extensions of this add-on.
`void`	`setAuthor(String author)`
`void`	`setChanges(String changes)`
`void`	`setClassLoader(ClassLoader classLoader)` Sets the class loader of the add-on.
`void`	`setDescription(String description)`
`void`	`setFile(File file)`
`void`	`setId(String id)`
`void`	`setInfo(URL info)`
`void`	`setInstallationStatus(AddOn.InstallationStatus installationStatus)` Sets the installation status of the add-on.
`void`	`setName(String name)`
`void`	`setNotBeforeVersion(String notBeforeVersion)`
`void`	`setNotFromVersion(String notFromVersion)`
`void`	`setResourceBundle(ResourceBundle resourceBundle)` Sets the resource bundle of the add-on.
`void`	`setSize(long size)`
`void`	`setStatus(AddOn.Status status)`
`void`	`setUrl(URL url)`
`String`	`toString()`

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

- Field Detail
  - MANIFEST_FILE_NAME
```
public static final String MANIFEST_FILE_NAME
```
    The name of the manifest file, contained in the add-ons.
    The manifest is expected to be in the root of the ZIP file.
    
    Since:
    
    2.6.0
    
    See Also:
    
    Constant Field Values
  - FILE_EXTENSION
```
public static final String FILE_EXTENSION
```
    The file extension of ZAP add-ons.
    
    Since:
    
    2.6.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AddOn
```
@Deprecated
public AddOn(String fileName)
                  throws Exception
```
    Deprecated. (2.6.0) Use AddOn(Path) instead.
    
    Constructs an AddOn with the given file name.
    
    Parameters:
    
    fileName - the file name of the add-on
    
    Throws:
    
    Exception - if the file name is not valid.
  - AddOn
```
@Deprecated
public AddOn(File file)
                  throws Exception
```
    Deprecated. (2.6.0) Use AddOn(Path) instead.
    
    Constructs an AddOn from the given file.
    The "ZapAddOn.xml" ZIP file entry is read after validating that the add-on has a valid add-on file name.
    The installation status of the add-on is 'not installed'.
    
    Parameters:
    
    file - the file of the add-on
    
    Throws:
    
    Exception - if the given file does not exist, does not have a valid add-on file name or an error occurred while reading the value #ZAP_ADD_ON_XML ZIP file entry
  - AddOn
```
public AddOn(Path file)
      throws IOException
```
    Constructs an AddOn from the given file.
    The "ZapAddOn.xml" ZIP file entry is read after validating that the add-on is a valid add-on.
    The installation status of the add-on is 'not installed'.
    
    Parameters:
    
    file - the file of the add-on
    
    Throws:
    
    AddOn.InvalidAddOnException - (since 2.8.0) if the given file does not exist, does not have a valid add-on file name, or an error occurred while reading the add-on manifest ("ZapAddOn.xml").
    
    IOException - if an error occurred while reading/validating the file.
    
    See Also:
    
    isAddOn(Path)
  - AddOn
```
public AddOn(String id,
             File baseDir,
             org.apache.commons.configuration.SubnodeConfiguration xmlData)
      throws MalformedURLException,
             IOException
```
    Constructs an AddOn from an add-on entry of ZapVersions.xml file. The installation status of the add-on is 'not installed'.
    The given SubnodeConfiguration must have a XPathExpressionEngine installed.
    The "ZapAddOn.xml" ZIP file entry is read, if the add-on file exists locally.
    
    Parameters:
    
    id - the id of the add-on
    
    baseDir - the base directory where the add-on is located
    
    xmlData - the source of add-on entry of ZapVersions.xml file
    
    Throws:
    
    MalformedURLException - if the URL of the add-on is malformed
    
    IOException - if an error occurs while reading the XML data
    
    See Also:
    
    XPathExpressionEngine
- Method Detail
  - isAddOn
```
@Deprecated
public static boolean isAddOn(String fileName)
```
    Deprecated. (2.6.0) Use isAddOnFileName(String) instead, the checks done in this method are more strict than it needs to.
    
    Tells whether or not the given file name matches the name of a ZAP add-on.
    The file name must have the format "<id>-<status>-<version>.zap". The id is a string, the status must be a value from AddOn.Status and the version must be an integer.
    
    Parameters:
    
    fileName - the name of the file to check
    
    Returns:
    
    true if the given file name is the name of an add-on, false otherwise.
    
    See Also:
    
    isAddOnFileName(String)
  - isAddOnFileName
```
public static boolean isAddOnFileName(String fileName)
```
    Tells whether or not the given file name matches the name of a ZAP add-on.
    The file name must have as file extension FILE_EXTENSION.
    
    Parameters:
    
    fileName - the name of the file to check
    
    Returns:
    
    true if the given file name is the name of an add-on, false otherwise.
    
    Since:
    
    2.6.0
  - isAddOn
```
@Deprecated
public static boolean isAddOn(File f)
```
    Deprecated. (2.6.0) Use isAddOn(Path) instead.
    
    Tells whether or not the given file is an add-on.
    
    Parameters:
    
    f - the file to be checked
    
    Returns:
    
    true if the given file is an add-on, false otherwise.
  - isAddOn
```
public static boolean isAddOn(Path file)
```
    Tells whether or not the given file is a ZAP add-on.
    An add-on is a ZIP file that contains, at least, a "ZapAddOn.xml" file.
    
    Parameters:
    
    file - the file to be checked
    
    Returns:
    
    true if the given file is an add-on, false otherwise.
    
    Since:
    
    2.6.0
    
    See Also:
    
    isAddOnFileName(String), isValidAddOn(Path)
  - isValidAddOn
```
public static AddOn.ValidationResult isValidAddOn(Path file)
```
    Tells whether or not the given file is a ZAP add-on.
    
    Parameters:
    
    file - the file to be checked.
    
    Returns:
    
    the result of the validation.
    
    Since:
    
    2.8.0
    
    See Also:
    
    isAddOn(Path)
  - createAddOn
```
public static Optional<AddOn> createAddOn(Path file)
```
    Convenience method that attempts to create an AddOn from the given file.
    A warning is logged if the add-on is invalid and an error if an error occurred while creating it.
    
    Parameters:
    
    file - the file of the add-on.
    
    Returns:
    
    a container with the AddOn, or empty if not valid or an error occurred while creating it.
    
    Since:
    
    2.8.0
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - getFileVersion
```
@Deprecated
public int getFileVersion()
```
    Deprecated. (2.7.0) Use getVersion() instead.
    
    Gets the file version of the add-on.
    
    Returns:
    
    the file version.
  - getVersion
```
public Version getVersion()
```
    Gets the semantic version of this add-on.
    Since 2.7.0, for add-ons that use just an integer as the version it's appended ".0.0", for example, for version 14 it returns the version 14.0.0.
    
    Returns:
    
    the semantic version of the add-on, since 2.7.0, never null.
    
    Since:
    
    2.4.0
  - getStatus
```
public AddOn.Status getStatus()
```
  - setStatus
```
public void setStatus(AddOn.Status status)
```
  - getChanges
```
public String getChanges()
```
  - setChanges
```
public void setChanges(String changes)
```
  - getNormalisedFileName
```
public String getNormalisedFileName()
```
    Gets the normalised file name of the add-on.
    Should be used when copying the file from an "unknown" source (e.g. manually installed).
    
    Returns:
    
    the normalised file name.
    
    Since:
    
    2.6.0
    
    See Also:
    
    getFile()
  - getFile
```
public File getFile()
```
    Gets the file of the add-on.
    
    Returns:
    
    the file of the add-on.
    
    See Also:
    
    getNormalisedFileName()
  - setFile
```
public void setFile(File file)
```
  - getUrl
```
public URL getUrl()
```
  - setUrl
```
public void setUrl(URL url)
```
  - getSize
```
public long getSize()
```
  - setSize
```
public void setSize(long size)
```
  - getAuthor
```
public String getAuthor()
```
  - setAuthor
```
public void setAuthor(String author)
```
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Gets the class loader of the add-on.
    
    Returns:
    
    the class loader of the add-on, null if the add-on is not installed.
    
    Since:
    
    2.8.0
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Sets the class loader of the add-on.
    Note: This method should be called only by bootstrap classes.
    
    Parameters:
    
    classLoader - the class loader of the add-on, might be null.
    
    Since:
    
    2.8.0
  - setInstallationStatus
```
public void setInstallationStatus(AddOn.InstallationStatus installationStatus)
```
    Sets the installation status of the add-on.
    
    Parameters:
    
    installationStatus - the new installation status
    
    Throws:
    
    IllegalArgumentException - if the given installationStatus is null.
    
    Since:
    
    2.4.0
  - getInstallationStatus
```
public AddOn.InstallationStatus getInstallationStatus()
```
    Gets installations status of the add-on.
    
    Returns:
    
    the installation status, never null
    
    Since:
    
    2.4.0
  - hasZapAddOnEntry
```
public boolean hasZapAddOnEntry()
```
  - getAddOnClassnames
```
public org.zaproxy.zap.control.AddOnClassnames getAddOnClassnames()
```
    Gets the classnames that can be loaded for the add-on.
    
    Returns:
    
    the classnames that can be loaded
    
    Since:
    
    2.4.3
  - getExtensions
```
public List<String> getExtensions()
```
  - getExtensionsWithDeps
```
public List<String> getExtensionsWithDeps()
```
    Returns the classnames of Extensionsthat have dependencies on add-ons.
    
    Returns:
    
    the classnames of the extensions with dependencies on add-ons.
    
    See Also:
    
    hasExtensionsWithDeps()
  - getExtensionAddOnClassnames
```
public org.zaproxy.zap.control.AddOnClassnames getExtensionAddOnClassnames(String classname)
```
    Returns the classnames that can be loaded for the given Extension (with dependencies).
    
    Parameters:
    
    classname - the classname of the extension
    
    Returns:
    
    the classnames that can be loaded
    
    Since:
    
    2.4.3
    
    See Also:
    
    hasExtensionsWithDeps()
  - hasExtensionsWithDeps
```
public boolean hasExtensionsWithDeps()
```
    Tells whether or not this add-on has at least one extension with dependencies.
    
    Returns:
    
    true if the add-on has at leas one extension with dependencies, false otherwise
    
    See Also:
    
    getExtensionsWithDeps()
  - getLoadedExtensionsWithDeps
```
public List<Extension> getLoadedExtensionsWithDeps()
```
    Gets the extensions of this add-on that have dependencies and were loaded.
    
    Returns:
    
    an unmodifiable List with the extensions of this add-on that have dependencies and were loaded
    
    Since:
    
    2.4.0
  - getLoadedExtensions
```
public List<Extension> getLoadedExtensions()
```
    Gets the extensions of this add-on that were loaded.
    
    Returns:
    
    an unmodifiable List with the extensions of this add-on that were loaded
    
    Since:
    
    2.4.0
  - addLoadedExtension
```
public void addLoadedExtension(Extension extension)
```
    Adds the given extension to the list of loaded extensions of this add-on.
    This add-on is set to the given extension.
    
    Parameters:
    
    extension - the extension of this add-on that was loaded
    
    Throws:
    
    IllegalArgumentException - if extension is null
    
    Since:
    
    2.4.0
    
    See Also:
    
    removeLoadedExtension(Extension), Extension.setAddOn(AddOn)
  - removeLoadedExtension
```
public void removeLoadedExtension(Extension extension)
```
    Removes the given extension from the list of loaded extensions of this add-on.
    The add-on of the given extension is set to null.
    The call to this method has no effect if the given extension does not belong to this add-on.
    
    Parameters:
    
    extension - the loaded extension of this add-on that should be removed
    
    Throws:
    
    IllegalArgumentException - if extension is null
    
    Since:
    
    2.4.0
    
    See Also:
    
    addLoadedExtension(Extension), Extension.setAddOn(AddOn)
  - getAscanrules
```
public List<String> getAscanrules()
```
  - getLoadedAscanrules
```
public List<AbstractPlugin> getLoadedAscanrules()
```
    Gets the active scan rules of this add-on that were loaded.
    
    Returns:
    
    an unmodifiable List with the active scan rules of this add-on that were loaded, never null
    
    Since:
    
    2.4.3
    
    See Also:
    
    setLoadedAscanrules(List)
  - getPscanrules
```
public List<String> getPscanrules()
```
  - getLoadedPscanrules
```
public List<PluginPassiveScanner> getLoadedPscanrules()
```
    Gets the passive scan rules of this add-on that were loaded.
    
    Returns:
    
    an unmodifiable List with the passive scan rules of this add-on that were loaded, never null
    
    Since:
    
    2.4.3
    
    See Also:
    
    setLoadedPscanrules(List)
  - getFiles
```
public List<String> getFiles()
```
  - isSameAddOn
```
public boolean isSameAddOn(AddOn addOn)
```
  - isUpdateTo
```
public boolean isUpdateTo(AddOn addOn)
                   throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - canLoad
```
@Deprecated
public boolean canLoad()
```
    Deprecated. (2.4.0) Use calculateRunRequirements(Collection) instead. Returns false.
    
    Returns:
    
    false always.
  - canLoadInCurrentVersion
```
public boolean canLoadInCurrentVersion()
```
    Tells whether or not this add-on can be loaded in the currently running ZAP version, as given by Constant.PROGRAM_VERSION.
    
    Returns:
    
    true if the add-on can be loaded in the currently running ZAP version, false otherwise
    
    See Also:
    
    canLoadInVersion(String), Constant.PROGRAM_VERSION
  - canRunInCurrentJavaVersion
```
public boolean canRunInCurrentJavaVersion()
```
    Tells whether or not this add-on can be run in the currently running Java version.
    This is a convenience method that calls canRunInJavaVersion(String) with the running Java version (as given by SystemUtils.JAVA_VERSION) as parameter.
    
    Returns:
    
    true if the add-on can be run in the currently running Java version, false otherwise
    
    Since:
    
    2.4.0
    
    See Also:
    
    canRunInJavaVersion(String), SystemUtils.JAVA_VERSION
  - canRunInJavaVersion
```
public boolean canRunInJavaVersion(String javaVersion)
```
    Tells whether or not this add-on can be run in the given javaVersion.
    If the given javaVersion is null and this add-on depends on a specific java version the method returns false.
    
    Parameters:
    
    javaVersion - the java version that will be checked
    
    Returns:
    
    true if the add-on can be loaded in the given javaVersion, false otherwise
    
    Since:
    
    2.4.0
  - calculateRunRequirements
```
public AddOn.AddOnRunRequirements calculateRunRequirements(Collection<AddOn> availableAddOns)
```
    Calculates the requirements to run this add-on, in the current ZAP and Java versions and with the given availableAddOns.
    If the add-on depends on other add-ons, those add-ons are also checked if are also runnable.
    Note: All the given availableAddOns are expected to be loadable in the currently running ZAP version, that is, the method AddOn.canLoadInCurrentVersion(), returns true.
    
    Parameters:
    
    availableAddOns - the other add-ons available
    
    Returns:
    
    a requirements to run the add-on, and if not runnable the reason why it's not.
    
    Since:
    
    2.4.0
    
    See Also:
    
    canLoadInCurrentVersion(), canRunInCurrentJavaVersion(), AddOn.AddOnRunRequirements
  - calculateInstallRequirements
```
public AddOn.AddOnRunRequirements calculateInstallRequirements(Collection<AddOn> availableAddOns)
```
    Calculates the requirements to install/run this add-on, same as calculateRunRequirements(Collection) but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
    
    Parameters:
    
    availableAddOns - the other add-ons available.
    
    Returns:
    
    the requirements to install/run the add-on, and if not runnable the reason why it's not.
    
    Since:
    
    2.9.0
    
    See Also:
    
    calculateRunRequirements(Collection), AddOn.AddOnRunRequirements
  - calculateExtensionRunRequirements
```
public AddOn.AddOnRunRequirements calculateExtensionRunRequirements(Extension extension,
                                                                    Collection<AddOn> availableAddOns)
```
    Calculates the requirements to run the given extension, in the current ZAP and Java versions and with the given availableAddOns.
    If the extension depends on other add-ons, those add-ons are checked if are also runnable.
    Note: All the given availableAddOns are expected to be loadable in the currently running ZAP version, that is, the method AddOn.canLoadInCurrentVersion(), returns true.
    
    Parameters:
    
    extension - the extension that will be checked
    
    availableAddOns - the add-ons available
    
    Returns:
    
    the requirements to run the extension, and if not runnable the reason why it's not.
    
    Since:
    
    2.4.0
    
    See Also:
    
    AddOn.AddOnRunRequirements.getExtensionRequirements()
  - calculateExtensionInstallRequirements
```
public AddOn.AddOnRunRequirements calculateExtensionInstallRequirements(Extension extension,
                                                                        Collection<AddOn> availableAddOns)
```
    Calculates the requirements to install/run the given extension, same as calculateExtensionRunRequirements(Extension, Collection) but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
    
    Parameters:
    
    extension - the extension that will be checked.
    
    availableAddOns - the add-ons available.
    
    Returns:
    
    the requirements to install/run the extension, and if not runnable the reason why it's not.
    
    Since:
    
    2.9.0
    
    See Also:
    
    AddOn.AddOnRunRequirements.getExtensionRequirements()
  - calculateExtensionRunRequirements
```
public AddOn.AddOnRunRequirements calculateExtensionRunRequirements(String classname,
                                                                    Collection<AddOn> availableAddOns)
```
    Calculates the requirements to run the extension with the given classname, in the current ZAP and Java versions and with the given availableAddOns.
    If the extension depends on other add-ons, those add-ons are checked if are also runnable.
    Note: All the given availableAddOns are expected to be loadable in the currently running ZAP version, that is, the method AddOn.canLoadInCurrentVersion(), returns true.
    
    Parameters:
    
    classname - the classname of extension that will be checked
    
    availableAddOns - the add-ons available
    
    Returns:
    
    the requirements to run the extension, and if not runnable the reason why it's not.
    
    Since:
    
    2.4.0
    
    See Also:
    
    AddOn.AddOnRunRequirements.getExtensionRequirements()
  - calculateExtensionInstallRequirements
```
public AddOn.AddOnRunRequirements calculateExtensionInstallRequirements(String classname,
                                                                        Collection<AddOn> availableAddOns)
```
    Calculates the requirements to install/run the given extension, same as calculateExtensionRunRequirements(String, Collection) but does not require the libraries of the add-ons (this or dependencies) to exist in the file system.
    
    Parameters:
    
    classname - the classname of extension that will be checked.
    
    availableAddOns - the add-ons available.
    
    Returns:
    
    the requirements to install/run the extension, and if not runnable the reason why it's not.
    
    Since:
    
    2.9.0
    
    See Also:
    
    AddOn.AddOnRunRequirements.getExtensionRequirements()
  - dependsOn
```
public boolean dependsOn(Extension extension,
                         AddOn addOn)
```
    Tells whether or not the given extension has a (direct) dependency on the given addOn (including version).
    
    Parameters:
    
    extension - the extension that will be checked
    
    addOn - the add-on that will be checked in the dependencies on the extension
    
    Returns:
    
    true if the extension depends on the given add-on, false otherwise.
    
    Since:
    
    2.4.0
  - isExtensionLoaded
```
public boolean isExtensionLoaded(String classname)
```
    Tells whether or not the extension with the given classname is loaded.
    
    Parameters:
    
    classname - the classname of the extension
    
    Returns:
    
    true if the extension is loaded, false otherwise
    
    Since:
    
    2.4.0
  - getMinimumJavaVersion
```
public String getMinimumJavaVersion()
```
    Returns the minimum Java version required to run this add-on or an empty String if there's no minimum version.
    
    Returns:
    
    the minimum Java version required to run this add-on or an empty String if no minimum version
    
    Since:
    
    2.4.0
  - canLoadInVersion
```
public boolean canLoadInVersion(String zapVersion)
```
    Tells whether or not this add-on can be loaded in the given zapVersion.
    
    Parameters:
    
    zapVersion - the ZAP version that will be checked
    
    Returns:
    
    true if the add-on can be loaded in the given zapVersion, false otherwise
  - setNotBeforeVersion
```
public void setNotBeforeVersion(String notBeforeVersion)
```
  - setNotFromVersion
```
public void setNotFromVersion(String notFromVersion)
```
  - getNotBeforeVersion
```
public String getNotBeforeVersion()
```
  - getNotFromVersion
```
public String getNotFromVersion()
```
  - getInfo
```
public URL getInfo()
```
  - setInfo
```
public void setInfo(URL info)
```
  - getRepo
```
public URL getRepo()
```
    Gets the URL to the browsable repo.
    
    Returns:
    
    the URL to the repo, might be null.
    
    Since:
    
    2.9.0
  - getHash
```
public String getHash()
```
  - getReleaseDate
```
public String getReleaseDate()
```
    Gets the date when the add-on was released.
    The date has the format YYYY-MM-DD.
    Note: The date is only available for add-ons created from the marketplace.
    
    Returns:
    
    the release date, or null if not available.
    
    Since:
    
    2.10.0
  - getBundleData
```
public AddOn.BundleData getBundleData()
```
    Gets the data of the bundle declared in the manifest.
    
    Returns:
    
    the bundle data, never null.
    
    Since:
    
    2.8.0
    
    See Also:
    
    getResourceBundle()
  - getResourceBundle
```
public ResourceBundle getResourceBundle()
```
    Gets the resource bundle of the add-on.
    
    Returns:
    
    the resource bundle, or null if none.
    
    Since:
    
    2.8.0
  - setResourceBundle
```
public void setResourceBundle(ResourceBundle resourceBundle)
```
    Sets the resource bundle of the add-on.
    Note: This method should be called only by bootstrap classes.
    
    Parameters:
    
    resourceBundle - the resource bundle of the add-on, might be null.
    
    Since:
    
    2.8.0
    
    See Also:
    
    getBundleData()
  - getHelpSetData
```
public AddOn.HelpSetData getHelpSetData()
```
    Gets the data for the HelpSet, declared in the manifest.
    
    Returns:
    
    the HelpSet data, never null.
    
    Since:
    
    2.8.0
  - getIdsAddOnDependencies
```
public List<String> getIdsAddOnDependencies()
```
    Returns the IDs of the add-ons dependencies, an empty collection if none.
    
    Returns:
    
    the IDs of the dependencies.
    
    Since:
    
    2.4.0
  - dependsOn
```
public boolean dependsOn(AddOn addOn)
```
    Tells whether or not this add-on has a (direct) dependency on the given addOn (including version).
    
    Parameters:
    
    addOn - the add-on that will be checked
    
    Returns:
    
    true if it depends on the given add-on, false otherwise.
    
    Since:
    
    2.4.0
  - dependsOn
```
public boolean dependsOn(Collection<AddOn> addOns)
```
    Tells whether or not this add-on has a (direct) dependency on any of the given addOns (including version).
    
    Parameters:
    
    addOns - the add-ons that will be checked
    
    Returns:
    
    true if it depends on any of the given add-ons, false otherwise.
    
    Since:
    
    2.4.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Two add-ons are considered equal if both add-ons have the same ID and version.
    
    Overrides:
    
    equals in class Object

Class AddOn

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MANIFEST_FILE_NAME

FILE_EXTENSION

Constructor Detail

AddOn

AddOn

AddOn

AddOn

Method Detail

isAddOn

isAddOnFileName

isAddOn

isAddOn

isValidAddOn

createAddOn

getId

setId

getName

setName

getDescription

setDescription

getFileVersion

getVersion

getStatus

setStatus

getChanges

setChanges

getNormalisedFileName

getFile

setFile

getUrl

setUrl

getSize

setSize

getAuthor

setAuthor

getClassLoader

setClassLoader

setInstallationStatus

getInstallationStatus

hasZapAddOnEntry

getAddOnClassnames

getExtensions

getExtensionsWithDeps

getExtensionAddOnClassnames

hasExtensionsWithDeps

getLoadedExtensionsWithDeps

getLoadedExtensions

addLoadedExtension

removeLoadedExtension

getAscanrules

getLoadedAscanrules

getPscanrules

getLoadedPscanrules

getFiles

isSameAddOn

isUpdateTo

canLoad

canLoadInCurrentVersion

canRunInCurrentJavaVersion

canRunInJavaVersion

calculateRunRequirements

calculateInstallRequirements

calculateExtensionRunRequirements

calculateExtensionInstallRequirements

calculateExtensionRunRequirements

calculateExtensionInstallRequirements

dependsOn

isExtensionLoaded

getMinimumJavaVersion

canLoadInVersion

setNotBeforeVersion

setNotFromVersion

getNotBeforeVersion