burp.IBurpExtender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of burp-extender-api Show documentation

API to reference when building extensions for Burp Suite Pro.

There is a newer version: 2.3

package burp;

/*
 * @(#)IBurpExtender.java
 *
 * Copyright PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Free Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */
/**
 * All extensions must implement this interface.
 *
 * Implementations must be called BurpExtender, in the package burp, must be
 * declared public, and must provide a default (public, no-argument)
 * constructor.
 */
public interface IBurpExtender
{
    /**
     * This method is invoked when the extension is loaded. It registers an
     * instance of the
     * IBurpExtenderCallbacks interface, providing methods that may
     * be invoked by the extension to perform various actions.
     *
     * @param callbacks An
     * IBurpExtenderCallbacks object.
     */
    void registerExtenderCallbacks(IBurpExtenderCallbacks callbacks);
}