server-reference.lyx.svn-base

由国外的一个著名的geonetwork修改而来

      <siteId>0619cc50-708b-11da-8202-000d9335906e</siteId>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <icon>/geonetwork/images/logos/
\end_layout

\begin_layout LyX-Code

\size footnotesize
                        0619cc50-708b-11da-8202-000d9335906e.png</icon>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <host>www.myhost.org</host>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <port/>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <servlet>myservlet</servlet>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <metadata>23</metadata>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </node>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</knownNodes>
\end_layout

\end_inset


\end_layout

\begin_layout Section
xml.forward
\end_layout

\begin_layout Standard
This is just a router service.
 It is used by Javascript code to connect to a remote host because a Javascript
 program cannot access a machine other than its server.
 For example, it is used by the harvesting web interface to query a remote
 host and retrieve the list of site ids.
\end_layout

\begin_layout Subsection*
Request
\end_layout

\begin_layout Standard
The service's request has this form:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <url>...</url>
\end_layout

\begin_layout LyX-Code
   
\size footnotesize
<params>...</params>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</knownNodes>
\end_layout

\end_inset


\end_layout

\begin_layout Standard
where:
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
url
\series default
 Indicates the remote url to connect to.
 Usually points to a GeoNetwork's xml service
\end_layout

\begin_layout List
\labelwidthstring 00.00.0000

\series bold
params
\series default
 This is just a container for the request that must be executed remotely.
\end_layout

\begin_layout Standard
Example:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <url>http:///mynode.org:8080/geonetwork/srv/en/xml.info</url>
\end_layout

\begin_layout LyX-Code
   
\size footnotesize
<params>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <type>site<type>
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </params>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</request>
\end_layout

\end_inset


\end_layout

\begin_layout Subsection*
Response
\end_layout

\begin_layout Standard
The response is just the response of the remote service.
\end_layout

\begin_layout Chapter
Harvesting services
\end_layout

\begin_layout Section
Introduction
\end_layout

\begin_layout Standard
This chapter provides a detailed explanation of the GeoNetwork's harvesting
 services.
 These services allow a complete control over the harvesting behaviour.
 They are used by the web interface and can be used by any other client.
\end_layout

\begin_layout Section
xml.harvesting.get
\end_layout

\begin_layout Standard
Retrieves information about one or all configured harvesting nodes.
\end_layout

\begin_layout Subsection*
Request
\end_layout

\begin_layout Standard
Called with no parameters returns all nodes.
 Example:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<request/>
\end_layout

\end_inset


\end_layout

\begin_layout Standard
Otherwise, an 
\family sans
\series bold
id
\family default
\series default
 parameter can be specified:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<request>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <id>123</id>
\end_layout

\begin_layout LyX-Code

\size footnotesize
</request>
\end_layout

\end_inset


\end_layout

\begin_layout Subsection*
Response
\end_layout

\begin_layout Standard
When called with no parameters the service provide its output inside a 
\family sans
\series bold
nodes
\family default
\series default
 container.
 You get as many 
\family sans
\series bold
node
\family default
\series default
 elements as are configured.
 For example:
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<nodes>
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <node id="125" name="test 1" type="geonetwork">
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <site>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <host>localhost</host>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <port>8080</port>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <servlet>geonetwork</servlet>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <account>         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <use>true</use>         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <username />         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <password />       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         </account>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </site>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <searches>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <search>         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <freeText />         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <title />         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <abstract />         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <keywords />         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <digital>false</digital>         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <hardcopy>false</hardcopy>         
\end_layout

\begin_layout LyX-Code

\size footnotesize
            <siteId>0619cc50-708b-11da-8202-000d9335906e</siteId>      
 
\end_layout

\begin_layout LyX-Code

\size footnotesize
         </search>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </searches>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <options>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <every>90</every>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <createGroups>true</createGroups>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <oneRunOnly>false</oneRunOnly>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <status>inactive</status>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </options>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <info>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <lastRun />     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </info>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </node> 
\end_layout

\begin_layout LyX-Code

\size footnotesize
</nodes> 
\end_layout

\end_inset


\end_layout

\begin_layout Standard
If you specify an id, you get a response like this (for a web folder node):
\end_layout

\begin_layout Standard
\begin_inset Box Boxed
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open

\begin_layout LyX-Code

\size footnotesize
<node id="165" name="test" type="webFolder">   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <site>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <url>http://www.mynode.org/metadata</url>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <account>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <use>true</use>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <username>admin</username>       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <password>admin</password>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </account>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </site>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <options>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <every>90</every>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <oneRunOnly>false</oneRunOnly>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <structure>false</structure>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <validate>true</validate>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <status>inactive</status>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </options>   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <privileges>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <group id="0">       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <operation name="view" />     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </group>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <group id="14">       
\end_layout

\begin_layout LyX-Code

\size footnotesize
         <operation name="download" />     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      </group>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </privileges>    
\end_layout

\begin_layout LyX-Code

\size footnotesize
   <info>     
\end_layout

\begin_layout LyX-Code

\size footnotesize
      <lastRun />   
\end_layout

\begin_layout LyX-Code

\size footnotesize
   </info> 
\end_layout

\begin_layout LyX-Code

\size footnotesize
</node> 
\end_layout

\begin_layout LyX-Code

\end_layout

\end_inset


\end_layout

\begin_layout Standard
The node's structure is described in the next two services.
 What are missing are the following elements:
\end_layout

\begin_layout Itemize

\series bold
info
\series default
 : A container for general information.
\end_layout

\begin_deeper
\begin_layout Itemize

\family sans
\series bold
lastRun
\family default
\series default
 (
\emph on
string
\emph default
) : The lastRun element will be filled as soon as the harvester starts harvestin
g from this entry.
 The value is the 
\end_layout

\begin_layout Itemize

\series bold
running
\series default
 (boolean) : True if the harvester is currently running.
\end_layout

\end_deeper
\begin_layout Itemize

\series bold
error
\series default
 : This element will be present if the harvester encounters an error during
 harvesting.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
code
\series default
 : The error code, in string form
\end_layout

\begin_layout Itemize

\series bold
message
\series default
 : The description of the error.
\end_layout

\begin_layout Itemize

\series bold
object
\series default
 : The object that caused the error (if any).
 This element can be present or not depending on the case.
\end_layout

\end_deeper
\begin_layout Section
xml.harvesting.add
\end_layout

\begin_layout Standard
Create a new harvesting entry.
 The entry can be of any type support by GeoNetwork (GeoNetwork node, web
 folder etc...).
 When a new entry is created, its status is set to 
\family sans
\series bold
inactive
\family default
\series default
.
 A call to the xml.harvesting.start service is required to start harvesting.
\end_layout

\begin_layout Subsection*
Request
\end_layout

\begin_layout Standard
The service requires an XML tree with all information the client wants to
 add.
 
\end_layout

\begin_layout Standard
To create a GeoNetwork entry the following XML information should be provided.
 Default values are given in parenthesis (after the parameter's type) and
 are used when the parameter is omitted.
 If the type is boolean, only the 
\family sans
\series bold
true
\family default
\series default
 and 
\family sans
\series bold
false
\family default
\series default
 strings are allowed.
\end_layout

\begin_layout Itemize

\series bold
node
\series default
 : This is the root container.
 The 
\family sans
\series bold
name
\family default
\series default
 attribute specifies the entry's name.
 If omitted, an empty string is considered.
 The 
\family sans
\series bold
type
\family default
\series default
 attribute is mandatory and must be 
\family sans
\series bold
geonetwork
\family default
\series default
.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
site
\series default
 : A container for site information.
 Can be omitted.
\end_layout

\begin_deeper
\begin_layout Itemize

\series bold
host
\series default
 (
\emph on
string
\emph default
, '') : The GeoNetwork node's host name or IP address.
\end_layout

\begin_layout Itemize

\series bold
port
\series default
 (
\emph on
string