69 lines
1.7 KiB
Python
69 lines
1.7 KiB
Python
# Copyright (C) 2015 Custodia Project Contributors - see LICENSE file
|
|
from __future__ import absolute_import
|
|
|
|
from ipaserver.custodia.log import getLogger
|
|
|
|
logger = getLogger(__name__)
|
|
|
|
|
|
class InvalidMessage(Exception):
|
|
"""Invalid Message.
|
|
|
|
This exception is raised when a message cannot be parsed
|
|
or validated.
|
|
"""
|
|
def __init__(self, message=None):
|
|
logger.debug(message)
|
|
super(InvalidMessage, self).__init__(message)
|
|
|
|
|
|
class UnknownMessageType(Exception):
|
|
"""Unknown Message Type.
|
|
|
|
This exception is raised when a message is of an unknown
|
|
type.
|
|
"""
|
|
def __init__(self, message=None):
|
|
logger.debug(message)
|
|
super(UnknownMessageType, self).__init__(message)
|
|
|
|
|
|
class UnallowedMessage(Exception):
|
|
"""Unallowed Message.
|
|
|
|
This exception is raise when the message type is know but
|
|
is not allowed.
|
|
"""
|
|
def __init__(self, message=None):
|
|
logger.debug(message)
|
|
super(UnallowedMessage, self).__init__(message)
|
|
|
|
|
|
class MessageHandler:
|
|
|
|
def __init__(self, request):
|
|
self.req = request
|
|
self.name = None
|
|
self.payload = None
|
|
self.msg_type = None
|
|
|
|
def parse(self, msg, name):
|
|
"""Parses the message.
|
|
|
|
:param req: the original request
|
|
:param msg: a decoded json string with the incoming message
|
|
|
|
:raises InvalidMessage: if the message cannot be parsed or validated
|
|
"""
|
|
|
|
raise NotImplementedError
|
|
|
|
def reply(self, output):
|
|
"""Generates a reply.
|
|
|
|
:param req: the original request
|
|
:param output: a Python object that can be converted to JSON
|
|
"""
|
|
|
|
raise NotImplementedError
|