compass-core/compass/api/errors.py
grace.yu 4c69d120cd Add initial code for user authentication
Change-Id: Ie0c439244f1ae3af707b73ef64b1a411c2aede20
2014-04-14 18:13:04 -07:00

146 lines
4.0 KiB
Python

# 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.
"""Exception and its handler."""
from compass.api import app
from compass.api import util
class ObjectDoesNotExist(Exception):
"""Define the exception for referring non-existing object."""
def __init__(self, message):
super(ObjectDoesNotExist, self).__init__(message)
self.message = message
def __str__(self):
return repr(self.message)
class UserInvalidUsage(Exception):
"""Define the exception for fault usage of users."""
def __init__(self, message):
super(UserInvalidUsage, self).__init__(message)
self.message = message
def __str__(self):
return repr(self.message)
class ObjectDuplicateError(Exception):
"""Define the duplicated object exception."""
def __init__(self, message):
super(ObjectDuplicateError, self).__init__(message)
self.message = message
def __str__(self):
return repr(self.message)
class InputMissingError(Exception):
"""Define the insufficient input exception."""
def __init__(self, message):
super(InputMissingError, self).__init__(message)
self.message = message
def __str__(self):
return repr(self.message)
class MethodNotAllowed(Exception):
"""Define the exception which invalid method is called."""
def __init__(self, message):
super(MethodNotAllowed, self).__init__(message)
self.message = message
def __str__(self):
return repr(self.message)
class InvalidUserInfo(Exception):
"""Define the Exception for incorrect user information."""
def __init__(self, message):
super(InvalidUserInfo, self).__init__(message)
self.message = message
@app.errorhandler(ObjectDoesNotExist)
def handle_not_exist(error, failed_objs=None):
"""Handler of ObjectDoesNotExist Exception."""
message = {'status': 'Not Found',
'message': error.message}
if failed_objs and isinstance(failed_objs, dict):
message.update(failed_objs)
return util.make_json_response(404, message)
@app.errorhandler(UserInvalidUsage)
def handle_invalid_usage(error):
"""Handler of UserInvalidUsage Exception."""
message = {
'status': 'Invalid parameters',
'message': error.message
}
return util.make_json_response(400, message)
@app.errorhandler(InputMissingError)
def handle_mssing_input(error):
"""Handler of InputMissingError Exception."""
message = {
'status': 'Insufficient data',
'message': error.message
}
return util.make_json_response(400, message)
@app.errorhandler(ObjectDuplicateError)
def handle_duplicate_object(error, failed_objs=None):
"""Handler of ObjectDuplicateError Exception."""
message = {
'status': 'Conflict Error',
'message': error.message
}
if failed_objs and isinstance(failed_objs, dict):
message.update(failed_objs)
return util.make_json_response(409, message)
@app.errorhandler(MethodNotAllowed)
def handle_not_allowed_method(error):
"""Handler of MethodNotAllowed Exception."""
message = {
"status": "Method Not Allowed",
"message": "The method is not allowed to use"
}
return util.make_json_response(405, message)
@app.errorhandler(InvalidUserInfo)
def handle_invalid_user_info(error):
"""Handler of InvalidUserInfo Exception."""
message = {"status": "Incorrect User Info",
"message": error.message}
return util.make_json_response(401, message)