summaryrefslogtreecommitdiffstats
path: root/compass-deck/db/exception.py
blob: 44556c9bbbaa8181ab9af736c60cb44a3a071b9b (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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# Copyright 2014 Huawei Technologies Co. Ltd
#
# 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.

"""Custom exception"""
import traceback


class DatabaseException(Exception):
    """Base class for all database exceptions."""
    def __init__(self, message):
        super(DatabaseException, self).__init__(message)
        self.traceback = traceback.format_exc()
        self.status_code = 400

    def to_dict(self):
        return {'message': str(self)}


class RecordNotExists(DatabaseException):
    """Define the exception for referring non-existing object in DB."""
    def __init__(self, message):
        super(RecordNotExists, self).__init__(message)
        self.status_code = 404


class DuplicatedRecord(DatabaseException):
    """Define the exception for trying to insert an existing object in DB."""
    def __init__(self, message):
        super(DuplicatedRecord, self).__init__(message)
        self.status_code = 409


class Unauthorized(DatabaseException):
    """Define the exception for invalid user login."""
    def __init__(self, message):
        super(Unauthorized, self).__init__(message)
        self.status_code = 401


class UserDisabled(DatabaseException):
    """Define the exception that a disabled user tries to do some operations.

    """
    def __init__(self, message):
        super(UserDisabled, self).__init__(message)
        self.status_code = 403


class Forbidden(DatabaseException):
    """Define the exception that a user is trying to make some action

    without the right permission.

    """
    def __init__(self, message):
        super(Forbidden, self).__init__(message)
        self.status_code = 403


class NotAcceptable(DatabaseException):
    """The data is not acceptable."""
    def __init__(self, message):
        super(NotAcceptable, self).__init__(message)
        self.status_code = 406


class InvalidParameter(DatabaseException):
    """Define the exception that the request has invalid or missing parameters.

    """
    def __init__(self, message):
        super(InvalidParameter, self).__init__(message)
        self.status_code = 400


class InvalidResponse(DatabaseException):
    """Define the exception that the response is invalid.

    """
    def __init__(self, message):
        super(InvalidResponse, self).__init__(message)
        self.status_code = 400


class MultiDatabaseException(DatabaseException):
    """Define the exception composites with multi exceptions."""
    def __init__(self, exceptions):
        super(MultiDatabaseException, self).__init__('multi exceptions')
        self.exceptions = exceptions
        self.status_code = 400

    @property
    def traceback(self):
        tracebacks = []
        for exception in self.exceptions:
            tracebacks.append(exception.trackback)

    def to_dict(self):
        dict_info = super(MultiDatabaseException, self).to_dict()
        dict_info.update({
            'exceptions': [
                exception.to_dict() for exception in self.exceptions
            ]
        })
        return dict_info