burp.ITempFile 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;

/*
 * @(#)ITempFile.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.
 */
/**
 * This interface is used to hold details of a temporary file that has been
 * created via a call to
 * IBurpExtenderCallbacks.saveToTempFile().
 *
 */
public interface ITempFile
{
    /**
     * This method is used to retrieve the contents of the buffer that was saved
     * in the temporary file.
     *
     * @return The contents of the buffer that was saved in the temporary file.
     */
    byte[] getBuffer();

    /**
     * This method is deprecated and no longer performs any action.
     */
    @Deprecated
    void delete();
}