mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-23 15:40:01 -06:00
214 lines
5.0 KiB
Python
214 lines
5.0 KiB
Python
|
# Authors:
|
||
|
# Jason Gerard DeRose <jderose@redhat.com>
|
||
|
#
|
||
|
# Copyright (C) 2008 Red Hat
|
||
|
# see file 'COPYING' for use and warranty inmsgion
|
||
|
#
|
||
|
# This program is free software; you can redistribute it and/or
|
||
|
# modify it under the terms of the GNU General Public License as
|
||
|
# published by the Free Software Foundation; version 2 only
|
||
|
#
|
||
|
# This program is distributed in the hope that it will be useful,
|
||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
# GNU General Public License for more details.
|
||
|
#
|
||
|
# You should have received a copy of the GNU General Public License
|
||
|
# along with this program; if not, write to the Free Software
|
||
|
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||
|
|
||
|
"""
|
||
|
Custom exception classes.
|
||
|
|
||
|
Certain errors can be returned in RPC response to relay some error condition
|
||
|
to the caller.
|
||
|
|
||
|
============= ========================================
|
||
|
Error codes Exceptions
|
||
|
============= ========================================
|
||
|
900 `PublicError`
|
||
|
901 `InternalError`
|
||
|
902 - 999 *Reserved for future use*
|
||
|
1000 - 1999 `AuthenticationError` and its subclasses
|
||
|
2000 - 2999 `AuthorizationError` and its subclasses
|
||
|
3000 - 3999 `InvocationError` and its subclasses
|
||
|
4000 - 4999 `ExecutionError` and its subclasses
|
||
|
5000 - 5999 `GenericError` and its subclasses
|
||
|
============= ========================================
|
||
|
"""
|
||
|
|
||
|
from inspect import isclass
|
||
|
import request
|
||
|
|
||
|
|
||
|
class PrivateError(StandardError):
|
||
|
"""
|
||
|
Base class for exceptions that are *never* returned in an RPC response.
|
||
|
"""
|
||
|
|
||
|
|
||
|
class PublicError(StandardError):
|
||
|
"""
|
||
|
**900** Base class for exceptions that can be returned in an RPC response.
|
||
|
"""
|
||
|
|
||
|
code = 900
|
||
|
|
||
|
def __init__(self, message=None, **kw):
|
||
|
self.kw = kw
|
||
|
if message is None:
|
||
|
message = self.get_format(request._) % kw
|
||
|
StandardError.__init__(self, message)
|
||
|
|
||
|
def get_format(self, _):
|
||
|
return _('')
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
class InternalError(PublicError):
|
||
|
"""
|
||
|
**901** Used to conceal a non-public exception.
|
||
|
"""
|
||
|
|
||
|
code = 901
|
||
|
|
||
|
|
||
|
|
||
|
##############################################################################
|
||
|
# 1000 - 1999: Authentication Errors
|
||
|
class AuthenticationError(PublicError):
|
||
|
"""
|
||
|
**1000** Base class for authentication errors (*1000 - 1999*).
|
||
|
"""
|
||
|
|
||
|
code = 1000
|
||
|
|
||
|
|
||
|
|
||
|
##############################################################################
|
||
|
# 2000 - 2999: Authorization Errors
|
||
|
class AuthorizationError(PublicError):
|
||
|
"""
|
||
|
**2000** Base class for authorization errors (*2000 - 2999*).
|
||
|
"""
|
||
|
|
||
|
code = 2000
|
||
|
|
||
|
|
||
|
|
||
|
##############################################################################
|
||
|
# 3000 - 3999: Invocation Errors
|
||
|
|
||
|
class InvocationError(PublicError):
|
||
|
"""
|
||
|
**3000** Base class for command invocation errors (*3000 - 3999*).
|
||
|
"""
|
||
|
|
||
|
code = 3000
|
||
|
|
||
|
|
||
|
class CommandError(InvocationError):
|
||
|
"""
|
||
|
**3001** Raised when an unknown command is called.
|
||
|
"""
|
||
|
|
||
|
code = 3001
|
||
|
|
||
|
def get_format(self, _):
|
||
|
return _('Unknown command %(name)r')
|
||
|
|
||
|
|
||
|
class RemoteCommandError(InvocationError):
|
||
|
"""
|
||
|
**3002** Raised when client receives a `CommandError` from server.
|
||
|
"""
|
||
|
|
||
|
code = 3002
|
||
|
|
||
|
|
||
|
class ArgumentError(InvocationError):
|
||
|
"""
|
||
|
**3003** Raised when a command is called with wrong number of arguments.
|
||
|
"""
|
||
|
|
||
|
code = 3003
|
||
|
|
||
|
|
||
|
class OptionError(InvocationError):
|
||
|
"""
|
||
|
**3004** Raised when a command is called with unknown options.
|
||
|
"""
|
||
|
|
||
|
code = 3004
|
||
|
|
||
|
|
||
|
class RequirementError(InvocationError):
|
||
|
"""
|
||
|
**3005** Raised when a required parameter is not provided.
|
||
|
"""
|
||
|
|
||
|
code = 3005
|
||
|
|
||
|
|
||
|
class ConversionError(InvocationError):
|
||
|
"""
|
||
|
**3006** Raised when a parameter value is the wrong type.
|
||
|
"""
|
||
|
|
||
|
code = 3006
|
||
|
|
||
|
|
||
|
class ValidationError(InvocationError):
|
||
|
"""
|
||
|
**3007** Raised when a parameter value fails a validation rule.
|
||
|
"""
|
||
|
|
||
|
code = 3007
|
||
|
|
||
|
|
||
|
|
||
|
##############################################################################
|
||
|
# 4000 - 4999: Execution Errors
|
||
|
|
||
|
class ExecutionError(PublicError):
|
||
|
"""
|
||
|
**4000** Base class for execution/operation errors (*4000 - 4999*).
|
||
|
"""
|
||
|
|
||
|
code = 4000
|
||
|
|
||
|
|
||
|
|
||
|
##############################################################################
|
||
|
# 5000 - 5999: Generic Errors
|
||
|
|
||
|
class GenericError(PublicError):
|
||
|
"""
|
||
|
**5000** Errors inappropriate for other categories (*5000 - 5999*).
|
||
|
"""
|
||
|
|
||
|
code = 5000
|
||
|
|
||
|
|
||
|
|
||
|
def __errors_iter():
|
||
|
"""
|
||
|
Iterate through all the `PublicError` subclasses.
|
||
|
"""
|
||
|
for (key, value) in globals().items():
|
||
|
if key.startswith('_') or not isclass(value):
|
||
|
continue
|
||
|
if issubclass(value, PublicError):
|
||
|
yield value
|
||
|
|
||
|
public_errors = tuple(
|
||
|
sorted(__errors_iter(), key=lambda E: E.code)
|
||
|
)
|
||
|
|
||
|
if __name__ == '__main__':
|
||
|
for klass in public_errors:
|
||
|
print '%d\t%s' % (klass.code, klass.__name__)
|
||
|
print '(%d public errors)' % len(public_errors)
|