aboutsummaryrefslogtreecommitdiffstats
path: root/sdv/docker/sdvstate/tools/result_api/result_api.py
blob: 95dfd56ec4391aebfb77b7eed8fe9972a6cd5cc2 (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
# Copyright 2020 University Of Delhi.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""
Result API
Main entry point to use results manager
"""

import logging
from .storage.storage_api import StorageApi

class ResultApi():
    """
    Result API
    Provides various storage options to use implemented as
    plugin to storage api
    """

    def __init__(self):
        """
        Initialization function
        """
        self._logger = logging.getLogger(__name__)
        self._storage_handles = []

    def register_storage(self, storage_api):
        """
        Registers ``storage_api`` as an active storage option to use.
        """
        self._logger.debug("Loading new Storage API...")
        if not isinstance(storage_api, StorageApi):
            raise TypeError("incorrect storage type, Required StorageAPI obj")

        storage_api.load_settings()
        self._storage_handles.append(storage_api)
        self._logger.info(f'{storage_api.name} api registered')

    def unregister_storage(self, storage_api):
        """
        Removes registered ``storage_api`` if exists
        """
        while storage_api in self._storage_handles:
            self._storage_handles.remove(storage_api)

    def unregister_all(self):
        """
        Removes all registered storage endpoints
        """
        for storage_api in self._storage_handles:
            self.unregister_storage(storage_api)

    def store(self, data):
        """
        Calls all active storage_api and stores ``data`` in all of them
        """
        for api in self._storage_handles:
            api.store(data)


# pylint: disable=invalid-name
result_api = ResultApi()