/[volute]/trunk/projects/grid/VOSI/VOSI-v1.0pr.html
ViewVC logotype

Diff of /trunk/projects/grid/VOSI/VOSI-v1.0pr.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1457 by rplante@ncsa.uiuc.edu, Tue May 10 20:24:45 2011 UTC revision 1458 by rplante@ncsa.uiuc.edu, Tue May 10 20:29:48 2011 UTC
# Line 55  Line 55 
55  <div class="head">  <div class="head">
56  <a href="http://www.ivoa.net/"><img alt="IVOA" src="http://www.ivoa.net/pub/images/IVOA_wb_300.jpg" width="300" height="169"/></a>  <a href="http://www.ivoa.net/"><img alt="IVOA" src="http://www.ivoa.net/pub/images/IVOA_wb_300.jpg" width="300" height="169"/></a>
57  <h1>IVOA Support Interfaces<br/>  <h1>IVOA Support Interfaces<br/>
58  Version 1.00-20101213</h1>  Version 1.00-20101206</h1>
59  <h2>IVOA WG Proposed Recommendation 2010 December 13 </h2>  <h2>IVOA WG Proposed Recommendation 2010 December 6 </h2>
60    
61  <dl>  <dl>
62    <dt>This version:</dt>    <dt>This version:</dt>
63    <dd><a href="http://www.ivoa.net/Documents/VOSI/20101213/">    <dd><a href="http://www.ivoa.net/Documents/VOSI/20101206/">
64        http://www.ivoa.net/Documents/VOSI/20101213/</a></dd>        http://www.ivoa.net/Documents/VOSI/20101206/</a></dd>
65    
66    <dt>Latest version:</dt>    <dt>Latest version:</dt>
67    <dd><a href="http://www.ivoa.net/Documents/latest/VOSI.html">    <dd><a href="http://www.ivoa.net/Documents/latest/VOSI.html">
# Line 159  Line 159 
159  </p>  </p>
160    
161  <h2><a name="conformance" id="conformance">Conformance related definitions</a></h2>  <h2><a name="conformance" id="conformance">Conformance related definitions</a></h2>
162  <p>The words "MUST", "SHALL", "SHOULD", "MAY", "RECOMMENDED", and "OPTIONAL" (in upper or lower case) used in this document are to be interpreted as described in IETF standard, RFC 2119 [RFC 2119].</p><p>  <p>The words "MUST", "SHALL", "SHOULD", "MAY", "RECOMMENDED", and "OPTIONAL" (in upper or lower case) used in this document are to be interpreted as described in IETF standard, RFC 2119 [0].</p><p>
163  The <strong>Virtual Observatory (VO)</strong> is a general term for a  The <strong>Virtual Observatory (VO)</strong> is a general term for a
164  collection of federated resources that can be used to conduct  collection of federated resources that can be used to conduct
165  astronomical research, education, and outreach. The <strong>International Virtual Observatory Alliance (IVOA)</strong> is a global collaboration of separately funded projects to develop standards and infrastructure that enable VO applications. The International Virtual Observatory (IVO) application is an application that takes advantage of IVOA standards and infrastructure to provide some VO service.  astronomical research, education, and outreach. The <strong>International Virtual Observatory Alliance (IVOA)</strong> is a global collaboration of separately funded projects to develop standards and infrastructure that enable VO applications. The International Virtual Observatory (IVO) application is an application that takes advantage of IVOA standards and infrastructure to provide some VO service.
# Line 174  Line 174 
174  <li><a href="#contents">Contents</a></li>  <li><a href="#contents">Contents</a></li>
175  <li><a href="#sec1">1. Introduction</a></li>  <li><a href="#sec1">1. Introduction</a></li>
176  <ul class="toc"><li><a href="#sec1_1">1.1 The role in the IVOA Architecture</a></li></ul>  <ul class="toc"><li><a href="#sec1_1">1.1 The role in the IVOA Architecture</a></li></ul>
177  <li><a href="#sec2">2. Interfaces bindings</a></li>  <li><a href="#sec2">2. Interface bindings</a></li>
178  <li><a href="#sec3">3. Metadata specification</a>  <li><a href="#sec3">3. Metadata specification</a></li>
179          <ul class="toc">          <ul class="toc">
180          <li><a href="#sec3_1">3.1 Capability metadata</a></li>          <li><a href="#sec3_1">2.1 Capability metadata</a></li>
181          <li><a href="#sec3_2">3.2 Non-service metadata (non-normative)</a></li>          <li><a href="#sec3_2">2.2 Non-service metadata (non-normative)</a></li>
182          <li><a href="#sec3_3">3.3 Availability metadata</a></li>          <li><a href="#sec3_3">2.3 Availability metadata</a></li>
183          <li><a href="#sec3_4">3.4 Table metadata</a></li>          <li><a href="#sec3_4">2.4 Table metadata</a></li>
184          </ul></li>          </ul>
185  <li><a href="#sec4">4. Registration of VOSI endpoints</a></li>  <li><a href="#sec4">4. Registration of VOSI endpoints</a></li>
186  <li><a href="#sec5">5. Example VOSI responses</a></li>  <li><a href="#sec5">5. Example VOSI responses</a></li>
187  <br/>  <br/>
# Line 241  Line 241 
241  provide some of this metadata itself; this allows a registry to pull  provide some of this metadata itself; this allows a registry to pull
242  the metadata from the service rather than relying on a human to  the metadata from the service rather than relying on a human to
243  provide it (e.g. by typing the data into a registration form  provide it (e.g. by typing the data into a registration form
244  manually).  This mechanism can aake it easier to collect highly  manually).  This mechanism can make it easier to collect highly
245  detailed metadata (e.g. descriptions of columns in a catalog) that  detailed metadata (e.g. descriptions of columns in a catalog) that
246  might not be practically provided otherwise.  As some of this metadata  might not be practically provided otherwise.  As some of this metadata
247  describes the service interface and how it behaves, other applications  describes the service interface and how it behaves, other applications
# Line 249  Line 249 
249  Even when the service is "discovered" through some means other than a  Even when the service is "discovered" through some means other than a
250  registry, an application can still understand how to use the service  registry, an application can still understand how to use the service
251  by querying for this information directly.    by querying for this information directly.  
252  <p>  </p>
253    
254  <p>  <p>
255  Once a user discovers data and services of interest, she will want to  Once a user discovers data and services of interest, she will want to
# Line 262  Line 262 
262  ecosystem.  ecosystem.
263  </p>  </p>
264    
265    
266  <h2><a name="sec2">2. Interface bindings</a></h2>  <h2><a name="sec2">2. Interface bindings</a></h2>
267  <p>The standard interface returns metadata without changing the  <p>The standard interface returns metadata without changing the
268  state of the service with which it is associated. This could, in principle, be  state of the service with which it is associated. This could, in principle, be
# Line 382  Line 383 
383     characterized by additional metadata provided by a standard XML     characterized by additional metadata provided by a standard XML
384      schema extension of <i>Capability</i> for that protocol. The extension metadata is enabled by      schema extension of <i>Capability</i> for that protocol. The extension metadata is enabled by
385     adding a <i>xsi:type</i> attribute to the <i>capability</i> element set to the     adding a <i>xsi:type</i> attribute to the <i>capability</i> element set to the
386     <i>Capability</i> sub-type value defined in the extension schema for that protocol (see the examples in <a href="#sec5">section 5</a> below).  </dd>     <i>Capability</i> sub-type value defined in the extension schema for that protocol (see example below).  </dd>
387  </dl>  </dl>
388  </td></tr></tbody></table>  </td></tr></tbody></table>
389  </blockquote>  </blockquote>
# Line 390  Line 391 
391    
392  <p>  <p>
393  The VOResource list of capabilities should include capabilities describing VOSI  The VOResource list of capabilities should include capabilities describing VOSI
394  endpoints as specified in <a href="#sec4">section 4</a>.  endpoints as specified in section 4.
395  </p>  </p>
396    
397    
# Line 437  Line 438 
438  <h3><a name="sec3_4">3.4 Table metadata</a></h3>  <h3><a name="sec3_4">3.4 Table metadata</a></h3>
439  <p>  <p>
440  Some services deal with tabular data. These data may be the target of  Some services deal with tabular data. These data may be the target of
441  ADQL queries, as in TAP [14], or they may be the output of other operations, as in SIAP queries. In each case, it is useful if the service describes the details of the tables concerned. It is more useful if this description can be captured in the resource registry.</p><p>  ADQL queries, as in TAP [7], or they may be the output of other operations, as in SIAP queries. In each case, it is useful if the service describes the details of the tables concerned. It is more useful if this description can be captured in the resource registry.</p><p>
442  The <i>VODataService</i> standard [<a href="#ref:vos">2</a>] defines XML elements for describing a set of tables. These elements can be included in a resource document for a service.</p><p>  The <i>VODataService</i> standard [<a href="#ref:14">14</a>] defines XML elements for describing a set of tables. These elements can be included in a resource document for a service.</p><p>
443  A service which uses tables in its interface should define a VOSI  A service which uses tables in its interface should define a VOSI
444  endpoint from which table metadata can be read. The table metadata  endpoint from which table metadata can be read. The table metadata
445  shall be represented as an XML document  of which the root element is  shall be represented as an XML document  of which the root element is
# Line 466  Line 467 
467  An availability endpoint shall be represented by an element named  An availability endpoint shall be represented by an element named
468  <i>capability</i>, of type  <i>capability</i>, of type
469  <i>{http://www.ivoa.net/xml/VOResource/v1.0}Capability</i> (defined by  <i>{http://www.ivoa.net/xml/VOResource/v1.0}Capability</i> (defined by
470  the standard VOResource XML schema [<a href="ref:vor">1</a>]). The  the standard VOResource XML schema [<a href="ref:12">12</a>]). The
471  value of the <i>standardID</i> attribute of the <i>capability</i>  value of the <i>standardID</i> attribute of the <i>capability</i>
472  shall be <i>ivo://ivoa.net/std/VOSI#availability</i>.  shall be <i>ivo://ivoa.net/std/VOSI#availability</i>.
473  </p>  </p>
# Line 491  Line 492 
492  <i>accessURL</i> element must set the <i>use</i> attribute to "full".  <i>accessURL</i> element must set the <i>use</i> attribute to "full".
493  Furthermore, for the REST binding, this document recommends using the  Furthermore, for the REST binding, this document recommends using the
494  <i>{http://www.ivoa.net/xml/VODataService/v1.1}ParamHTTP</i> interface  <i>{http://www.ivoa.net/xml/VODataService/v1.1}ParamHTTP</i> interface
495  type to encode VOSI endpoints (see examples given in  type to encode VOSI endpoints (see example given in section 2.1).
 <a href="#sec5">section 5</a>).  
496  </p>  </p>
497    
498    
# Line 773  Line 773 
773    
774  <a name="appA3">  <a name="appA3">
775  <h3>A.3.  The Complete VOSITables Schema</h3></a>  <h3>A.3.  The Complete VOSITables Schema</h3></a>
   
776  <pre>  <pre>
777  &lt;xsd:schema targetNamespace="http://www.ivoa.net/xml/VOSICapabilities/v1.0"  &lt;xsd:schema targetNamespace="http://www.ivoa.net/xml/VOSICapabilities/v1.0"
778              xmlns:tns="http://www.ivoa.net/xml/VOSICapabilities/v1.0"    xmlns:tns="http://www.ivoa.net/xml/VOSICapabilities/v1.0"
779              xmlns:vr="http://www.ivoa.net/xml/VOResource/v1.0"    xmlns:vr="http://www.ivoa.net/xml/VOResource/v1.0"
780              xmlns:xsd="http://www.w3.org/2001/XMLSchema"    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
781              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
782              elementFormDefault="qualified"    elementFormDefault="qualified"
783              attributeFormDefault="unqualified"    attributeFormDefault="unqualified"
784              version="1.0rc1"&gt;    version="1.0">
785    
786    &lt;xsd:annotation&gt;    &lt;xsd:annotation>
787       &lt;xsd:documentation&gt;      &lt; xsd:documentation>
788         A schema for formatting table metadata as returned by a       A schema for formatting table metadata as returned by a
789         tables resource, defined by the IVOA Support Interfaces       tables resource, defined by the IVOA Support Interfaces
790         specification (VOSI).       specification (VOSI).
791         See http://www.ivoa.net/Documents/latest/VOSI.html.         See http://www.ivoa.net/Documents/latest/VOSI.html.  
792       &lt;/xsd:documentation&gt;      &lt;/xsd:documentation>
793    &lt;/xsd:annotation&gt;    &lt;/xsd:annotation>
794    
795    &lt;xsd:import namespace="http://www.ivoa.net/xml/VODataService/v1.1"    &lt;xsd:import namespace="http://www.ivoa.net/xml/VODataService/v1.1"
796                schemaLocation="http://www.ivoa.net/xml/VODataService/v1.1" /&gt;      schemaLocation="http://www.ivoa.net/xml/VODataService/v1.1" />
797    
798    &lt;!--    &lt;!--
799      -  the root element for a VOSI table metadata (section 3.4)      -  the root element for a VOSI table metadata (section 3.4)
800      --&gt;      -->
801    &lt;xsd:element name="tableset" type="vs:TableSet" &gt;    &lt;xsd:element name="tableset" type="vs:TableSet" >
802       &lt;xsd:annotation&gt;      &lt;xsd:annotation>
803         &lt;xsd:documentation&gt;        &lt;xsd:documentation>
804           A description of the table metadata supported by the          A description of the table metadata supported by the
805           service associated with a VOSI-enabled resource.          service associated with a VOSI-enabled resource.
806         &lt;/xsd:documentation&gt;        &lt;/xsd:documentation>
807       &lt;/xsd:annotation&gt;      &lt;/xsd:annotation>
808    &lt;/xsd:element&gt;    &lt;/xsd:element>
809    
810  &lt;/xsd:schema&gt;  &lt;/xsd:schema>
811  </pre>  </pre>
812    <br/>
813  <h2><a name="appB">Applendix B: Changes from previous versions</a></h2>  <h2><a name="appB">Applendix B: Changes from previous versions</a></h2>
814    
815  <h4>Changes since PR-20100311</h4>  <h4>Changes since PR-20100311</h4>
# Line 844  Line 843 
843  <h2><a name="ref">References</a></h2>  <h2><a name="ref">References</a></h2>
844    
845  <dl>  <dl>
846    <dt> <a name="ref:vor">[1]</a> </dt>  
847    
848      <dt> <a name="ref:0">[0]</a> </dt>
849      <dd> <cite>
850           <a href="http://www.ietf.org/rfc/rfc2119.txt">RFC 2119</a></cite>,
851           <code>http://www.ietf.org/rfc/rfc2119.txt</code>
852           </dd>
853    
854      
855      <dt> <a name="ref:1">[1]</a> </dt>
856      <dd> <cite>
857           <a href="http://www.w3.org/TR/soap">Simple Object Access
858      Protocol (SOAP)</a></cite>,
859           <code>http://www.w3.org/TR/soap</code>
860           </dd>
861    
862          
863      <dt> <a name="ref:2">[2]</a> </dt>
864      <dd> <cite>
865           <a href="http://voservices.net">Footprint and spectrum services</a></cite>,
866           <code>http://voservices.net</code>
867           </dd>
868    
869      <dt> <a name="ref:3">[3]</a> </dt>
870      <dd> <cite>
871           <a href="http://openskyquery.net">Skynodes and Open SkyQuery</a></cite>,
872           <code>http://openskyquery.net</code>
873           </dd>
874    
875      <dt> <a name="ref:4">[4]</a></dt><dd>Benson, K., Plante, R., Auden, E.,
876      Graham, M., Greene, G., Hill, M., Linde, T., Morris, D., O'Mullane,
877      W., Rixon, G., St&eacute;b&eacute;, A., Andrews, K., 2009, <cite>
878           <a href="http://www.ivoa.net/Documents/RegistryInterface">IVOA
879      Registry Interfaces</a></cite>, v1.0, IVOA Recommendation,
880           <code>http://www.ivoa.net/Documents/RegistryInterface</code>
881           </dd>
882    
883      <dt> <a name="ref:5">[5]</a> </dt>
884      <dd> <cite>
885           <a href="http://cdsweb.u-strasbg.fr/cdsws.gml">CDS web services</a></cite>,
886           <code>http://cdsweb.u-strasbg.fr/cdsws.gml</code>
887           </dd>
888    
889      <dt> <a name="ref:6">[6]</a> </dt>
890      <dd> <cite>
891           <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">REpresentational State Transfer (REST)</a></cite>,
892           <code>http://en.wikipedia.org/wiki/Representational_State_Transfer</code>
893           </dd>
894    
895      <dt> <a name="ref:7">[7]</a> </dt>
896      <dd> Dowler, P., Rixon, G., Tody, D., 2010, <cite>
897           <a
898      href="http://www.ivoa.net/Documents/TAP/20100327/REC-TAP-1.0.html">Table
899      Access Protocol</a></cite>, v1.0, IVOA Recommmendation,
900           <code>http://www.ivoa.net/Documents/TAP/20100327/REC-TAP-1.0.html</code>
901           </dd>
902    
903      <dt> <a name="ref:8">[8]</a> </dt>
904      <dd> Graham, M., Morris, D., Rixon, G., Dowler, P., Schaaff, A.,
905      Tody, D., 2010, <cite>
906           <a
907      href="http://www.ivoa.net/Documents/VOSpace/20101112/WD-VOSpace-2.0-20101112.html">VOSpace
908      specification</a></cite>, v2.00, IVOA Working Draft,
909           <code>http://www.ivoa.net/Documents/VOSpace/20101112/WD-VOSpace-2.0-20101112.html</code>
910           </dd>
911    
912      <dt> <a name="ref:9">[9]</a> </dt>
913      <dd> Grid and Web Services Working Group, 2010, <cite>
914           <a
915      href="http://www.ivoa.net/Documents/VOSI/20100311/PR-VOSI-1.0-20100311.html">IVOA
916      Support Interfaces</a></cite>, v1.00, IVOA Proposed Recommendation,
917          <code>http://www.ivoa.net/Documents/VOSI/20100311/PR-VOSI-1.0-20100311.html</code>
918           </dd>
919    
920      <dt> <a name="ref:10">[10]</a> </dt>
921      <dd> <cite>
922           <a href="http://www.w3.org/TR/WSDL">Web Services Description Language</a></cite>,
923           <code>http://www.w3.org/TR/WSDL</code>
924           </dd>
925    
926      <dt> <a name="ref:11">[11]</a> </dt>
927      <dd> Arviset, C., Gaudet, S., IVOA Technical Coordination Group,
928      2010, <cite>
929           <a
930      href="http://www.ivoa.net/Documents/Notes/IVOAArchitecture/20101123/IVOAArchitecture-1.0-20101123.pdf">IVOA
931      Architecture</a></cite>, v1.0, IVOA Note,
932           <code>http://www.ivoa.net/Documents/Notes/IVOAArchitecture/20101123/IVOAArchitecture-1.0-20101123.pdf</code>
933           </dd>
934    
935      <dt> <a name="ref:12">[12]</a> </dt>
936    <dd> Plante, R., Benson, K., Graham, M., Greene,    <dd> Plante, R., Benson, K., Graham, M., Greene,
937         G., Harrison, P., Lemson, G., Linde, T., Rixon,         G., Harrison, P., Lemson, G., Linde, T., Rixon,
938         G., St&eacute;b&eacute;, A. 2008, <cite>         G., St&eacute;b&eacute;, A., 2008, <cite>
939         <a href="http://www.ivoa.net/Documents/cover/VOResource-20080222.html">         <a href="http://www.ivoa.net/Documents/cover/VOResource-20080222.html">
940         VOResource: an XML Encoding Schema for Resource Metadata</a></cite>,         VOResource: an XML Encoding Schema for Resource Metadata</a></cite>,
941         v1.03, IVOA Recommendation,         v1.03, IVOA Recommendation,
942         <code>http://www.ivoa.net/Documents/cover/VOResource-20080222.html</code>         <code>http://www.ivoa.net/Documents/cover/VOResource-20080222.html</code>
943         </dd>         </dd>
944    
945    <dt> <a name="ref:vos">[2]</a> </dt>    <dt> <a name="ref:13">[13]</a> </dt>
946    <dd> Plante, R., St&eacute;b&eacute;, A., Benson, K., Dowler, P.,    <dd> Hanisch, R., IVOA Registry Working Group, NVO Metadata Working
947         Graham, M., Greene, G., Harrison, P., Lemson, G., Linde, T.,    Group, 2007, <cite>
948         Rixon, G. 2008, <cite>         <a
949         <a href="http://www.ivoa.net/Documents/VODataService/20090903/">    href="http://www.ivoa.net/Documents/REC/ResMetadata/RM-20070302.html">Resource
950         VODataService: a VOResource Schema Extension for Describing    Metadata for the Virtual Observatory</a></cite>, v.1.12, IVOA Recommendation
951         Collections and Services</a></cite>,         <code>http://www.ivoa.net/Documents/REC/ResMetadata/RM-20070302.html</code>
        v1.1, IVOA Proposed Recommendation,  
        <code>http://www.ivoa.net/Documents/VODataService/20090903/</code>  
952         </dd>         </dd>
953    
954      <dt> <a name="ref:14">[14]</a> </dt>
955      <dd>Plante, R., St&eacute;b&eacute;, A., Benson, K., Dowler, P., Graham, M., Greene,
956           G., Harrison, P., Lemson, G., Linde, T., Rixon,
957           G., IVOA Registry Working Group, 2010, <cite>
958           <a href="http://www.ivoa.net/Documents/VODataService/20100916/PR-VODataService-1.1-20100916.html">VODataService: a VOResource Schema Extension
959      for Describing Collections and Services</a></cite>, v1.1, IVOA
960      Proposed Recommendation,
961           <code>http://www.ivoa.net/Documents/VODataService/20100916/PR-VODataService-1.1-20100916.html</code>
962           </dd>
963    
964  </dl>  </dl>
965    
966    

Legend:
Removed from v.1457  
changed lines
  Added in v.1458

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26