org.zaproxy.zap.eventBus

Interface EventBus

All Known Implementing Classes:

SimpleEventBus

public interface EventBus

Interface for the event bus used to publish events in ZAP

Method Summary

Modifier and Type	Method and Description
void	publishSyncEvent(EventPublisher publisher, Event event) Publish the specified event synchronously
void	registerConsumer(EventConsumer consumer, String publisherName) Register the consumer for the specified publisher - this consumer will receive all events from the publisher
void	registerConsumer(EventConsumer consumer, String publisherName, String... eventTypes) Register the consumer for the specified publisher - this consumer will only receive the specified events from the publisher
void	registerPublisher(EventPublisher publisher, String... eventTypes) Register a publisher - only registered publishers can publish events
void	unregisterConsumer(EventConsumer consumer) Unregister the consumer from all publishers
void	unregisterConsumer(EventConsumer consumer, String publisherName) Unregister the consumer from the specified publisher
void	unregisterPublisher(EventPublisher publisher) Unregister the publisher

Method Detail

registerPublisher

void registerPublisher(EventPublisher publisher,
                       String... eventTypes)

Register a publisher - only registered publishers can publish events

Parameters:

publisher - the publisher

eventTypes - the full set of event types the publisher can publish

unregisterPublisher

void unregisterPublisher(EventPublisher publisher)

Unregister the publisher

Parameters:

publisher - the publisher

registerConsumer

void registerConsumer(EventConsumer consumer,
                      String publisherName)

Register the consumer for the specified publisher - this consumer will receive all events from the publisher

Parameters:

consumer - the consumer of events

publisherName - the name of the publisher

registerConsumer

void registerConsumer(EventConsumer consumer,
                      String publisherName,
                      String... eventTypes)

Register the consumer for the specified publisher - this consumer will only receive the specified events from the publisher

Parameters:

consumer - the consumer of events

publisherName - the name of the publisher

eventTypes - the event types

unregisterConsumer

void unregisterConsumer(EventConsumer consumer)

Unregister the consumer from all publishers

Parameters:

consumer - the consumer of events

Since:

2.8.0

unregisterConsumer

void unregisterConsumer(EventConsumer consumer,
                        String publisherName)

Unregister the consumer from the specified publisher

Parameters:

consumer - the consumer of events

publisherName - the name of the publisher

publishSyncEvent

void publishSyncEvent(EventPublisher publisher,
                      Event event)

Publish the specified event synchronously

Parameters:

publisher - the publisher

event - the event