burp.api.montoya.ui.contextmenu.WebSocketMessage 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) 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.Annotations;
import burp.api.montoya.core.ByteArray;
import burp.api.montoya.http.message.requests.HttpRequest;
import burp.api.montoya.websocket.Direction;

public interface WebSocketMessage
{
    /**
     * This method retrieves the annotations for the message.
     *
     * @return The {@link Annotations} for the message.
     */
    Annotations annotations();

    /**
     * @return The direction of the message.
     */
    Direction direction();

    /**
     * @return WebSocket payload.
     */
    ByteArray payload();

    /**
     * @return The {@link HttpRequest} used to create the WebSocket.
     */
    HttpRequest upgradeRequest();
}