Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 2.47 KB

ExtensionHooks.md

File metadata and controls

42 lines (31 loc) · 2.47 KB
Raw

Extension Hooks

ZAP provides a range of mechanisms for extending its functionality.

One of the main ones is provides by the ExtensionHook class.

This class allows you to hook your own classes into ZAP using a set of standard interfaces.

To use these you will need to implement the Extension interface (typically by extending the abstract ExtensionAdaptor).

You can then hook any class that implements the interfaces below by adding calls to the relevant ExtensionHook methods in the 'hook' method, for example (from ExtensionAlert):

    @Override
    public void hook(ExtensionHook extensionHook) {
        super.hook(extensionHook);
        if (getView() != null) {
            extensionHook.getHookMenu().addPopupMenuItem(getPopupMenuAlertEdit());
            extensionHook.getHookMenu().addPopupMenuItem(getPopupMenuAlertDelete());
            extensionHook.getHookMenu().addPopupMenuItem(getPopupMenuAlertsRefresh());
            extensionHook.getHookMenu().addPopupMenuItem(getPopupMenuShowAlerts());

            extensionHook.getHookView().addStatusPanel(getAlertPanel());

            ExtensionHelp.enableHelpKey(getAlertPanel(), "ui.tabs.alerts");
        }
        extensionHook.addSessionListener(this);

The interfaces supported include:

Interface Summary
ProxyListener Allows you to view and change all requests and responses
OptionsChangedListener Called when options are changed
SessionChangedListener Called when significant changes are made to the session
AbstractParam Allows you to hook into the mechanism for persisting parameters
SiteMapListener Called when nodes are selected in the Sites tree
PersistentConnectionListener Called when persistent connection handshakes occur
AddonFilesChangedListener Called when Add-on files are added or removed

This class is also the mechanism for adding graphical elements to the UI - more details to come.