Package org.zaproxy.zap.model

Class ScanEventPublisher

java.lang.Object

org.zaproxy.zap.model.ScanEventPublisher

All Implemented Interfaces:

EventPublisher

Direct Known Subclasses:

ActiveScanEventPublisher, SpiderEventPublisher

public abstract class ScanEventPublisher
extends java.lang.Object
implements EventPublisher

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SCAN_COMPLETED_EVENT
static java.lang.String	SCAN_ID
static java.lang.String	SCAN_PAUSED_EVENT
static java.lang.String	SCAN_PROGRESS
static java.lang.String	SCAN_PROGRESS_EVENT
static java.lang.String	SCAN_RESUMED_EVENT
static java.lang.String	SCAN_STARTED_EVENT
static java.lang.String	SCAN_STOPPED_EVENT
static java.lang.String	TARGET_URL
static java.lang.String	USER_ID
static java.lang.String	USER_NAME

Constructor Summary

Constructors

Constructor	Description
ScanEventPublisher()

Method Summary

Modifier and Type	Method	Description
protected static java.lang.String[]	getEvents()	Returns a new array with all events.
java.lang.String	getPublisherName()	The name by which the publisher is know - typically the full class name of the publisher.
void	publishScanEvent(EventPublisher publisher, java.lang.String event, int scanId)
void	publishScanEvent(EventPublisher publisher, java.lang.String event, int scanId, java.lang.String url, User user)
void	publishScanEvent(EventPublisher publisher, java.lang.String event, int scanId, Target target, User user)
void	publishScanEvent(EventPublisher publisher, java.lang.String event, int scanId, Target target, User user, java.util.Map<java.lang.String,java.lang.String> params)
void	publishScanProgressEvent(EventPublisher publisher, int scanId, int scanProgress)

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_STARTED_EVENT

public static final java.lang.String SCAN_STARTED_EVENT

See Also:

Constant Field Values

SCAN_STOPPED_EVENT

public static final java.lang.String SCAN_STOPPED_EVENT

See Also:

Constant Field Values

SCAN_PAUSED_EVENT

public static final java.lang.String SCAN_PAUSED_EVENT

See Also:

Constant Field Values

SCAN_RESUMED_EVENT

public static final java.lang.String SCAN_RESUMED_EVENT

See Also:

Constant Field Values

SCAN_COMPLETED_EVENT

public static final java.lang.String SCAN_COMPLETED_EVENT

See Also:

Constant Field Values

SCAN_PROGRESS_EVENT

public static final java.lang.String SCAN_PROGRESS_EVENT

See Also:

Constant Field Values

SCAN_ID

public static final java.lang.String SCAN_ID

See Also:

Constant Field Values

SCAN_PROGRESS

public static final java.lang.String SCAN_PROGRESS

See Also:

Constant Field Values

TARGET_URL

public static final java.lang.String TARGET_URL

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

Constructor Detail

ScanEventPublisher

public ScanEventPublisher()

Method Detail

getEvents

protected static java.lang.String[] getEvents()

Returns a new array with all events.

Returns:

an array containing all events.

getPublisherName

public java.lang.String getPublisherName()

Description copied from interface: EventPublisher

The name by which the publisher is know - typically the full class name of the publisher. Only one publisher can register with a given name.

Specified by:

getPublisherName in interface EventPublisher

Returns:

the name of the publisher, never null.

publishScanEvent

public void publishScanEvent(EventPublisher publisher,
                             java.lang.String event,
                             int scanId)

publishScanEvent

public void publishScanEvent(EventPublisher publisher,
                             java.lang.String event,
                             int scanId,
                             Target target,
                             User user)

publishScanEvent

public void publishScanEvent(EventPublisher publisher,
                             java.lang.String event,
                             int scanId,
                             java.lang.String url,
                             User user)

publishScanEvent

public void publishScanEvent(EventPublisher publisher,
                             java.lang.String event,
                             int scanId,
                             Target target,
                             User user,
                             java.util.Map<java.lang.String,java.lang.String> params)

publishScanProgressEvent

public void publishScanProgressEvent(EventPublisher publisher,
                                     int scanId,
                                     int scanProgress)