summaryrefslogtreecommitdiffstats
path: root/src/pybind/mgr/dashboard/plugins/interfaces.py
blob: 0c106d2617cc33d164d0ea248330354c21b1e4b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# -*- coding: utf-8 -*-

from . import PLUGIN_MANAGER as PM  # pylint: disable=cyclic-import
from . import Interface, Mixin


class CanMgr(Mixin):
    from .. import mgr
    mgr = mgr  # type: ignore


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 is initialized by then.
        """


@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.
        """