Interface RequestEngineOptions

public interface RequestEngineOptions

Engine-level options for a RequestExecutionEngine run: the dashboard task name and the ResourcePool it draws on for concurrency, throttle and retries. The per-request timeout is given when the run is started, on RequestExecutionEngine.sendAll().

Instances are immutable; each withX method returns a new options value.

Method Summary

Modifier and Type	Method	Description
static RequestEngineOptions	requestEngineOptions()	Use to obtain a new RequestEngineOptions instance.
RequestEngineOptions	withName(String name)	Set the name shown for the run's task on the Burp dashboard.
RequestEngineOptions	withResourcePool(ResourcePool resourcePool)	Set the resource pool the run draws on.

Method Details

withName

RequestEngineOptions withName(String name)

Set the name shown for the run's task on the Burp dashboard. When unset, the task is named "Bulk send".

Parameters:

name - The dashboard task name.

Returns:

request engine options

withResourcePool

RequestEngineOptions withResourcePool(ResourcePool resourcePool)

Set the resource pool the run draws on. When unset, the run uses a private pool at default settings.

Parameters:

resourcePool - The resource pool, from ResourcePool.resourcePool(), ResourcePool.defaultResourcePool() or ResourcePool.existingResourcePool(String).

Returns:

request engine options

requestEngineOptions

static RequestEngineOptions requestEngineOptions()

Use to obtain a new RequestEngineOptions instance.

Returns:

request engine options