Support for mongodb replicaset connection (HA).
[osm/common.git] / osm_common / fsbase.py
1 # -*- coding: utf-8 -*-
2
3 # Copyright 2018 Telefonica S.A.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14 # implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17
18
19 import logging
20 from http import HTTPStatus
21 from osm_common.common_utils import FakeLock
22 from threading import Lock
23
24 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
25
26
27 class FsException(Exception):
28 def __init__(self, message, http_code=HTTPStatus.INTERNAL_SERVER_ERROR):
29 self.http_code = http_code
30 Exception.__init__(self, "storage exception " + message)
31
32
33 class FsBase(object):
34 def __init__(self, logger_name='fs', lock=False):
35 """
36 Constructor of FsBase
37 :param logger_name: logging name
38 :param lock: Used to protect simultaneous access to the same instance class by several threads:
39 False, None: Do not protect, this object will only be accessed by one thread
40 True: This object needs to be protected by several threads accessing.
41 Lock object. Use thi Lock for the threads access protection
42 """
43 self.logger = logging.getLogger(logger_name)
44 if not lock:
45 self.lock = FakeLock()
46 elif lock is True:
47 self.lock = Lock()
48 elif isinstance(lock, Lock):
49 self.lock = lock
50 else:
51 raise ValueError("lock parameter must be a Lock class or boolean")
52
53 def get_params(self):
54 return {}
55
56 def fs_connect(self, config):
57 pass
58
59 def fs_disconnect(self):
60 pass
61
62 def mkdir(self, folder):
63 raise FsException("Method 'mkdir' not implemented")
64
65 def dir_rename(self, src, dst):
66 raise FsException("Method 'dir_rename' not implemented")
67
68 def dir_ls(self, storage):
69 raise FsException("Method 'dir_ls' not implemented")
70
71 def file_exists(self, storage):
72 raise FsException("Method 'file_exists' not implemented")
73
74 def file_size(self, storage):
75 raise FsException("Method 'file_size' not implemented")
76
77 def file_extract(self, tar_object, path):
78 raise FsException("Method 'file_extract' not implemented")
79
80 def file_open(self, storage, mode):
81 raise FsException("Method 'file_open' not implemented")
82
83 def file_delete(self, storage, ignore_non_exist=False):
84 raise FsException("Method 'file_delete' not implemented")
85
86 def sync(self, from_path=None):
87 raise FsException("Method 'sync' not implemented")
88
89 def reverse_sync(self, from_path):
90 raise FsException("Method 'reverse_sync' not implemented")