Enum Class ScanCheckType

java.lang.Object

java.lang.Enum<ScanCheckType>

burp.api.montoya.scanner.scancheck.ScanCheckType

All Implemented Interfaces:

Serializable, Comparable<ScanCheckType>, Constable

public enum ScanCheckType
extends Enum<ScanCheckType>

The type of scan check (ActiveScanCheck or PassiveScanCheck) that will be run. The scan check type defines the point a scan check is invoked by the Scanner. The following scan check types are available: PER_HOST, PER_REQUEST, PER_INSERTION_POINT

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PER_HOST	The Scanner invokes the scan check once for each host.
PER_INSERTION_POINT	The Scanner invokes the scan check once for each insertion point.
PER_REQUEST	The Scanner invokes the scan check once for each request.

Method Summary

Modifier and Type	Method	Description
static ScanCheckType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScanCheckType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PER_HOST

public static final ScanCheckType PER_HOST

The Scanner invokes the scan check once for each host.

PER_REQUEST

public static final ScanCheckType PER_REQUEST

The Scanner invokes the scan check once for each request.

PER_INSERTION_POINT

public static final ScanCheckType PER_INSERTION_POINT

The Scanner invokes the scan check once for each insertion point. Note: Only applicable to ActiveScanCheck. Registering a PassiveScanCheck using Scanner.registerPassiveScanCheck(PassiveScanCheck, ScanCheckType) with this type will throw an IllegalArgumentException.

Method Details

values

public static ScanCheckType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScanCheckType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null