Document the listeners that plugins may implement to receive events

Change-Id: Ie3e258d63d18218660eba9da93ce017989a11723 Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2013-09-18 16:03:03 +02:00
parent 8e0f6d06fe
commit 9820266f54
1 changed files with 20 additions and 0 deletions
--- a/Documentation/dev-plugins.txt
+++ b/Documentation/dev-plugins.txt
@@ -255,6 +255,26 @@ link:http://maven.apache.org/plugins/maven-shade-plugin/[shade plugin]
 to package additional dependencies. Relocating (or renaming) classes
 should not be necessary due to the ClassLoader isolation.

+[[events]]
+Listening to Events
+-------------------
+
+Certain operations in Gerrit trigger events. Plugins may receive
+notifications of these events by implementing the corresponding
+listeners.
+
+* `com.google.gerrit.extensions.events.LifecycleListener`:
+
+Gerrit server startup and shutdown
+
+* `com.google.gerrit.extensions.events.NewProjectCreatedListener`:
+
+Project creation
+
+* `com.google.gerrit.extensions.events.ProjectDeletedListener`:
+
+Project deletion
+
 [[ssh]]
 SSH Commands
 ------------