def __init__(self):
self.spec_path = os.path.normpath("%s/../specs/" % __file__)
self._initialize_conversation_for_monitoring()
#map principal to conversation_context
self.conversation_context = {}
self.parsed_conversation_protocols = {}
self.parser = ANTLRScribbleParser()
def __init__(self):
self.spec_path = os.path.normpath("%s/../specs/" %__file__)
self._initialize_conversation_for_monitoring()
#map principal to conversation_context
self.conversation_context = {}
self.parsed_conversation_protocols = {}
self.parser = ANTLRScribbleParser()
class ConversationMonitorInterceptor(BaseInternalGovernanceInterceptor):
def __init__(self):
self.spec_path = os.path.normpath("%s/../specs/" %__file__)
self._initialize_conversation_for_monitoring()
#map principal to conversation_context
self.conversation_context = {}
self.parsed_conversation_protocols = {}
self.parser = ANTLRScribbleParser()
def _initialize_conversation_for_monitoring(self):
#self.conversations_for_monitoring = {'bank':{'buy_bonds':'bank/local/BuyBonds_Bank.srt',
# 'new_account':'bank/local/NewAccount_Bank.srt'},
# 'trade':{'exercise':'bank/local/BuyBonds_Trade.srt'}
# }
self.conversations_for_monitoring = {'requester': 'rpc_generic/local/rpc_requester.srt',
'provider': 'rpc_generic/local/rpc_provider.srt'}
def outgoing(self, invocation):
#if invocation.args.has_key('process'):
#log.trace("ConversationMonitorInterceptor.outgoing: %s" % invocation.get_arg_value('process',invocation).name)
#else:
#log.trace("ConversationMonitorInterceptor.outgoing: %s" % invocation)
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_STARTED
conv_msg_type = invocation.headers.get('conv-msg-type', None)
self_principal = invocation.headers.get('sender-role', None) #TODO - should these be set to default values?
target_principal = invocation.headers.get('receiver-role', None)
op_type = LocalType.SEND;
if conv_msg_type and self_principal and target_principal:
# target_principal = invocation.get_message_receiver()
# op_type = LocalType.SEND;
self._check(invocation, op_type, self_principal, target_principal)
if invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] == GovernanceDispatcher.STATUS_STARTED:
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_COMPLETE
else:
self._report_error(invocation, GovernanceDispatcher.STATUS_SKIPPED, 'The message cannot be monitored since the conversation roles are not in the headers')
return invocation
def incoming(self, invocation):
#if invocation.args.has_key('process'):
#log.trace("ConversationMonitorInterceptor.incoming: %s" % invocation.get_arg_value('process',invocation).name)
#else:
#log.trace("ConversationMonitorInterceptor.incoming: %s" % invocation)
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_STARTED
conv_msg_type = invocation.headers.get('conv-msg-type', None)
self_principal = invocation.headers.get('receiver-role', None)
target_principal = invocation.headers.get('sender-role', None)
op_type = LocalType.RESV
if conv_msg_type and self_principal and target_principal:
#if self_principal:
# target_principal, sender_type = invocation.get_message_sender()
# target_principal_queue = invocation.get_message_sender_queue()
# op_type = LocalType.RESV;
#
# if target_principal=='Unknown':
# target_principal = target_principal_queue
# self._check(invocation, op_type, self_principal, target_principal)
# else: self._check(invocation, op_type, self_principal, target_principal, target_principal_queue)
self._check(invocation, op_type, self_principal, target_principal)
if invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] == GovernanceDispatcher.STATUS_STARTED:
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_COMPLETE
else:
self._report_error(invocation, GovernanceDispatcher.STATUS_SKIPPED, 'The message cannot be monitored since the conversation roles are not in the headers')
return invocation
'''
def _initialize_conversation_context(self, cid, role_spec, self_principal, target_principal, op):
parser = ANTLRScribbleParser()
res = parser.parse(os.path.join(self.spec_path,role_spec))
builder = parser.walk(res)
mapping = ConversationProvider.get_protocol_mapping(op)
return ConversationContext(builder, cid, [self_principal, target_principal], mapping)
'''
def _initialize_conversation_context(self, cid, role_spec, self_principal, target_principal, op):
#Cache the parsing of static protocol specifications
if not self.parsed_conversation_protocols.has_key(self_principal):
self.parsed_conversation_protocols[self_principal] = self.parser.parse(os.path.join(self.spec_path,role_spec))
builder = self.parser.walk(self.parsed_conversation_protocols[self_principal])
mapping = ConversationProvider.get_protocol_mapping(op)
return ConversationContext(builder, cid, [self_principal, target_principal], mapping)
def _get_control_conv_msg(self, invocation):
return invocation.get_header_value('conv-msg-type') & MSG_TYPE_MASKS.CONTROL
def _get_in_session_msg_type(self, invocation):
return invocation.get_header_value('conv-msg-type') & MSG_TYPE_MASKS.IN_SESSION
def _check(self, invocation, op_type, self_principal, target_principal):
operation = invocation.get_header_value('op', '')
cid = invocation.get_header_value('conv-id', 0)
conv_seq = invocation.get_header_value('conv-seq', 0)
conversation_key = self._get_conversation_context_key(self_principal, invocation)
# INITIALIZE FSM
if ((conv_seq == 1 and self._should_be_monitored(invocation, self_principal, operation)) and
not((conversation_key in self.conversation_context))):
role_spec = self._get_protocol_spec(self_principal, operation)
if not role_spec:
self._report_error(invocation, GovernanceDispatcher.STATUS_SKIPPED, 'The message cannot be monitored since the protocol specification was not found: %s')
else:
conversation_context = self._initialize_conversation_context(cid, role_spec,
self_principal, target_principal,
operation)
if conversation_context: self.conversation_context[conversation_key] = conversation_context
# CHECK
if (conversation_key in self.conversation_context):
conversation_context = self.conversation_context[conversation_key]
#target_role = conversation_context.get_role_by_principal(target_principal)
target_role = target_principal
#if target_principal_queue and target_role:
#conversation_context.set_role_mapping(target_role, target_principal_queue)
fsm = conversation_context.get_fsm()
control_conv_msg_type = self._get_control_conv_msg(invocation)
if (control_conv_msg_type == MSG_TYPE.ACCEPT):
transition = TransitionFactory.create(op_type, 'accept', target_role)
(msg_correct, error, should_pop)= self._is_msg_correct(invocation, fsm, transition)
if not msg_correct:
self._report_error(invocation, GovernanceDispatcher.STATUS_REJECT, error)
return
transition = TransitionFactory.create(op_type, operation, target_role)
#Check the message by running the fsm.
(msg_correct, error, should_pop)= self._is_msg_correct(invocation, fsm, transition)
if not msg_correct:
self._report_error(invocation, GovernanceDispatcher.STATUS_REJECT, error)
# Stop monitoring if msg is wrong or this is the response of the request that had started the conversation
if (should_pop) and (conversation_context.get_conversation_id() == cid):
self.conversation_context.pop(conversation_key)
def _is_msg_correct(self, invocation, fsm, transition):
details = ''
status = ''
try:
fsm.process(transition)
status = 'CORRECT'
if fsm.test_for_end_state(fsm.current_state):
return (True, None, True)
else:
return (True, None, False)
except ExceptionFSM as e:
status = 'WRONG'
details = e.value
return (False, e.value, True)
finally:
log.debug("""\n
----------------Checking message:-----------------------------------------------
Message is: =%s \n
Status: %s \n
Details: %s \n
--------------------------------------------------------------------------------
""", invocation.headers, status, details)
def _report_error(self, invocation, dispatcher_status, error):
cur_label = invocation.get_header_value('op', None)
if not cur_label: invocation.get_header_value('conv-id', 'Unknown')
msg_from, sender_type = invocation.get_message_sender()
err_msg = 'Conversation interceptor error for message %s from %s: %s' %(cur_label, msg_from, error)
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_ANNOTATION] = dispatcher_status
invocation.message_annotations[GovernanceDispatcher.CONVERSATION__STATUS_REASON_ANNOTATION] = err_msg
#log.debug("ConversationMonitorInterceptor error: %s", err_msg)
def _get_conversation_context_key(self, principal, invocation):
#initiating_conv_id = invocation.get_header_value('initiating-conv-id', None)
initiating_conv_id = invocation.get_header_value('conv-id', None)
# Note, one principal can play only one role, but in general the key should be: (conv_id, prinicpla.od, role)
key = (initiating_conv_id, principal)
return key
def _should_be_monitored(self, invocation, principal_name, operation):
#initiating_conv_id = invocation.get_header_value('initiating-conv-id', None)
#return ((principal_name in self.conversations_for_monitoring) and \
# (operation in self.conversations_for_monitoring[principal_name])) and \
# initiating_conv_id
return True
def _get_protocol_spec(self, role, operation ):
return self.conversations_for_monitoring[role]
class ConversationMonitorInterceptor(BaseInternalGovernanceInterceptor):
def __init__(self):
self.spec_path = os.path.normpath("%s/../specs/" % __file__)
self._initialize_conversation_for_monitoring()
#map principal to conversation_context
self.conversation_context = {}
self.parsed_conversation_protocols = {}
self.parser = ANTLRScribbleParser()
def _initialize_conversation_for_monitoring(self):
#self.conversations_for_monitoring = {'bank':{'buy_bonds':'bank/local/BuyBonds_Bank.srt',
# 'new_account':'bank/local/NewAccount_Bank.srt'},
# 'trade':{'exercise':'bank/local/BuyBonds_Trade.srt'}
# }
self.conversations_for_monitoring = {
'requester': 'rpc_generic/local/rpc_requester.srt',
'provider': 'rpc_generic/local/rpc_provider.srt'
}
def outgoing(self, invocation):
log.debug('I am in outgoing conversation interceptor!!!')
if invocation.args.has_key('process'):
log.debug("ConversationMonitorInterceptor.outgoing: %s" %
invocation.get_arg_value('process', invocation).name)
else:
log.debug("ConversationMonitorInterceptor.outgoing: %s" %
invocation)
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_STARTED
conv_msg_type = invocation.headers.get('conv-msg-type', None)
self_principal = invocation.headers.get(
'sender-role',
None) #TODO - should these be set to default values?
target_principal = invocation.headers.get('receiver-role', None)
op_type = LocalType.SEND
if conv_msg_type and self_principal and target_principal:
# target_principal = self._get_receiver(invocation)
# op_type = LocalType.SEND;
self._check(invocation, op_type, self_principal, target_principal)
if invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] == GovernanceDispatcher.STATUS_STARTED:
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_COMPLETE
else:
self._report_error(
invocation, GovernanceDispatcher.STATUS_SKIPPED,
'The message cannot be monitored since the conversation roles are not in the headers'
)
return invocation
def incoming(self, invocation):
log.debug('I am in incoming conversation interceptor!!!')
if invocation.args.has_key('process'):
log.debug("ConversationMonitorInterceptor.incoming: %s" %
invocation.get_arg_value('process', invocation).name)
else:
log.debug("ConversationMonitorInterceptor.incoming: %s" %
invocation)
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_STARTED
conv_msg_type = invocation.headers.get('conv-msg-type', None)
self_principal = invocation.headers.get('receiver-role', None)
target_principal = invocation.headers.get('sender-role', None)
op_type = LocalType.RESV
if conv_msg_type and self_principal and target_principal:
#if self_principal:
# target_principal = self._get_sender(invocation)
# target_principal_queue = self._get_sender_queue(invocation)
# op_type = LocalType.RESV;
#
# if target_principal=='Unknown':
# target_principal = target_principal_queue
# self._check(invocation, op_type, self_principal, target_principal)
# else: self._check(invocation, op_type, self_principal, target_principal, target_principal_queue)
self._check(invocation, op_type, self_principal, target_principal)
if invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] == GovernanceDispatcher.STATUS_STARTED:
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] = GovernanceDispatcher.STATUS_COMPLETE
else:
self._report_error(
invocation, GovernanceDispatcher.STATUS_SKIPPED,
'The message cannot be monitored since the conversation roles are not in the headers'
)
return invocation
'''
def _initialize_conversation_context(self, cid, role_spec, self_principal, target_principal, op):
parser = ANTLRScribbleParser()
res = parser.parse(os.path.join(self.spec_path,role_spec))
builder = parser.walk(res)
mapping = ConversationProvider.get_protocol_mapping(op)
return ConversationContext(builder, cid, [self_principal, target_principal], mapping)
'''
def _initialize_conversation_context(self, cid, role_spec, self_principal,
target_principal, op):
#Cache the parsing of static protocol specifications
if not self.parsed_conversation_protocols.has_key(self_principal):
self.parsed_conversation_protocols[
self_principal] = self.parser.parse(
os.path.join(self.spec_path, role_spec))
builder = self.parser.walk(
self.parsed_conversation_protocols[self_principal])
mapping = ConversationProvider.get_protocol_mapping(op)
return ConversationContext(builder, cid,
[self_principal, target_principal], mapping)
def _get_control_conv_msg(self, invocation):
return invocation.get_header_value(
'conv-msg-type') & MSG_TYPE_MASKS.CONTROL
def _get_in_session_msg_type(self, invocation):
return invocation.get_header_value(
'conv-msg-type') & MSG_TYPE_MASKS.IN_SESSION
def _check(self, invocation, op_type, self_principal, target_principal):
operation = invocation.get_header_value('op', '')
cid = invocation.get_header_value('conv-id', 0)
conv_seq = invocation.get_header_value('conv-seq', 0)
conversation_key = self._get_conversation_context_key(
self_principal, invocation)
# INITIALIZE FSM
if ((conv_seq == 1 and self._should_be_monitored(
invocation, self_principal, operation))
and not ((conversation_key in self.conversation_context))):
role_spec = self._get_protocol_spec(self_principal, operation)
if not role_spec:
self._report_error(
invocation, GovernanceDispatcher.STATUS_SKIPPED,
'The message cannot be monitored since the protocol specification was not found: %s'
)
else:
conversation_context = self._initialize_conversation_context(
cid, role_spec, self_principal, target_principal,
operation)
if conversation_context:
self.conversation_context[
conversation_key] = conversation_context
# CHECK
if (conversation_key in self.conversation_context):
conversation_context = self.conversation_context[conversation_key]
#target_role = conversation_context.get_role_by_principal(target_principal)
target_role = target_principal
#if target_principal_queue and target_role:
#conversation_context.set_role_mapping(target_role, target_principal_queue)
fsm = conversation_context.get_fsm()
control_conv_msg_type = self._get_control_conv_msg(invocation)
if (control_conv_msg_type == MSG_TYPE.ACCEPT):
transition = TransitionFactory.create(op_type, 'accept',
target_role)
(msg_correct, error,
should_pop) = self._is_msg_correct(invocation, fsm,
transition)
if not msg_correct:
self._report_error(invocation,
GovernanceDispatcher.STATUS_REJECT,
error)
return
transition = TransitionFactory.create(op_type, operation,
target_role)
#Check the message by running the fsm.
(msg_correct, error,
should_pop) = self._is_msg_correct(invocation, fsm, transition)
if not msg_correct:
self._report_error(invocation,
GovernanceDispatcher.STATUS_REJECT, error)
# Stop monitoring if msg is wrong or this is the response of the request that had started the conversation
if (should_pop) and (conversation_context.get_conversation_id()
== cid):
self.conversation_context.pop(conversation_key)
def _is_msg_correct(self, invocation, fsm, transition):
details = ''
status = ''
try:
fsm.process(transition)
status = 'CORRECT'
if fsm.test_for_end_state(fsm.current_state):
return (True, None, True)
else:
return (True, None, False)
except ExceptionFSM as e:
status = 'WRONG'
details = e.value
return (False, e.value, True)
finally:
log.debug(
"""\n
----------------Checking message:-----------------------------------------------
Message is: =%s \n
Status: %s \n
Details: %s \n
--------------------------------------------------------------------------------
""", invocation.headers, status, details)
def _report_error(self, invocation, dispatcher_status, error):
cur_label = invocation.get_header_value('op', None)
if not cur_label: invocation.get_header_value('conv-id', 'Unknown')
msg_from = self._get_sender(invocation)
err_msg = 'Conversation interceptor error for message %s from %s: %s' % (
cur_label, msg_from, error)
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_ANNOTATION] = dispatcher_status
invocation.message_annotations[
GovernanceDispatcher.
CONVERSATION__STATUS_REASON_ANNOTATION] = err_msg
log.debug("ConversationMonitorInterceptor error: %s", err_msg)
def _get_conversation_context_key(self, principal, invocation):
#initiating_conv_id = invocation.get_header_value('initiating-conv-id', None)
initiating_conv_id = invocation.get_header_value('conv-id', None)
# Note, one principal can play only one role, but in general the key should be: (conv_id, prinicpla.od, role)
key = (initiating_conv_id, principal)
return key
def _should_be_monitored(self, invocation, principal_name, operation):
#initiating_conv_id = invocation.get_header_value('initiating-conv-id', None)
#return ((principal_name in self.conversations_for_monitoring) and \
# (operation in self.conversations_for_monitoring[principal_name])) and \
# initiating_conv_id
return True
def _get_protocol_spec(self, role, operation):
return self.conversations_for_monitoring[role]
def _get_sender_queue(self, invocation):
sender_queue = invocation.get_header_value('reply-to', 'todo')
if (sender_queue == 'todo'):
return None
else:
index = sender_queue.find('amq')
if (index != -1): sender_queue = sender_queue[index:]
return sender_queue
def _get_sender(self, invocation):
sender_type = invocation.get_header_value('sender-type', 'Unknown')
if sender_type == 'service':
sender_header = invocation.get_header_value(
'sender-service', 'Unknown')
sender = invocation.get_service_name(sender_header)
else:
sender = invocation.get_header_value('sender', 'Unknown')
return sender
def _get_receiver(self, invocation):
receiver_header = invocation.get_header_value('receiver', 'Unknown')
receiver = invocation.get_service_name(receiver_header)
return receiver
