Changes between Version 8 and Version 9 of ZooWebSite/ZooServices/ZCFGReference


Ignore:
Timestamp:
Jan 16, 2011, 6:06:18 AM (10 years ago)
Author:
djay
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ZooWebSite/ZooServices/ZCFGReference

    v8 v9  
    1212
    1313'''The ZOO Service Configuration File is case sensitive.'''
     14
    1415== Main metadata informations ==
    1516
    16 The fist part in a ZOO Configuration contains the metadata informations relatives to the service. Note that the "name of your service", between bracket on the first line, have to be the exact same name as the function you defined in you service code.
     17The fist part in a ZOO Configuration contains the metadata informations relatives to the service. Note that the "name of your service", between bracket on the first line, have to be the exact same name as the function you defined in your services provider code.
    1718
    1819You can see bellow a description of the main metadata informations:
     
    3435== List of Inputs ==
    3536
    36 The list of inputs contains metadata information of each defined input and it is a {{{<DataInputs>}}} node.
     37The list of inputs contains metadata information of each supported input and they are grouped using a {{{<DataInputs>}}} node.
     38
     39Each input is defined as :
     40  * a name (between brackets as for the name of the service before)
     41  * various medata properties ({{{Title}}}, {{{Abstract}}}, {{{minOccurs}}} and {{{maxOccurs}}})
     42  * a Type Of Data node ([#TypeOfDataNodes description])
    3743
    3844A typical list of inputs ({{{<DataInputs>}}}) look like the following:
     
    5965== List of Outputs ==
    6066
    61 The list of outputs is similar to a list of inputs except it is designed as a {{{<DataOutputs>}}} node.
     67The list of outputs is very similar to a list of inputs except it is designed as a {{{<DataOutputs>}}} node.
    6268
    6369A typical {{{<DataOutputs>}}} node look like the following:
     
    126132=== !ComplexData node ===
    127133
    128 A ComplexData node get a {{{<Default>}}} and one or more {{{<Supported>}}} nodes depending on the number of supported format. A format is this set of properties : {{{mimeType}}}, {{{encoding}}} and optionaly {{{schema}}}.
     134A !ComplexData node get a {{{<Default>}}} and one or more {{{<Supported>}}} nodes depending on the number of supported format. A format is this set of properties : {{{mimeType}}}, {{{encoding}}} and optionaly {{{schema}}}.
    129135
    130 For output ComplexData nodes, you can add the {{{extension}}} property to define what extension to use to name the file when storing the result is required. Obviously, you'll have to add the extension to each supported format. You can also add the {{{asReference}}} property for each input to define if the output should be stored on server side per default. Note, that the client can always modify this behavior setting {{{asReference}}} attribute to {{{true}}} or {{{false}}} for this output in the {{{ResponseDocument}}}.
     136For output !ComplexData nodes, you can add the {{{extension}}} property to define what extension to use to name the file when storing the result is required. Obviously, you'll have to add the extension to each supported format. You can also add the {{{asReference}}} property for each input to define if the output should be stored on server side per default. Note, that the client can always modify this behavior setting {{{asReference}}} attribute to {{{true}}} or {{{false}}} for this output in the {{{ResponseDocument}}}.
    131137
    132 You can see above a sample ComplexData node for default {{{application/json}}} and {{{text/xml}}} mimeTypes support:
     138You can see above a sample !ComplexData node for default {{{application/json}}} and {{{text/xml}}} mimeTypes support:
    133139{{{
    134140#!Lineno

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png