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

/*
 * @(#)IResponseInfo.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.
 */
import java.util.List;

/**
 * This interface is used to retrieve key details about an HTTP response.
 * Extensions can obtain an
 * IResponseInfo object for a given response by calling
 * IExtensionHelpers.analyzeResponse().
 */
public interface IResponseInfo
{
    /**
     * This method is used to obtain the HTTP headers contained in the response.
     *
     * @return The HTTP headers contained in the response.
     */
    List getHeaders();

    /**
     * This method is used to obtain the offset within the response where the
     * message body begins.
     *
     * @return The offset within the response where the message body begins.
     */
    int getBodyOffset();

    /**
     * This method is used to obtain the HTTP status code contained in the
     * response.
     *
     * @return The HTTP status code contained in the response.
     */
    short getStatusCode();

    /**
     * This method is used to obtain details of the HTTP cookies set in the
     * response.
     *
     * @return A list of ICookie objects representing the cookies
     * set in the response, if any.
     */
    List getCookies();

    /**
     * This method is used to obtain the MIME type of the response, as stated in
     * the HTTP headers.
     *
     * @return A textual label for the stated MIME type, or an empty String if
     * this is not known or recognized. The possible labels are the same as
     * those used in the main Burp UI.
     */
    String getStatedMimeType();

    /**
     * This method is used to obtain the MIME type of the response, as inferred
     * from the contents of the HTTP message body.
     *
     * @return A textual label for the inferred MIME type, or an empty String if
     * this is not known or recognized. The possible labels are the same as
     * those used in the main Burp UI.
     */
    String getInferredMimeType();
}