Adding upstream version 14.2.21.upstream/14.2.21upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 82 insertions, 0 deletions

diff --git a/src/pybind/mgr/dashboard/plugins/interfaces.py b/src/pybind/mgr/dashboard/plugins/interfaces.py
new file mode 100644
index 00000000..dbcd60a0
--- /dev/null
+++ b/src/pybind/mgr/dashboard/plugins/interfaces.py
@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+
+from . import PLUGIN_MANAGER as PM, Interface, Mixin  # pylint: disable=cyclic-import
+
+
+class CanMgr(Mixin):
+    from .. import mgr
+    mgr = mgr
+
+
+class CanLog(Mixin):
+    from .. import logger
+    log = logger
+
+
+class CanCherrypy(Mixin):
+    import cherrypy
+    request = cherrypy.request
+    response = cherrypy.response
+
+
+@PM.add_interface
+class Initializable(Interface):
+    @PM.add_abcspec
+    def init(self):
+        """
+        Placeholder for module scope initialization
+        """
+
+
+@PM.add_interface
+class Setupable(Interface):
+    @PM.add_abcspec
+    def setup(self):
+        """
+        Placeholder for plugin setup, right after server start.
+        CanMgr.mgr and CanLog.log are initialized by then.
+        """
+        pass
+
+
+@PM.add_interface
+class HasOptions(Interface):
+    @PM.add_abcspec
+    def get_options(self): pass
+
+
+@PM.add_interface
+class HasCommands(Interface):
+    @PM.add_abcspec
+    def register_commands(self): pass
+
+
+@PM.add_interface
+class HasControllers(Interface):
+    @PM.add_abcspec
+    def get_controllers(self): pass
+
+
+@PM.add_interface
+class ConfiguresCherryPy(Interface):
+    @PM.add_abcspec
+    def configure_cherrypy(self, config):
+        pass
+
+
+class FilterRequest(object):
+    @PM.add_interface
+    class BeforeHandler(Interface):
+        @PM.add_abcspec
+        def filter_request_before_handler(self, request): pass
+
+
+@PM.add_interface
+class ConfigNotify(Interface):
+    @PM.add_abcspec
+    def config_notify(self):
+        """
+        This method is called whenever a option of this mgr module has
+        been modified.
+        """