burp.api.montoya.scanner.ScanTask 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.scanner;

import burp.api.montoya.core.Task;

/**
 * This interface is used to retrieve details of tasks in the Burp Scanner.
 */
public interface ScanTask extends Task
{
    /**
     * Number of requests that have been made for the
     * scan task.
     *
     * @return The number of requests that have been made for the scan task.
     */
    int requestCount();

    /**
     * Number of network errors that have occurred for
     * the scan task.
     *
     * @return The number of network errors that have occurred for the scan
     * task.
     */
    int errorCount();

    /**
     * Delete the task.
     */
    @Override
    void delete();

    /**
     * @return the current status message of the task
     */
    @Override
    String statusMessage();
}