org.zaproxy.zap.extension.AddOnInstallationStatusListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of zap Show documentation

The Zed Attack Proxy (ZAP) is an easy to use integrated penetration testing tool for finding vulnerabilities in web applications. It is designed to be used by people with a wide range of security experience and as such is ideal for developers and functional testers who are new to penetration testing. ZAP provides automated scanners as well as a set of tools that allow you to find security vulnerabilities manually.

There is a newer version: 2.15.0

Show newest version

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2016 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.zaproxy.zap.extension;

import org.zaproxy.zap.control.AddOn;

/**
 * A listener that will be notified when the installation status of the add-ons changes.
 *
 * @since 2.5.0
 */
public interface AddOnInstallationStatusListener {

    /**
     * Notifies that the given add-on was installed.
     *
     * @param addOn the add-on that was installed, never {@code null}
     */
    void addOnInstalled(AddOn addOn);

    /**
     * Notifies that the given add-on was soft uninstalled.
     *
     * Soft uninstallation consists of uninstalling the Java classes ({@code Extension}s, {@code
     * Plugin}s, {@code PassiveScanner}s) of an add-on, called when the add-on must be temporarily
     * uninstalled for an update of a dependency.
     *
     * @param addOn the add-on that was soft uninstalled, never {@code null}
     * @param successfully if the soft uninstallation was successful, that is, no errors occurred
     *     while uninstalling it
     */
    void addOnSoftUninstalled(AddOn addOn, boolean successfully);

    /**
     * Notifies that the given add-on was uninstalled.
     *
     * @param addOn the add-on that was uninstalled, never {@code null}
     * @param successfully if the uninstallation was successful, that is, no errors occurred while
     *     uninstalling it
     */
    void addOnUninstalled(AddOn addOn, boolean successfully);
}