autodocs_module_api_wrapper

Module api_wrapper Owner: john@ovation Work package: WPx.y Description: this provides filtered access to cloud API services on behalf of workflows and other end-user processes

Method api_wrapper.do_api_call() Defined in: api_wrapper Description: this provides filtered access to cloud API calls Parameters: Name: x Type: XML_query Description: an XML-formatted query

Returns: Name: x Type: XML_result Description: an XML-formatted result

Is used in modules: api_wrapper, end_user_application Responsible parties: john@ovation, [email protected] Work packages: WPx.y, none

Method call: decision_engine.query_permission() Implemented in: decision_engine Called by: api_wrapper Description: this queries whether an action is permitted to be performed, based on the facts available to the inference engine Parameters: Name: a Type: action_spec Description: a specification of an action to be performed

Returns: Name: d Type: decision Description: a yes/no decision, likely accompanied by metadata

Responsible parties: james@mirriad, jazz@imperial, john@ovation Work packages: WPx.y

Method call: cloud.do_api_call() Implemented in: cloud Called by: api_wrapper Description: actually performs a real cloud API operation Parameters: Name: x Type: XML_query Description: an XML-formatted query

Returns: Name: x Type: XML_result Description: an XML-formatted result

Responsible parties: james@mirriad, john@ovation, poonam@imperial Work packages: WPx.y

Method call: message_bus.send_message() Implemented in: message_bus Called by: api_wrapper Description: sends a message to the message switch Parameters: Name: m Type: message Description: a non-specific message

Returns: None Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: message_bus.get_message() Implemented in: message_bus Called by: api_wrapper Description: called (possibly implicitly) by other modules to receive a message from the message switch Parameters: None Returns: Name: m Type: message Description: a non-specific message

Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y