1 files changed, 38 insertions, 0 deletions

diff --git a/src/mailman/interfaces/plugin.py b/src/mailman/interfaces/plugin.py
new file mode 100644
index 000000000..f1b7212f0
--- /dev/null
+++ b/src/mailman/interfaces/plugin.py
@@ -0,0 +1,38 @@
+# Copyright (C) 2007-2017 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Interfaces for plugins."""
+
+from public import public
+from zope.interface import Interface
+
+
+@public
+class IPlugin(Interface):
+    """A plugin providing components and hooks."""
+
+    def pre_hook():
+        """A plugin hook called in the first initialization step. Before DB."""
+
+    def post_hook():
+        """A plugin hook called in the second initialization step. After DB."""
+
+    def rest_object():
+        """Return the REST object which will be hooked up to the REST api.
+
+        This object will be served at the /<api>/plugins/<plugin.name>/ root.
+        """