org.zaproxy.zap.extension.script.ScriptUI Maven / Gradle / Ivy

Go to download
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.
The newest version!
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2013 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.script;

import java.awt.event.MouseAdapter;
import java.io.Writer;
import java.util.List;
import javax.swing.TransferHandler;
import javax.swing.event.TreeSelectionListener;
import javax.swing.tree.TreeCellRenderer;

public interface ScriptUI {

    /**
     * Called after an engine is added.
     *
     * The UI should display the contents of the selected script if it's targeting the added
     * engine.
     *
     * @param scriptEngineWrapper the engine that was removed
     * @since 2.4.0
     */
    void engineAdded(ScriptEngineWrapper scriptEngineWrapper);

    /**
     * Called after an engine is removed.
     *
     * The UI should clear the contents of the selected script if it's targeting the removed
     * engine.
     *
     * @param scriptEngineWrapper the engine that was removed
     * @since 2.4.0
     */
    void engineRemoved(ScriptEngineWrapper scriptEngineWrapper);

    /**
     * Gets the currently selected script node.
     *
     * @return the selected node, or {@code null} if none.
     * @see #getSelectedNodes()
     * @see #addSelectionListener(TreeSelectionListener)
     */
    ScriptNode getSelectedNode();

    /**
     * Gets the currently selected script nodes.
     *
     * @return the selected nodes, or empty list if none.
     * @see #getSelectedNode()
     * @see #addSelectionListener(TreeSelectionListener)
     */
    List getSelectedNodes();

    /**
     * Adds the given tree selection listener.
     *
     * @param tsl the tree selection listener to be added.
     * @since 2.8.0
     * @see #removeSelectionListener(TreeSelectionListener)
     * @see #getSelectedNode()
     * @see #getSelectedNodes()
     */
    default void addSelectionListener(TreeSelectionListener tsl) {
        // Nothing to do.
    }

    /**
     * Removes the given tree selection listener.
     *
     * @param tsl the tree selection listener to remove.
     * @since 2.8.0
     * @see #addSelectionListener(TreeSelectionListener)
     */
    default void removeSelectionListener(TreeSelectionListener tsl) {
        // Nothing to do.
    }

    void addMouseListener(MouseAdapter adapter);

    /**
     * Removes the given mouse listener.
     *
     * @param mouseListener the mouse listener that will be removed.
     * @since 2.4.0
     */
    void removeMouseListener(MouseAdapter mouseListener);

    void addRenderer(Class c, TreeCellRenderer renderer);

    /**
     * Removes the renderer added for the given class.
     *
     * @param klass the class whose target renderer should be removed
     * @since 2.4.0
     */
    void removeRenderer(Class klass);

    /**
     * Adds a transfer handler for the given class.
     *
     * @param klass the class in which the given transfer handler will be used
     * @param th the transfer handler
     * @since 2.4.0
     */
    void addScriptTreeTransferHandler(Class klass, TransferHandler th);

    /**
     * Removes the transfer handler that was being used for the given class.
     *
     * @param klass the class whose targeting transfer handler will be removed
     * @since 2.4.0
     */
    void removeScriptTreeTransferHandler(Class klass);

    /**
     * Displays the provided script with focus.
     *
     * @param script The script to be displayed.
     */
    void displayScript(ScriptWrapper script);

    /**
     * Displays the provided script with/without focusing on it. By default, this method delegates
     * to {@link #displayScript(ScriptWrapper)}.
     *
     * @param script The script to be displayed.
     * @param allowFocus {@code true} to allow focusing on the script display, {@code false}
     *     otherwise.
     * @since 2.14.0
     * @see #displayScript(ScriptWrapper)
     */
    default void displayScript(ScriptWrapper script, boolean allowFocus) {
        displayScript(script);
    }

    boolean isScriptDisplayed(ScriptWrapper script);

    /**
     * Selects a node with focus with/without expanding.
     *
     * @param node The node to be selected.
     * @param expand {@code true} to expand the node, {@code false} otherwise.
     */
    void selectNode(ScriptNode node, boolean expand);

    /**
     * Selects a node with/without focusing on it. By default, this method delegates to {@link
     * #selectNode(ScriptNode, boolean)}.
     *
     * @param node The node to be displayed.
     * @param expand {@code true} to expand the node, {@code false} otherwise.
     * @param allowFocus {@code true} to allow focusing on the display, {@code false} otherwise.
     * @since 2.14.0
     * @see #selectNode(ScriptNode, boolean)
     */
    default void selectNode(ScriptNode node, boolean expand, boolean allowFocus) {
        selectNode(node, expand);
    }

    void disableScriptDialog(Class klass);

    /**
     * Removes a disabled script dialogue of the given class.
     *
     * @param klass the class that has the script dialogue disabled
     * @since 2.4.0
     */
    void removeDisableScriptDialog(Class klass);

    String getTreeName();

    Writer getOutputWriter();
}