Package burp.api.montoya.scope

Interface Scope

public interface Scope

Provides access to the functionality related to Burp's Suite-wide target scope.

Method Summary

Modifier and Type	Method	Description
void	excludeFromScope(String url)	This method can be used to exclude the specified URL from the Suite-wide target scope.
void	includeInScope(String url)	This method can be used to include the specified URL in the Suite-wide target scope.
boolean	isInScope(String url)	This method can be used to query whether a specified URL is within the current Suite-wide target scope.
Registration	registerScopeChangeHandler(ScopeChangeHandler handler)	Register a handler which will be notified of changes to Burp's Suite-wide target scope.

Method Details

isInScope

boolean isInScope(String url)

This method can be used to query whether a specified URL is within the current Suite-wide target scope.

Parameters:

url - The URL to query.

Returns:

Returns true if the URL is within the current Suite-wide target scope.

includeInScope

void includeInScope(String url)

This method can be used to include the specified URL in the Suite-wide target scope.

Parameters:

url - The URL to include in the Suite-wide target scope.

excludeFromScope

void excludeFromScope(String url)

This method can be used to exclude the specified URL from the Suite-wide target scope.

Parameters:

url - The URL to exclude from the Suite-wide target scope.

registerScopeChangeHandler

Registration registerScopeChangeHandler(ScopeChangeHandler handler)

Register a handler which will be notified of changes to Burp's Suite-wide target scope.

Parameters:

handler - An object created by the extension that implements the ScopeChangeHandler interface.

Returns:

The Registration for the handler.