Merge pull request #166 from psiinon/on-event-handler

Added example script for listening for internal ZAP events

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - authentication/DjangoAuthentication.js > Django authentication script.
 - standalone/scan_rule_list.js that list details from both active and passive scan rules.
 - standalone/Split download extract.rb: Add script to concatenate split file downloads
+ - extender/ZAP onEvent Handler.js: An example for how to listen for internal ZAP events
 
 ### Changed
 - Misc maintenance changes.

extender/ZAP onEvent Handler.js

@@ -0,0 +1,30 @@
+// A script which listens for events generated by the ProxyListenerLogEventPublisher.
+// You can change this to listen for events generated by any other event publisher
+
+var consumer;
+
+function install(helper) {
+  var ConsumerClass = Java.extend(Java.type("org.zaproxy.zap.eventBus.EventConsumer"));
+  consumer = new ConsumerClass({
+    eventReceived: function(event) { 
+      // Print in one statement to prevent threads interleaving
+      var target = '---';
+      if (event.getTarget()) {
+        target = event.getTarget().getDisplayName();
+      }
+      print(
+        'Event received: \n' +
+        '  Publisher: ' + event.getPublisher().getPublisherName() + '\n' +
+        '  Type:      ' + event.getEventType() + '\n' +
+        '  Target:    ' + target + '\n' +
+        '  Params:    ' + event.getParameters());
+    }
+  });
+
+  org.zaproxy.zap.ZAP.getEventBus().registerConsumer(consumer, 
+    "org.parosproxy.paros.extension.history.ProxyListenerLogEventPublisher");
+}
+
+function uninstall(helper) {
+  org.zaproxy.zap.ZAP.getEventBus().unregisterConsumer(consumer);
+}