burp.api.montoya.ui.contextmenu.MessageEditorHttpRequestResponse Maven / Gradle / Ivy

Go to download

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

There is a newer version: 2024.12

/*
 * Copyright (c) 2022-2023. PortSwigger Ltd. All rights reserved.
 *
 * This code may be used to extend the functionality of Burp Suite Community Edition
 * and Burp Suite Professional, provided that this usage does not violate the
 * license terms for those products.
 */

package burp.api.montoya.ui.contextmenu;

import burp.api.montoya.core.Range;
import burp.api.montoya.http.message.HttpRequestResponse;
import burp.api.montoya.http.message.requests.HttpRequest;
import burp.api.montoya.http.message.responses.HttpResponse;

import java.util.Optional;

/**
 * This class contains information about a user selection of a request or response within a Burp Suite message editor.
 */
public interface MessageEditorHttpRequestResponse
{
    /**
     * @return An {@link SelectionContext} which indicates what data has been selected by the user and has focus.
     */
    SelectionContext selectionContext();

    /**
     * This will return {@link Optional#empty()} if the user has not made a selection.
     *
     * @return An {@link Optional} range of indices that indicates the position of the users current selection.
     */
    Optional selectionOffsets();

    /**
     * @return The index of the position for the carat within the current message editor.
     */
    int caretPosition();

    /**
     * @return An instance of {@link HttpRequestResponse} which contains the information about the currently displayed or selected HTTP request/response.
     */
    HttpRequestResponse requestResponse();

    /**
     * Update the message editor with the HTTP request
     *
     * @param request the request to update the editor.
     */
    void setRequest(HttpRequest request);

    /**
     * Update the message editor with the HTTP response
     *
     * @param response the response to update the editor.
     */
    void setResponse(HttpResponse response);


    enum SelectionContext
    {
        REQUEST,
        RESPONSE
    }
}