org.zaproxy.zap.extension.ascan

Class ScanProgressItem

java.lang.Object

org.zaproxy.zap.extension.ascan.ScanProgressItem

public class ScanProgressItem
extends Object

Class for Visual Plugin Progress management

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_COMPLETED
static int	STATUS_PENDING
static int	STATUS_RUNNING

Constructor Summary

Constructors

Constructor and Description
ScanProgressItem(HostProcess hProcess, Plugin plugin, int status)

Method Summary

Modifier and Type	Method and Description
String	getAttackStrenghtLabel() Deprecated. (2.11.0) Use getAttackStrengthLabel()
String	getAttackStrengthLabel()
long	getElapsedTime()
String	getNameLabel()
protected Plugin	getPlugin()
int	getProgressPercentage() Get back the percentage of completion.
int	getReqCount()
String	getSkippedReason() Gets the reason why the plugin was skipped.
String	getStatusLabel()
boolean	isCompleted()
boolean	isRunning()
boolean	isSkipped() Tells whether or not the plugin was skipped.
void	skip()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_PENDING

public static final int STATUS_PENDING

See Also:

Constant Field Values

STATUS_RUNNING

public static final int STATUS_RUNNING

See Also:

Constant Field Values

STATUS_COMPLETED

public static final int STATUS_COMPLETED

See Also:

Constant Field Values

Constructor Detail

ScanProgressItem

public ScanProgressItem(HostProcess hProcess,
                        Plugin plugin,
                        int status)

Parameters:

plugin -

status -

Method Detail

getNameLabel

public String getNameLabel()

Returns:

getAttackStrenghtLabel

@Deprecated
public String getAttackStrenghtLabel()

Deprecated. (2.11.0) Use getAttackStrengthLabel()

getAttackStrengthLabel

public String getAttackStrengthLabel()

Returns:

getStatusLabel

public String getStatusLabel()

Returns:

getElapsedTime

public long getElapsedTime()

getProgressPercentage

public int getProgressPercentage()

Get back the percentage of completion.

Returns:

the percentage value from 0 to 100

isRunning

public boolean isRunning()

Returns:

isCompleted

public boolean isCompleted()

Returns:

isSkipped

public boolean isSkipped()

Tells whether or not the plugin was skipped.

Returns:

true if the plugin was skipped, false otherwise.

Since:

2.4.0

See Also:

getSkippedReason()

getSkippedReason

public String getSkippedReason()

Gets the reason why the plugin was skipped.

Returns:

the reason why the plugin was skipped, might be null if there's no reason

Since:

2.6.0

See Also:

isSkipped()

skip

public void skip()

getPlugin

protected Plugin getPlugin()

Returns:

getReqCount

public int getReqCount()

toString

public String toString()

Overrides:

toString in class Object