autodocs_module_decision_engine

Module decision_engine Owner: jazz@imperial Work package: WPx.y Description: this uses logical inference to perform access control decisions

Method decision_engine.query_permission() Defined in: decision_engine 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

Is used in modules: api_wrapper, decision_engine, filesystem_wrapper, workflow_engine Responsible parties: james@mirriad, jazz@imperial, john@ovation Work packages: WPx.y

Method decision_engine.query_resources_available() Defined in: decision_engine Description: this queries whether resources are available for an action to be performed 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

Is used in modules: decision_engine, workflow_engine Responsible parties: james@mirriad, jazz@imperial Work packages: WPx.y

Method call: database.get_facts() Implemented in: database Called by: decision_engine Description: get generic facts, based on pattern matching Parameters: Name: f Type: fact_query Description: a query pattern for a simple fact, eg. 'available VMs = ?'

Returns: Name: f Type: A list of facts Description: a simple logical or numerical assertion in RDF-like notation

Responsible parties: jazz@imperial, neil@mediachannel, tim@mirriad Work packages: WPx.y

Method call: database.get_access_rule() Implemented in: database Called by: decision_engine Description: gets a specific access rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: a Type: access_rule Description: a logical rule restricting access to resources

Responsible parties: jazz@imperial, neil@mediachannel, sam@smoke Work packages: WPx.y