Difference between revisions of "GFeed-Service"
(→HTTP Interface) |
(→Get report) |
||
| Line 37: | Line 37: | ||
In order to get the history of submitted executions clients can perform a '''GET''' HTTP method on ''<BASE_URL>/execution''. The response is a JSON array of reports referring to submitted executions. | In order to get the history of submitted executions clients can perform a '''GET''' HTTP method on ''<BASE_URL>/execution''. The response is a JSON array of reports referring to submitted executions. | ||
===Get report=== | ===Get report=== | ||
| − | In order to get a report for a specific execution clients can perform a '''GET''' HTTP method on ''<BASE_URL>/execution/<EXECUTION_ID>'', where <EXECUTUION_ID> is the id returned from submission method. The following is a report example. | + | In order to get a report for a specific execution clients can perform a '''GET''' HTTP method on ''<BASE_URL>/execution/<EXECUTION_ID>'', where <EXECUTUION_ID> is the id returned from submission method. |
| + | Aim of this method is to monitor the outcome of a submitted execution (Asynch logic). | ||
| + | |||
| + | Please keep in mind that detailed reports are provided as a text file, accessible at '''reportUrl'''. | ||
| + | The following is a report example : | ||
| + | |||
| + | <source lang="json"> | ||
| + | { | ||
| + | "id": 4, | ||
| + | "collectors": [ | ||
| + | "DATAMINER_ALGORITHMS_COLLECTOR" | ||
| + | ], | ||
| + | "catalogues": [ | ||
| + | "GCAT" | ||
| + | ], | ||
| + | "callerEncryptedToken": ..., | ||
| + | "callerIdentity": ..., | ||
| + | "callerContext": ..., | ||
| + | "status": "SUCCESS", | ||
| + | "reportUrl": ..., | ||
| + | "startTime": ..., | ||
| + | "endTime": ... | ||
| + | } | ||
| + | </source> | ||
Revision as of 17:36, 20 May 2019
Aim of this service is to describe the implementation of gFeed-Service (for more information refer to GFeed).
Contents
Architecture
Deployment
Plugins
Plugins are expected to be found in the service classpath. They are typically distributed as uber-jar and their deployment depends on the hosting container.
To see a complete list of available plugins implemetations please refer to gFeed-Plugins
IS Requirements
The following is a list of minimal requirements for the execution of gFeed Service. Please keep in mind that depending on deployed plugins these requirements may not be enough.
- Database : the service needs a dedicated DB for its logic and looks in the current context for a DB registered as Service Endpoint with
- Category : Database
- Name : Feeder_DB
- Common configuration : the service loads default plugins configurations from the IS by lookig for a Generic Resource registered as
- Secondary type : configuration
- Name : gcat-feeder
HTTP Interface
Following is a list of methods exposed by gFeed HTTP interface. All methods require authentication so keep in mind that a gcube-token is expected. In this section <BASE_URL> stands for http(s)://<HOSTNODE>/gCat-Feeder/gcube/service/ where <HOSTNODE> should be determined by querying the gCube Information System.
Capabilities
Get available collectors
In order to get information on available collectors clients can perform a GET HTTP method on <BASE_URL>/capabilities/collectors. The response is a JSON representation of available collectors.
Get available controllers
In order to get information on available controllers clients can perform a GET HTTP method on <BASE_URL>/capabilities/controllers. The response is a JSON representation of available controllers.
Executions
Submission
Get submission history
In order to get the history of submitted executions clients can perform a GET HTTP method on <BASE_URL>/execution. The response is a JSON array of reports referring to submitted executions.
Get report
In order to get a report for a specific execution clients can perform a GET HTTP method on <BASE_URL>/execution/<EXECUTION_ID>, where <EXECUTUION_ID> is the id returned from submission method. Aim of this method is to monitor the outcome of a submitted execution (Asynch logic).
Please keep in mind that detailed reports are provided as a text file, accessible at reportUrl. The following is a report example :
Invalid language.
You need to specify a language like this: <source lang="html4strict">...</source>
Supported languages for syntax highlighting:
4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript, actionscript3, ada, aimms, algol68, apache, applescript, arm, asm, asp, asymptote, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, caddcl, cadlisp, cfdg, cfm, chaiscript, chapel, cil, clojure, cmake, cobol, coffeescript, cpp, csharp, css, cuesheet, d, dart, dcl, dcpu16, dcs, delphi, diff, div, dos, dot, e, ecmascript, eiffel, email, epc, erlang, euphoria, ezt, f1, falcon, fo, fortran, freebasic, freeswitch, fsharp, gambas, gdb, genero, genie, gettext, glsl, gml, gnuplot, go, groovy, gwbasic, haskell, haxe, hicest, hq9plus, html4strict, html5, icon, idl, ini, inno, intercal, io, ispfpanel, j, java, java5, javascript, jcl, jquery, kixtart, klonec, klonecpp, latex, lb, ldif, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, mmix, modula2, modula3, mpasm, mxml, mysql, nagios, netrexx, newlisp, nginx, nimrod, nsis, oberon2, objc, objeck, ocaml, octave, oobas, oorexx, oracle11, oracle8, oxygene, oz, parasail, parigp, pascal, pcre, per, perl, perl6, pf, php, pic16, pike, pixelbender, pli, plsql, postgresql, postscript, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, pys60, python, q, qbasic, qml, racket, rails, rbs, rebol, reg, rexx, robots, rpmspec, rsplus, ruby, rust, sas, scala, scheme, scilab, scl, sdlbasic, smalltalk, smarty, spark, sparql, sql, standardml, stonescript, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, upc, urbi, uscript, vala, vb, vbnet, vbscript, vedit, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xbasic, xml, xpp, yaml, z80, zxbasic
{
"id": 4,
"collectors": [
"DATAMINER_ALGORITHMS_COLLECTOR"
],
"catalogues": [
"GCAT"
],
"callerEncryptedToken": ...,
"callerIdentity": ...,
"callerContext": ...,
"status": "SUCCESS",
"reportUrl": ...,
"startTime": ...,
"endTime": ...
}
