Confirmed users
133
edits
(Created page with "=Minion Task Engine= __NOTOC__ ==Overview== The Task Engine is responsible for: * Providing a REST based API * Handling requests from trusted components (eg the Web UI) * Schedul...") |
No edit summary |
||
Line 7: | Line 7: | ||
* Scheduling work across the available resources (ie plugins) | * Scheduling work across the available resources (ie plugins) | ||
* Persisting data | * Persisting data | ||
==API== | |||
This is at a very early stage, so is still fairly fluid.{| border="1" cellpadding="1" | |||
{| border="1" cellpadding="1" | |||
|- | |||
|- | |||
! Op !! URL !! Method !! Notes | |||
|- | |||
| GET || /pluginservices || get_plugin_services() || List all of the installed plugin services | |||
|- | |||
| GET || /plugins ||get_all_plugins() || List all of the plugins across all of the plugin services | |||
|- | |||
| PUT ||/pluginservice/create/<ps> ||add_plugin_service(ps) || Register a plugin service | |||
|- | |||
| DELETE ||/pluginservice/<ps> ||remove_plugin_service(ps) || Remove a plugin service | |||
|- | |||
| GET ||/plugin/<plugin>/<version>/template ||get_plugin_template(plugin, version) || Get the template for the specified plugin | |||
|- | |||
| GET ||/pluginservice/<ps>/info ||get_plugin_service_info(service_name) || Get the info about the plugin service | |||
|- | |||
| PUT ||/plugin/session/create/<plugin>/<version> ||create_plugin_session(plugin, version) || Create the specified plugin on any suitable plugin service | |||
|- | |||
| PUT || /pluginservice/<ps>/session/create/<plugin> <b>TODO</b> || create_plugin_service_session(service_name, plugin_name) || Create the specified plugin on the specified plugin service | |||
|- | |||
| GET ||/pluginservice/<ps>/sessions <b>TODO</b> || get_plugin_service_sessions(service_name) || Get the sessions for the plugin service | |||
|- | |||
| DELETE ||/pluginservice/<service_name>/session/<session> <b>TODO</b> ||terminate_plugin_service_session(service_name, session) || Terminate the session on the plugin service | |||
|- | |||
| GET ||/pluginservice/<service_name>/session/<session>/status ||get_plugin_service_session_status(service_name, session) || Get the plugin status | |||
|- | |||
| GET ||/pluginservice/<service_name>/session/<session>/states ||get_plugin_service_session_states(service_name, session) || Get the valid plugin states | |||
|- | |||
| PUT ||/pluginservice/<service_name>/session/<session>/state/<state> ||set_plugin_service_session_state(service_name, session, state) || Set the plugin state | |||
|- | |||
| <i>TBA</i> ||/pluginservice/<service_name>/session/<session>/config/<config> || set_plugin_service_session_config(service_name, session, config) || Set the full config | |||
|- | |||
| GET ||/pluginservice/<service_name>/session/<session>/config ||get_plugin_service_session_config(service_name, session) || Get the plugin config | |||
|- | |||
| PUT ||/pluginservice/<service_name>/session/<session>/value?key=<key>&value=<value> ||set_plugin_service_session_value(service_name, session, key, value) || Set the key and value specified in the query string | |||
|- | |||
| GET ||/pluginservice/<service_name>/session/<session>/results ||get_plugin_service_session_results(service_name, session) || Get the plugin results | |||
|} | |||
==Main Classes== | ==Main Classes== | ||
===TaskEngine=== | ===TaskEngine=== |